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

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

Resource Profile: 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 of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Task C 0..* Task A task to be performed
Constraints: inv-1, tsk-1, statusreason-conditional-require
... meta Σ 1..1 Meta Metadata about the resource
.... versionId Σ 1..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant Automatically updated on every change
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text S 1..1 Narrative Human-readable narrative
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... Slices for identifier S 1..* Identifier Task instance UUID (required) + official regulator procedure number (optional), other identifiers allowed as well
Slice: Unordered, Open by value:type, value:system
.... identifier:TaskInstance SC 1..1 Identifier Technical UUID for this specific Task instance
Constraints: identifier-is-uuid
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 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: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: RI
....... display 1..1 string Representation defined by the system
Fixed Value: Resource identifier
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
.... identifier:RegulatorProcedureNumber S 0..1 Identifier Official regulator procedure/submission number (EMA, FDA, PMDA, etc.)
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: https://ema.europa.eu/procedure
..... value ΣC 1..1 string The actual regulator-assigned procedure number (format varies by authority)
Example General: 123456
... basedOn SΣ 0..* Reference(Resource) Reference to the parent Task (e.g. a response points to the question Task), ordered lineage of Tasks (oldest → newest).
... groupIdentifier SΣ 1..1 Identifier Parent/Set ID – groups all Tasks in the same regulatory procedure
... status ?!Σ 1..1 code draft | requested | received | accepted | +
Binding: TaskStatus (required): The current status of the task.
... statusReason Σ 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.
... businessStatus Σ 0..1 CodeableConcept Detailed regulatory status (e.g., clock-stop)
Binding: APIX Regulatory Business Status (example): Detailed regulatory status such as clock-stop
... intent Σ 1..1 code unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Binding: TaskIntent (required): Distinguishes whether the task is a proposal, plan or full order.
Required Pattern: proposal
... doNotPerform ?!Σ 0..1 boolean True if Task is prohibiting action
... code SΣ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.
... for SΣ 0..1 Reference(Resource) Identifies the medicinal product(s) that is the subject. For multiple products use Group or List FHIR Resource
... requestedPeriod SΣ 0..1 Period Requested period for task fulfilment
.... start SΣC 0..1 dateTime Clock-start / earliest allowed start
.... end SΣC 0..1 dateTime Deadline / clock-stop date
... executionPeriod SΣ 0..1 Period Actual execution period
.... start SΣC 0..1 dateTime Actual start time
.... end SΣC 0..1 dateTime Actual completion time
... authoredOn C 1..1 dateTime Date/time the sender created the Task
... lastModified ΣC 1..1 dateTime Task Last Modified Date
... requester SΣ 1..1 Reference(APIX Organization) Organization that initiated the task
... owner SΣ 0..1 Reference(APIX Organization) The Organization accountable for fulfilling the Task.
... performer SΣ 0..1 BackboneElement Organization or individual who performed the task
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... actor Σ 1..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Who performed the task
... input S 0..* BackboneElement Input parameters for the task
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type S 1..1 CodeableConcept Input type indicates the type of input, such as the code used as a DocumentReference type
Binding: 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.
.... value[x] 1..1 Content to use in performing the task
..... valueBase64Binary base64Binary
..... valueBoolean boolean
..... valueCanonical canonical(Any)
..... valueCode code
..... valueDate date
..... valueDateTime dateTime
..... valueDecimal decimal
..... valueId id
..... valueInstant instant
..... valueInteger integer
..... valueInteger64 integer64
..... valueMarkdown markdown
..... valueOid oid
..... valuePositiveInt positiveInt
..... valueString string
..... valueTime time
..... valueUnsignedInt unsignedInt
..... valueUri uri
..... valueUrl url
..... valueUuid uuid
..... valueAddress Address
..... valueAge Age
..... valueAnnotation Annotation
..... valueAttachment Attachment
..... valueCodeableConcept CodeableConcept
..... valueCodeableReference CodeableReference
..... valueCoding Coding
..... valueContactPoint ContactPoint
..... valueCount Count
..... valueDistance Distance
..... valueDuration Duration
..... valueHumanName HumanName
..... valueIdentifier Identifier
..... valueMoney Money
..... valuePeriod Period
..... valueQuantity Quantity
..... valueRange Range
..... valueRatio Ratio
..... valueRatioRange RatioRange
..... valueReference Reference(Any)
..... valueSampledData SampledData
..... valueSignature Signature
..... valueTiming Timing
..... valueContactDetail ContactDetail
..... valueDataRequirement DataRequirement
..... valueExpression Expression
..... valueParameterDefinition ParameterDefinition
..... valueRelatedArtifact RelatedArtifact
..... valueTriggerDefinition TriggerDefinition
..... valueUsageContext UsageContext
..... valueAvailability Availability
..... valueExtendedContactDetail ExtendedContactDetail
..... valueDosage Dosage
..... valueMeta Meta
... output S 0..* BackboneElement Output produced by the task
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type S 1..1 CodeableConcept Output type indicates the type of output, such as the code used as a DocumentReference type
Binding: 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.
.... value[x] 1..1 Result of output
..... valueBase64Binary base64Binary
..... valueBoolean boolean
..... valueCanonical canonical(Any)
..... valueCode code
..... valueDate date
..... valueDateTime dateTime
..... valueDecimal decimal
..... valueId id
..... valueInstant instant
..... valueInteger integer
..... valueInteger64 integer64
..... valueMarkdown markdown
..... valueOid oid
..... valuePositiveInt positiveInt
..... valueString string
..... valueTime time
..... valueUnsignedInt unsignedInt
..... valueUri uri
..... valueUrl url
..... valueUuid uuid
..... valueAddress Address
..... valueAge Age
..... valueAnnotation Annotation
..... valueAttachment Attachment
..... valueCodeableConcept CodeableConcept
..... valueCodeableReference CodeableReference
..... valueCoding Coding
..... valueContactPoint ContactPoint
..... valueCount Count
..... valueDistance Distance
..... valueDuration Duration
..... valueHumanName HumanName
..... valueIdentifier Identifier
..... valueMoney Money
..... valuePeriod Period
..... valueQuantity Quantity
..... valueRange Range
..... valueRatio Ratio
..... valueRatioRange RatioRange
..... valueReference Reference(Any)
..... valueSampledData SampledData
..... valueSignature Signature
..... valueTiming Timing
..... valueContactDetail ContactDetail
..... valueDataRequirement DataRequirement
..... valueExpression Expression
..... valueParameterDefinition ParameterDefinition
..... valueRelatedArtifact RelatedArtifact
..... valueTriggerDefinition TriggerDefinition
..... valueUsageContext UsageContext
..... valueAvailability Availability
..... valueExtendedContactDetail ExtendedContactDetail
..... valueDosage Dosage
..... 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.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 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 APIX CTD/eCTD Section Code System 📦0.1.0 This IG
Task.output.type Base example 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: Filtersdoco
.. Task C 0..* Task A task to be performed
Constraints: statusreason-conditional-require
... meta 1..1 Meta Metadata about the resource
.... versionId 1..1 id Version specific identifier
.... lastUpdated 0..1 instant Automatically updated on every change
... text S 1..1 Narrative Human-readable narrative
... Slices for identifier S 1..* Identifier Task instance UUID (required) + official regulator procedure number (optional), other identifiers allowed as well
Slice: Unordered, Open by value:type, value:system
.... identifier:TaskInstance SC 1..1 Identifier Technical UUID for this specific Task instance
Constraints: identifier-is-uuid
..... type 1..1 CodeableConcept Description of identifier
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: RI
....... display 1..1 string Representation defined by the system
Fixed Value: Resource identifier
.... identifier:RegulatorProcedureNumber S 0..1 Identifier Official regulator procedure/submission number (EMA, FDA, PMDA, etc.)
..... system 1..1 uri The namespace for the identifier value
Required Pattern: https://ema.europa.eu/procedure
..... value 1..1 string The actual regulator-assigned procedure number (format varies by authority)
... groupIdentifier S 1..1 Identifier Parent/Set ID – groups all Tasks in the same regulatory procedure
... statusReason 0..1 CodeableReference() Required if status is rejected or cancelled
... businessStatus 0..1 CodeableConcept Detailed regulatory status (e.g., clock-stop)
Binding: APIX Regulatory Business Status (example): Detailed regulatory status such as clock-stop
... intent 1..1 code unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Required Pattern: proposal
... code S 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.
... description 0..0 Human-readable explanation of task
... for S 0..1 Reference(Resource) Identifies the medicinal product(s) that is the subject. For multiple products use Group or List FHIR Resource
... encounter 0..0 Healthcare event during which this task originated
... requestedPeriod S 0..1 Period Requested period for task fulfilment
.... start S 0..1 dateTime Clock-start / earliest allowed start
.... end S 0..1 dateTime Deadline / clock-stop date
... executionPeriod S 0..1 Period Actual execution period
.... start S 0..1 dateTime Actual start time
.... end S 0..1 dateTime Actual completion time
... authoredOn 1..1 dateTime Date/time the sender created the Task
... lastModified 1..1 dateTime Task Last Modified Date
... requester S 1..1 Reference(APIX Organization) Organization that initiated the task
... owner S 0..1 Reference(APIX Organization) The Organization accountable for fulfilling the Task.
... performer S 0..1 BackboneElement Organization or individual who performed the task
... relevantHistory 0..0 Key events in history of the Task
... restriction 0..0 Constraints on fulfillment tasks
... input S 0..* BackboneElement Input parameters for the task
.... type S 1..1 CodeableConcept Input type indicates the type of input, such as the code used as a DocumentReference type
Binding: 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.
... output S 0..* BackboneElement Output produced by the task
.... type S 1..1 CodeableConcept Output type indicates the type of output, such as the code used as a DocumentReference type
Binding: 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 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 APIX CTD/eCTD Section Code System 📦0.1.0 This IG
Task.output.type Base example 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: Filtersdoco
.. Task C 0..* Task A task to be performed
Constraints: inv-1, tsk-1, statusreason-conditional-require
... id Σ 0..1 id Logical id of this artifact
... meta Σ 1..1 Meta Metadata about the resource
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 1..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant Automatically updated on every change
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: AllSecurityLabels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 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".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... text S 1..1 Narrative Human-readable narrative
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... Slices for identifier S 1..* Identifier Task instance UUID (required) + official regulator procedure number (optional), other identifiers allowed as well
Slice: Unordered, Open by value:type, value:system
.... identifier:TaskInstance SC 1..1 Identifier Technical UUID for this specific Task instance
Constraints: identifier-is-uuid
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 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: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: RI
....... display 1..1 string Representation defined by the system
Fixed Value: Resource identifier
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value ΣC 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:RegulatorProcedureNumber S 0..1 Identifier Official regulator procedure/submission number (EMA, FDA, PMDA, etc.)
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..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.
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: https://ema.europa.eu/procedure
..... value ΣC 1..1 string The actual regulator-assigned procedure number (format varies by authority)
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... instantiatesCanonical Σ 0..1 canonical(ActivityDefinition) Formal definition of task
... instantiatesUri Σ 0..1 uri Formal definition of task
... basedOn SΣ 0..* Reference(Resource) Reference to the parent Task (e.g. a response points to the question Task), ordered lineage of Tasks (oldest → newest).
... groupIdentifier SΣ 1..1 Identifier Parent/Set ID – groups all Tasks in the same regulatory procedure
... partOf Σ 0..* Reference(Task) Composite task
... status ?!Σ 1..1 code draft | requested | received | accepted | +
Binding: TaskStatus (required): The current status of the task.
... statusReason Σ 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.
... businessStatus Σ 0..1 CodeableConcept Detailed regulatory status (e.g., clock-stop)
Binding: APIX Regulatory Business Status (example): Detailed regulatory status such as clock-stop
... intent Σ 1..1 code unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Binding: TaskIntent (required): Distinguishes whether the task is a proposal, plan or full order.
Required Pattern: proposal
... priority 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): The priority of a task (may affect service level applied to the task).
... doNotPerform ?!Σ 0..1 boolean True if Task is prohibiting action
... code SΣ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.
... focus ΣC 0..1 Reference(Resource) What task is acting on
... for SΣ 0..1 Reference(Resource) Identifies the medicinal product(s) that is the subject. For multiple products use Group or List FHIR Resource
... requestedPeriod SΣ 0..1 Period Requested period for task fulfilment
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... start SΣC 0..1 dateTime Clock-start / earliest allowed start
.... end SΣC 0..1 dateTime Deadline / clock-stop date
... executionPeriod SΣ 0..1 Period Actual execution period
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... start SΣC 0..1 dateTime Actual start time
.... end SΣC 0..1 dateTime Actual completion time
... authoredOn C 1..1 dateTime Date/time the sender created the Task
... lastModified ΣC 1..1 dateTime Task Last Modified Date
... requester SΣ 1..1 Reference(APIX Organization) Organization that initiated the 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.
... owner SΣ 0..1 Reference(APIX Organization) The Organization accountable for fulfilling the Task.
... performer SΣ 0..1 BackboneElement Organization or individual who performed the task
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... function Σ 0..1 CodeableConcept Type of performance
Binding Description: (example): Codes to identify types of task performers.
.... actor Σ 1..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Who performed the task
... location Σ 0..1 Reference(Location) Where task occurs
... reason 0..* CodeableReference() Why task is needed
Binding Description: (example): Indicates why the task is needed. E.g. Suspended because patient admitted to hospital.
... insurance 0..* Reference(Coverage | ClaimResponse) Associated insurance coverage
... note 0..* Annotation Comments made about the task
... input S 0..* BackboneElement Input parameters for the task
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type S 1..1 CodeableConcept Input type indicates the type of input, such as the code used as a DocumentReference type
Binding: 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.
.... value[x] 1..1 Content to use in performing the task
..... valueBase64Binary base64Binary
..... valueBoolean boolean
..... valueCanonical canonical(Any)
..... valueCode code
..... valueDate date
..... valueDateTime dateTime
..... valueDecimal decimal
..... valueId id
..... valueInstant instant
..... valueInteger integer
..... valueInteger64 integer64
..... valueMarkdown markdown
..... valueOid oid
..... valuePositiveInt positiveInt
..... valueString string
..... valueTime time
..... valueUnsignedInt unsignedInt
..... valueUri uri
..... valueUrl url
..... valueUuid uuid
..... valueAddress Address
..... valueAge Age
..... valueAnnotation Annotation
..... valueAttachment Attachment
..... valueCodeableConcept CodeableConcept
..... valueCodeableReference CodeableReference
..... valueCoding Coding
..... valueContactPoint ContactPoint
..... valueCount Count
..... valueDistance Distance
..... valueDuration Duration
..... valueHumanName HumanName
..... valueIdentifier Identifier
..... valueMoney Money
..... valuePeriod Period
..... valueQuantity Quantity
..... valueRange Range
..... valueRatio Ratio
..... valueRatioRange RatioRange
..... valueReference Reference(Any)
..... valueSampledData SampledData
..... valueSignature Signature
..... valueTiming Timing
..... valueContactDetail ContactDetail
..... valueDataRequirement DataRequirement
..... valueExpression Expression
..... valueParameterDefinition ParameterDefinition
..... valueRelatedArtifact RelatedArtifact
..... valueTriggerDefinition TriggerDefinition
..... valueUsageContext UsageContext
..... valueAvailability Availability
..... valueExtendedContactDetail ExtendedContactDetail
..... valueDosage Dosage
..... valueMeta Meta
... output S 0..* BackboneElement Output produced by the task
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type S 1..1 CodeableConcept Output type indicates the type of output, such as the code used as a DocumentReference type
Binding: 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.
.... value[x] 1..1 Result of output
..... valueBase64Binary base64Binary
..... valueBoolean boolean
..... valueCanonical canonical(Any)
..... valueCode code
..... valueDate date
..... valueDateTime dateTime
..... valueDecimal decimal
..... valueId id
..... valueInstant instant
..... valueInteger integer
..... valueInteger64 integer64
..... valueMarkdown markdown
..... valueOid oid
..... valuePositiveInt positiveInt
..... valueString string
..... valueTime time
..... valueUnsignedInt unsignedInt
..... valueUri uri
..... valueUrl url
..... valueUuid uuid
..... valueAddress Address
..... valueAge Age
..... valueAnnotation Annotation
..... valueAttachment Attachment
..... valueCodeableConcept CodeableConcept
..... valueCodeableReference CodeableReference
..... valueCoding Coding
..... valueContactPoint ContactPoint
..... valueCount Count
..... valueDistance Distance
..... valueDuration Duration
..... valueHumanName HumanName
..... valueIdentifier Identifier
..... valueMoney Money
..... valuePeriod Period
..... valueQuantity Quantity
..... valueRange Range
..... valueRatio Ratio
..... valueRatioRange RatioRange
..... valueReference Reference(Any)
..... valueSampledData SampledData
..... valueSignature Signature
..... valueTiming Timing
..... valueContactDetail ContactDetail
..... valueDataRequirement DataRequirement
..... valueExpression Expression
..... valueParameterDefinition ParameterDefinition
..... valueRelatedArtifact RelatedArtifact
..... valueTriggerDefinition TriggerDefinition
..... valueUsageContext UsageContext
..... valueAvailability Availability
..... valueExtendedContactDetail ExtendedContactDetail
..... valueDosage Dosage
..... 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 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 APIX CTD/eCTD Section Code System 📦0.1.0 This IG
Task.output.type Base example 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: 11 elements(2 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 2 is sliced based on the values of Task.identifier

Maturity: 1

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Task C 0..* Task A task to be performed
Constraints: inv-1, tsk-1, statusreason-conditional-require
... meta Σ 1..1 Meta Metadata about the resource
.... versionId Σ 1..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant Automatically updated on every change
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text S 1..1 Narrative Human-readable narrative
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... Slices for identifier S 1..* Identifier Task instance UUID (required) + official regulator procedure number (optional), other identifiers allowed as well
Slice: Unordered, Open by value:type, value:system
.... identifier:TaskInstance SC 1..1 Identifier Technical UUID for this specific Task instance
Constraints: identifier-is-uuid
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 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: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: RI
....... display 1..1 string Representation defined by the system
Fixed Value: Resource identifier
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
.... identifier:RegulatorProcedureNumber S 0..1 Identifier Official regulator procedure/submission number (EMA, FDA, PMDA, etc.)
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: https://ema.europa.eu/procedure
..... value ΣC 1..1 string The actual regulator-assigned procedure number (format varies by authority)
Example General: 123456
... basedOn SΣ 0..* Reference(Resource) Reference to the parent Task (e.g. a response points to the question Task), ordered lineage of Tasks (oldest → newest).
... groupIdentifier SΣ 1..1 Identifier Parent/Set ID – groups all Tasks in the same regulatory procedure
... status ?!Σ 1..1 code draft | requested | received | accepted | +
Binding: TaskStatus (required): The current status of the task.
... statusReason Σ 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.
... businessStatus Σ 0..1 CodeableConcept Detailed regulatory status (e.g., clock-stop)
Binding: APIX Regulatory Business Status (example): Detailed regulatory status such as clock-stop
... intent Σ 1..1 code unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Binding: TaskIntent (required): Distinguishes whether the task is a proposal, plan or full order.
Required Pattern: proposal
... doNotPerform ?!Σ 0..1 boolean True if Task is prohibiting action
... code SΣ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.
... for SΣ 0..1 Reference(Resource) Identifies the medicinal product(s) that is the subject. For multiple products use Group or List FHIR Resource
... requestedPeriod SΣ 0..1 Period Requested period for task fulfilment
.... start SΣC 0..1 dateTime Clock-start / earliest allowed start
.... end SΣC 0..1 dateTime Deadline / clock-stop date
... executionPeriod SΣ 0..1 Period Actual execution period
.... start SΣC 0..1 dateTime Actual start time
.... end SΣC 0..1 dateTime Actual completion time
... authoredOn C 1..1 dateTime Date/time the sender created the Task
... lastModified ΣC 1..1 dateTime Task Last Modified Date
... requester SΣ 1..1 Reference(APIX Organization) Organization that initiated the task
... owner SΣ 0..1 Reference(APIX Organization) The Organization accountable for fulfilling the Task.
... performer SΣ 0..1 BackboneElement Organization or individual who performed the task
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... actor Σ 1..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Who performed the task
... input S 0..* BackboneElement Input parameters for the task
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type S 1..1 CodeableConcept Input type indicates the type of input, such as the code used as a DocumentReference type
Binding: 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.
.... value[x] 1..1 Content to use in performing the task
..... valueBase64Binary base64Binary
..... valueBoolean boolean
..... valueCanonical canonical(Any)
..... valueCode code
..... valueDate date
..... valueDateTime dateTime
..... valueDecimal decimal
..... valueId id
..... valueInstant instant
..... valueInteger integer
..... valueInteger64 integer64
..... valueMarkdown markdown
..... valueOid oid
..... valuePositiveInt positiveInt
..... valueString string
..... valueTime time
..... valueUnsignedInt unsignedInt
..... valueUri uri
..... valueUrl url
..... valueUuid uuid
..... valueAddress Address
..... valueAge Age
..... valueAnnotation Annotation
..... valueAttachment Attachment
..... valueCodeableConcept CodeableConcept
..... valueCodeableReference CodeableReference
..... valueCoding Coding
..... valueContactPoint ContactPoint
..... valueCount Count
..... valueDistance Distance
..... valueDuration Duration
..... valueHumanName HumanName
..... valueIdentifier Identifier
..... valueMoney Money
..... valuePeriod Period
..... valueQuantity Quantity
..... valueRange Range
..... valueRatio Ratio
..... valueRatioRange RatioRange
..... valueReference Reference(Any)
..... valueSampledData SampledData
..... valueSignature Signature
..... valueTiming Timing
..... valueContactDetail ContactDetail
..... valueDataRequirement DataRequirement
..... valueExpression Expression
..... valueParameterDefinition ParameterDefinition
..... valueRelatedArtifact RelatedArtifact
..... valueTriggerDefinition TriggerDefinition
..... valueUsageContext UsageContext
..... valueAvailability Availability
..... valueExtendedContactDetail ExtendedContactDetail
..... valueDosage Dosage
..... valueMeta Meta
... output S 0..* BackboneElement Output produced by the task
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type S 1..1 CodeableConcept Output type indicates the type of output, such as the code used as a DocumentReference type
Binding: 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.
.... value[x] 1..1 Result of output
..... valueBase64Binary base64Binary
..... valueBoolean boolean
..... valueCanonical canonical(Any)
..... valueCode code
..... valueDate date
..... valueDateTime dateTime
..... valueDecimal decimal
..... valueId id
..... valueInstant instant
..... valueInteger integer
..... valueInteger64 integer64
..... valueMarkdown markdown
..... valueOid oid
..... valuePositiveInt positiveInt
..... valueString string
..... valueTime time
..... valueUnsignedInt unsignedInt
..... valueUri uri
..... valueUrl url
..... valueUuid uuid
..... valueAddress Address
..... valueAge Age
..... valueAnnotation Annotation
..... valueAttachment Attachment
..... valueCodeableConcept CodeableConcept
..... valueCodeableReference CodeableReference
..... valueCoding Coding
..... valueContactPoint ContactPoint
..... valueCount Count
..... valueDistance Distance
..... valueDuration Duration
..... valueHumanName HumanName
..... valueIdentifier Identifier
..... valueMoney Money
..... valuePeriod Period
..... valueQuantity Quantity
..... valueRange Range
..... valueRatio Ratio
..... valueRatioRange RatioRange
..... valueReference Reference(Any)
..... valueSampledData SampledData
..... valueSignature Signature
..... valueTiming Timing
..... valueContactDetail ContactDetail
..... valueDataRequirement DataRequirement
..... valueExpression Expression
..... valueParameterDefinition ParameterDefinition
..... valueRelatedArtifact RelatedArtifact
..... valueTriggerDefinition TriggerDefinition
..... valueUsageContext UsageContext
..... valueAvailability Availability
..... valueExtendedContactDetail ExtendedContactDetail
..... valueDosage Dosage
..... 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.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 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 APIX CTD/eCTD Section Code System 📦0.1.0 This IG
Task.output.type Base example 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: Filtersdoco
.. Task C 0..* Task A task to be performed
Constraints: statusreason-conditional-require
... meta 1..1 Meta Metadata about the resource
.... versionId 1..1 id Version specific identifier
.... lastUpdated 0..1 instant Automatically updated on every change
... text S 1..1 Narrative Human-readable narrative
... Slices for identifier S 1..* Identifier Task instance UUID (required) + official regulator procedure number (optional), other identifiers allowed as well
Slice: Unordered, Open by value:type, value:system
.... identifier:TaskInstance SC 1..1 Identifier Technical UUID for this specific Task instance
Constraints: identifier-is-uuid
..... type 1..1 CodeableConcept Description of identifier
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: RI
....... display 1..1 string Representation defined by the system
Fixed Value: Resource identifier
.... identifier:RegulatorProcedureNumber S 0..1 Identifier Official regulator procedure/submission number (EMA, FDA, PMDA, etc.)
..... system 1..1 uri The namespace for the identifier value
Required Pattern: https://ema.europa.eu/procedure
..... value 1..1 string The actual regulator-assigned procedure number (format varies by authority)
... groupIdentifier S 1..1 Identifier Parent/Set ID – groups all Tasks in the same regulatory procedure
... statusReason 0..1 CodeableReference() Required if status is rejected or cancelled
... businessStatus 0..1 CodeableConcept Detailed regulatory status (e.g., clock-stop)
Binding: APIX Regulatory Business Status (example): Detailed regulatory status such as clock-stop
... intent 1..1 code unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Required Pattern: proposal
... code S 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.
... description 0..0 Human-readable explanation of task
... for S 0..1 Reference(Resource) Identifies the medicinal product(s) that is the subject. For multiple products use Group or List FHIR Resource
... encounter 0..0 Healthcare event during which this task originated
... requestedPeriod S 0..1 Period Requested period for task fulfilment
.... start S 0..1 dateTime Clock-start / earliest allowed start
.... end S 0..1 dateTime Deadline / clock-stop date
... executionPeriod S 0..1 Period Actual execution period
.... start S 0..1 dateTime Actual start time
.... end S 0..1 dateTime Actual completion time
... authoredOn 1..1 dateTime Date/time the sender created the Task
... lastModified 1..1 dateTime Task Last Modified Date
... requester S 1..1 Reference(APIX Organization) Organization that initiated the task
... owner S 0..1 Reference(APIX Organization) The Organization accountable for fulfilling the Task.
... performer S 0..1 BackboneElement Organization or individual who performed the task
... relevantHistory 0..0 Key events in history of the Task
... restriction 0..0 Constraints on fulfillment tasks
... input S 0..* BackboneElement Input parameters for the task
.... type S 1..1 CodeableConcept Input type indicates the type of input, such as the code used as a DocumentReference type
Binding: 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.
... output S 0..* BackboneElement Output produced by the task
.... type S 1..1 CodeableConcept Output type indicates the type of output, such as the code used as a DocumentReference type
Binding: 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 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 APIX CTD/eCTD Section Code System 📦0.1.0 This IG
Task.output.type Base example 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 View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Task C 0..* Task A task to be performed
Constraints: inv-1, tsk-1, statusreason-conditional-require
... id Σ 0..1 id Logical id of this artifact
... meta Σ 1..1 Meta Metadata about the resource
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 1..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant Automatically updated on every change
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: AllSecurityLabels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 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".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... text S 1..1 Narrative Human-readable narrative
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... Slices for identifier S 1..* Identifier Task instance UUID (required) + official regulator procedure number (optional), other identifiers allowed as well
Slice: Unordered, Open by value:type, value:system
.... identifier:TaskInstance SC 1..1 Identifier Technical UUID for this specific Task instance
Constraints: identifier-is-uuid
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 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: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: RI
....... display 1..1 string Representation defined by the system
Fixed Value: Resource identifier
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value ΣC 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:RegulatorProcedureNumber S 0..1 Identifier Official regulator procedure/submission number (EMA, FDA, PMDA, etc.)
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..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.
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: https://ema.europa.eu/procedure
..... value ΣC 1..1 string The actual regulator-assigned procedure number (format varies by authority)
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... instantiatesCanonical Σ 0..1 canonical(ActivityDefinition) Formal definition of task
... instantiatesUri Σ 0..1 uri Formal definition of task
... basedOn SΣ 0..* Reference(Resource) Reference to the parent Task (e.g. a response points to the question Task), ordered lineage of Tasks (oldest → newest).
... groupIdentifier SΣ 1..1 Identifier Parent/Set ID – groups all Tasks in the same regulatory procedure
... partOf Σ 0..* Reference(Task) Composite task
... status ?!Σ 1..1 code draft | requested | received | accepted | +
Binding: TaskStatus (required): The current status of the task.
... statusReason Σ 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.
... businessStatus Σ 0..1 CodeableConcept Detailed regulatory status (e.g., clock-stop)
Binding: APIX Regulatory Business Status (example): Detailed regulatory status such as clock-stop
... intent Σ 1..1 code unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Binding: TaskIntent (required): Distinguishes whether the task is a proposal, plan or full order.
Required Pattern: proposal
... priority 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): The priority of a task (may affect service level applied to the task).
... doNotPerform ?!Σ 0..1 boolean True if Task is prohibiting action
... code SΣ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.
... focus ΣC 0..1 Reference(Resource) What task is acting on
... for SΣ 0..1 Reference(Resource) Identifies the medicinal product(s) that is the subject. For multiple products use Group or List FHIR Resource
... requestedPeriod SΣ 0..1 Period Requested period for task fulfilment
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... start SΣC 0..1 dateTime Clock-start / earliest allowed start
.... end SΣC 0..1 dateTime Deadline / clock-stop date
... executionPeriod SΣ 0..1 Period Actual execution period
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... start SΣC 0..1 dateTime Actual start time
.... end SΣC 0..1 dateTime Actual completion time
... authoredOn C 1..1 dateTime Date/time the sender created the Task
... lastModified ΣC 1..1 dateTime Task Last Modified Date
... requester SΣ 1..1 Reference(APIX Organization) Organization that initiated the 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.
... owner SΣ 0..1 Reference(APIX Organization) The Organization accountable for fulfilling the Task.
... performer SΣ 0..1 BackboneElement Organization or individual who performed the task
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... function Σ 0..1 CodeableConcept Type of performance
Binding Description: (example): Codes to identify types of task performers.
.... actor Σ 1..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) Who performed the task
... location Σ 0..1 Reference(Location) Where task occurs
... reason 0..* CodeableReference() Why task is needed
Binding Description: (example): Indicates why the task is needed. E.g. Suspended because patient admitted to hospital.
... insurance 0..* Reference(Coverage | ClaimResponse) Associated insurance coverage
... note 0..* Annotation Comments made about the task
... input S 0..* BackboneElement Input parameters for the task
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type S 1..1 CodeableConcept Input type indicates the type of input, such as the code used as a DocumentReference type
Binding: 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.
.... value[x] 1..1 Content to use in performing the task
..... valueBase64Binary base64Binary
..... valueBoolean boolean
..... valueCanonical canonical(Any)
..... valueCode code
..... valueDate date
..... valueDateTime dateTime
..... valueDecimal decimal
..... valueId id
..... valueInstant instant
..... valueInteger integer
..... valueInteger64 integer64
..... valueMarkdown markdown
..... valueOid oid
..... valuePositiveInt positiveInt
..... valueString string
..... valueTime time
..... valueUnsignedInt unsignedInt
..... valueUri uri
..... valueUrl url
..... valueUuid uuid
..... valueAddress Address
..... valueAge Age
..... valueAnnotation Annotation
..... valueAttachment Attachment
..... valueCodeableConcept CodeableConcept
..... valueCodeableReference CodeableReference
..... valueCoding Coding
..... valueContactPoint ContactPoint
..... valueCount Count
..... valueDistance Distance
..... valueDuration Duration
..... valueHumanName HumanName
..... valueIdentifier Identifier
..... valueMoney Money
..... valuePeriod Period
..... valueQuantity Quantity
..... valueRange Range
..... valueRatio Ratio
..... valueRatioRange RatioRange
..... valueReference Reference(Any)
..... valueSampledData SampledData
..... valueSignature Signature
..... valueTiming Timing
..... valueContactDetail ContactDetail
..... valueDataRequirement DataRequirement
..... valueExpression Expression
..... valueParameterDefinition ParameterDefinition
..... valueRelatedArtifact RelatedArtifact
..... valueTriggerDefinition TriggerDefinition
..... valueUsageContext UsageContext
..... valueAvailability Availability
..... valueExtendedContactDetail ExtendedContactDetail
..... valueDosage Dosage
..... valueMeta Meta
... output S 0..* BackboneElement Output produced by the task
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type S 1..1 CodeableConcept Output type indicates the type of output, such as the code used as a DocumentReference type
Binding: 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.
.... value[x] 1..1 Result of output
..... valueBase64Binary base64Binary
..... valueBoolean boolean
..... valueCanonical canonical(Any)
..... valueCode code
..... valueDate date
..... valueDateTime dateTime
..... valueDecimal decimal
..... valueId id
..... valueInstant instant
..... valueInteger integer
..... valueInteger64 integer64
..... valueMarkdown markdown
..... valueOid oid
..... valuePositiveInt positiveInt
..... valueString string
..... valueTime time
..... valueUnsignedInt unsignedInt
..... valueUri uri
..... valueUrl url
..... valueUuid uuid
..... valueAddress Address
..... valueAge Age
..... valueAnnotation Annotation
..... valueAttachment Attachment
..... valueCodeableConcept CodeableConcept
..... valueCodeableReference CodeableReference
..... valueCoding Coding
..... valueContactPoint ContactPoint
..... valueCount Count
..... valueDistance Distance
..... valueDuration Duration
..... valueHumanName HumanName
..... valueIdentifier Identifier
..... valueMoney Money
..... valuePeriod Period
..... valueQuantity Quantity
..... valueRange Range
..... valueRatio Ratio
..... valueRatioRange RatioRange
..... valueReference Reference(Any)
..... valueSampledData SampledData
..... valueSignature Signature
..... valueTiming Timing
..... valueContactDetail ContactDetail
..... valueDataRequirement DataRequirement
..... valueExpression Expression
..... valueParameterDefinition ParameterDefinition
..... valueRelatedArtifact RelatedArtifact
..... valueTriggerDefinition TriggerDefinition
..... valueUsageContext UsageContext
..... valueAvailability Availability
..... valueExtendedContactDetail ExtendedContactDetail
..... valueDosage Dosage
..... 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 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 APIX CTD/eCTD Section Code System 📦0.1.0 This IG
Task.output.type Base example 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: 11 elements(2 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 2 is sliced based on the values of Task.identifier

Maturity: 1

 

Other representations of profile: CSV, Excel, Schematron