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

API for the Exchange of Medicinal Product Information (APIX), published by Gravitate Health Project. 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
Draft as of 2025-12-13 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
... meta Σ 1..1 Meta Metadata about the resource
.... versionId Σ 1..1 id Version specific identifier
.... lastUpdated Σ 1..1 instant When the resource version last changed
.... profile Σ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to

Fixed Value: http://hl7.org/fhir/uv/apix/StructureDefinition/apix-task
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text S 1..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
.... contained:documentReference S 0..* APIXDocumentReference Embedded or Referenced Regulatory Document
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... Slices for identifier 1..2 Identifier Task instance UUID (required) + official regulator procedure number (optional)
Slice: Unordered, Closed by value:type.coding.code
.... identifier:TaskInstance S 1..1 Identifier Technical UUID for this specific Task instance
..... 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
...... 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 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... system Σ 0..1 uri The namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986
..... value ΣC 1..1 string The value that is unique
Required Pattern: urn:uuid:
.... 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 .
..... 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
...... 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: RN
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: https://ema.europa.eu/procedure|https://fda.gov/ind|https://pmda.go.jp/application-number
..... value ΣC 1..1 string The actual regulator-assigned procedure number (format varies by authority)
Example General: 123456
... 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)
... businessStatus Σ 0..1 CodeableConcept Detailed regulatory status (e.g., clock-stop)
Binding: APIX Regulatory Business Status (required)
... intent Σ 1..1 code unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required)
Fixed Value: proposal
... priority S 1..1 code routine | urgent | asap | stat
Binding: RequestPriority (required)
... doNotPerform ?!Σ 0..1 boolean True if Task is prohibiting action
... code ΣC 1..1 CodeableConcept ​Task Type
Binding: http://hl7.org/fhir/uv/apix/ValueSet/apix-submission-type-vs (extensible)
... for SΣ 0..1 Reference(Resource) Beneficiary of the Task
... 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
... authoredOn C 1..1 dateTime Task Creation Date
... lastModified ΣC 1..1 dateTime Task Last Modified Date
... requester SΣ 1..1 Reference() Requesting organization
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
... requestedPerformer S 1..1 CodeableReference(Organization) Requesting performer organization
Binding: ProcedurePerformerRoleCodes (preferred): The type(s) of task performers allowed.
... Slices for input S 0..* BackboneElement Input parameters for the task
Slice: Unordered, Open by pattern:type.coding
.... input:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 CodeableConcept Label for the input
Binding Description: (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
.... input:regulatoryDocument S 0..* BackboneElement Regulatory document (CTD section, via DocumentReference index)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 CodeableConcept Label for the input
Binding Description: (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.
Fixed Value: As shown
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..0 Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/uv/apix/CodeSystem/apix-task-input-type
...... version 0..0 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: regulatory-document
...... display 1..1 string Representation defined by the system
Fixed Value: Regulatory Document
...... userSelected 0..0 boolean If this coding was chosen directly by the user
..... value[x] S 1..1 Reference() Content to use in performing the task
... Slices for output S 0..* BackboneElement Output produced by the task
Slice: Unordered, Open by pattern:type.coding
.... output:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 CodeableConcept Label for output
Binding Description: (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
.... output:regulatoryDocument S 0..* BackboneElement Regulatory document produced as output (via DocumentReference index)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 CodeableConcept Label for output
Binding Description: (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.
Fixed Value: As shown
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..0 Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/uv/apix/CodeSystem/apix-task-output-type
...... version 0..0 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: regulatory-document
...... display 1..1 string Representation defined by the system
Fixed Value: Regulatory Document
...... userSelected 0..0 boolean If this coding was chosen directly by the user
..... value[x] S 1..1 Reference() Result of output

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.businessStatus Base required APIX Regulatory Business Status 📦0.1.0 This IG
Task.intent Base required RequestIntent 📍5.0.0 FHIR Std.
Task.priority Base required RequestPriority 📍5.0.0 FHIR Std.
Task.code Base extensible ​ http://hl7.org/fhir/uv/apix/ValueSet/apix-submission-type-vs Not State Unknown
Task.requestedPerformer Base preferred Procedure Performer Role Codes 📍5.0.0 FHIR Std.
Task.input.type Base example Not State Unknown
Task.input:regulatoryDocument.​type Base example Not State Unknown
Task.output.type Base example Not State Unknown
Task.output:regulatoryDocument.​type Base example Not State Unknown

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()
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
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 0..* Task A task to be performed
... meta 1..1 Meta Metadata about the resource
.... versionId 1..1 id Version specific identifier
.... lastUpdated 1..1 instant When the resource version last changed
.... profile 1..* canonical(StructureDefinition) Profiles this resource claims to conform to
Fixed Value: http://hl7.org/fhir/uv/apix/StructureDefinition/apix-task
... text S 1..1 Narrative Text summary of the resource, for human interpretation
... Slices for contained S 0..* Resource Contained, inline Resources
Slice: Unordered, Open by profile:$this
.... contained:documentReference S 0..* APIXDocumentReference Embedded or Referenced Regulatory Document
.... identifier:TaskInstance S 1..1 Identifier Technical UUID for this specific Task instance
..... type 1..1 CodeableConcept Description of identifier
Required Pattern: At least the following
...... 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
..... system 0..1 uri The namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986
..... value 1..1 string The value that is unique
Required Pattern: urn:uuid:
.... identifier:RegulatorProcedureNumber S 0..1 Identifier Official regulator procedure/submission number (EMA, FDA, PMDA, etc.)
..... type 1..1 CodeableConcept Description of identifier
Required Pattern: At least the following
...... 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: RN
..... system 1..1 uri The namespace for the identifier value
Required Pattern: https://ema.europa.eu/procedure|https://fda.gov/ind|https://pmda.go.jp/application-number
..... 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
... status 1..1 code draft | requested | received | accepted | +
Binding: TaskStatus (required)
... businessStatus 0..1 CodeableConcept Detailed regulatory status (e.g., clock-stop)
Binding: APIX Regulatory Business Status (required)
... intent 1..1 code unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required)
Fixed Value: proposal
... priority S 1..1 code routine | urgent | asap | stat
Binding: RequestPriority (required)
... code 1..1 CodeableConcept ​Task Type
Binding: http://hl7.org/fhir/uv/apix/ValueSet/apix-submission-type-vs (extensible)
... description 0..0 Human-readable explanation of task
... focus 0..0 What task is acting on
... for S 0..1 Reference(Resource) Beneficiary of the Task
... 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 0..0 Start and end time of execution
... authoredOn 1..1 dateTime Task Creation Date
... lastModified 1..1 dateTime Task Last Modified Date
... requester S 1..1 Reference() Requesting organization
​.... contained S Organization Contained requesting organization
​..... name S 1..1 Organization name
​..... identifier S 1..* Organization identifier(s)
​..... address S 1..1 Organization address
​...... text S Full formatted address
​...... line S Street address line(s)
​...... city S City
​...... district S District/sub-division
​...... state S State / Province / Prefecture
​...... postalCode S Postal code
​...... country S Country (ISO 3166-1 alpha-2)
Binding: Iso316612 (required)
​..... contact
​...... Slices for telecom S 1..1 Organization contact points (email and phone)
Slice: Unordered, Open by value:system
​....... telecom:email S 1..1 Email address
​........ system 1..1 Fixed Value: email
​........ value S 1..1
​....... telecom:phone S 0..1 Phone number
​........ system 1..1 Fixed Value: phone
​........ value S 1..1
... requestedPerformer S 1..1 CodeableReference(Organization) Requesting performer organization
​.... contained S Organization Contained requesting performer organization
​..... name S 1..1 Organization name
​..... identifier S 1..* Organization identifier(s)
​..... address S 1..1 Organization address
​...... text S Full formatted address
​...... line S Street address line(s)
​...... city S City
​...... district S District/sub-division
​...... state S State / Province / Prefecture
​...... postalCode S Postal code
​...... country S Country (ISO 3166-1 alpha-2)
Binding: Iso316612 (required)
​..... contact
​...... Slices for telecom S 1..1 Organization contact points (email and phone)
Slice: Unordered, Open by value:system
​....... telecom:email S 1..1 Email address
​........ system 1..1 Fixed Value: email
​........ value S 1..1
​....... telecom:phone S 0..1 Phone number
​........ system 1..1 Fixed Value: phone
​........ value S 1..1
... owner 0..0 Responsible individual
... relevantHistory 0..0 Key events in history of the Task
... restriction 0..0 Constraints on fulfillment tasks
... Slices for input S 0..* BackboneElement Input parameters for the task
Slice: Unordered, Open by pattern:type.coding
.... input:regulatoryDocument S 0..* BackboneElement Regulatory document (CTD section, via DocumentReference index)
..... type 1..1 CodeableConcept Label for the input
Fixed Value: As shown
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/uv/apix/CodeSystem/apix-task-input-type
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: regulatory-document
...... display 1..1 string Representation defined by the system
Fixed Value: Regulatory Document
..... value[x] S 1..1 Reference() Content to use in performing the task
... Slices for output S 0..* BackboneElement Output produced by the task
Slice: Unordered, Open by pattern:type.coding
.... output:regulatoryDocument S 0..* BackboneElement Regulatory document produced as output (via DocumentReference index)
..... type 1..1 CodeableConcept Label for output
Fixed Value: As shown
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/uv/apix/CodeSystem/apix-task-output-type
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: regulatory-document
...... display 1..1 string Representation defined by the system
Fixed Value: Regulatory Document
..... value[x] S 1..1 Reference() Result of output

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Task.status Base required Task Status 📍5.0.0 FHIR Std.
Task.businessStatus Base required APIX Regulatory Business Status 📦0.1.0 This IG
Task.intent Base required RequestIntent 📍5.0.0 FHIR Std.
Task.priority Base required RequestPriority 📍5.0.0 FHIR Std.
Task.code Base extensible ​ http://hl7.org/fhir/uv/apix/ValueSet/apix-submission-type-vs Not State Unknown
Task.requester.contained.​address.country Base required Iso 3166 Part 1: 2 Letter Codes 📦5.0.0 FHIR Std.
Task.requestedPerformer.​contained.address.country Base required Iso 3166 Part 1: 2 Letter Codes 📦5.0.0 FHIR Std.
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Task C 0..* Task A task to be performed
Constraints: inv-1, tsk-1
... 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 Σ 1..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to

Fixed Value: http://hl7.org/fhir/uv/apix/StructureDefinition/apix-task
.... 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 Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... Slices for contained S 0..* Resource Contained, inline Resources
Slice: Unordered, Open by profile:$this
.... contained:documentReference S 0..* APIXDocumentReference Embedded or Referenced Regulatory Document
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... Slices for identifier 1..2 Identifier Task instance UUID (required) + official regulator procedure number (optional)
Slice: Unordered, Closed by value:type.coding.code
.... identifier:TaskInstance S 1..1 Identifier Technical UUID for this specific Task instance
..... 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
...... 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 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... system Σ 0..1 uri The namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986
..... value ΣC 1..1 string The value that is unique
Required Pattern: urn:uuid:
..... 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 Σ 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
...... 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: RN
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: https://ema.europa.eu/procedure|https://fda.gov/ind|https://pmda.go.jp/application-number
..... 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 Σ 0..* Reference(Resource) Request fulfilled by this task
... 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)
... statusReason Σ 0..1 CodeableReference() Reason for current status
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 (required)
... intent Σ 1..1 code unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required)
Fixed Value: proposal
... priority S 1..1 code routine | urgent | asap | stat
Binding: RequestPriority (required)
... doNotPerform ?!Σ 0..1 boolean True if Task is prohibiting action
... code ΣC 1..1 CodeableConcept ​Task Type
Binding: http://hl7.org/fhir/uv/apix/ValueSet/apix-submission-type-vs (extensible)
... for SΣ 0..1 Reference(Resource) Beneficiary of the Task
... 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
... authoredOn C 1..1 dateTime Task Creation Date
... lastModified ΣC 1..1 dateTime Task Last Modified Date
... requester SΣ 1..1 Reference() Requesting organization
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
.... display ΣC 0..1 string Text alternative for the resource
... requestedPerformer S 1..1 CodeableReference(Organization) Requesting performer organization
Binding: ProcedurePerformerRoleCodes (preferred): The type(s) of task performers allowed.
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... concept Σ 0..1 CodeableConcept Reference to a concept (by class)
.... reference Σ 0..1 Reference() Reference to a resource (by instance)
... performer Σ 0..* BackboneElement Who or what 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
... Slices for input S 0..* BackboneElement Input parameters for the task
Slice: Unordered, Open by pattern:type.coding
.... input:All Slices Content/Rules for all slices
..... 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 1..1 CodeableConcept Label for the input
Binding Description: (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
.... input:regulatoryDocument S 0..* BackboneElement Regulatory document (CTD section, via DocumentReference index)
..... 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 1..1 CodeableConcept Label for the input
Binding Description: (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.
Fixed Value: As shown
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..0 Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/uv/apix/CodeSystem/apix-task-input-type
...... version 0..0 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: regulatory-document
...... display 1..1 string Representation defined by the system
Fixed Value: Regulatory Document
...... userSelected 0..0 boolean If this coding was chosen directly by the user
..... value[x] S 1..1 Reference() Content to use in performing the task
... Slices for output S 0..* BackboneElement Output produced by the task
Slice: Unordered, Open by pattern:type.coding
.... output:All Slices Content/Rules for all slices
..... 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 1..1 CodeableConcept Label for output
Binding Description: (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
.... output:regulatoryDocument S 0..* BackboneElement Regulatory document produced as output (via DocumentReference index)
..... 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 1..1 CodeableConcept Label for output
Binding Description: (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.
Fixed Value: As shown
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..0 Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/uv/apix/CodeSystem/apix-task-output-type
...... version 0..0 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: regulatory-document
...... display 1..1 string Representation defined by the system
Fixed Value: Regulatory Document
...... userSelected 0..0 boolean If this coding was chosen directly by the user
..... value[x] S 1..1 Reference() Result of output

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 required APIX Regulatory Business Status 📦0.1.0 This IG
Task.intent Base required RequestIntent 📍5.0.0 FHIR Std.
Task.priority Base required RequestPriority 📍5.0.0 FHIR Std.
Task.code Base extensible ​ http://hl7.org/fhir/uv/apix/ValueSet/apix-submission-type-vs Not State Unknown
Task.requester.type Base extensible Resource Types 📍5.0.0 FHIR Std.
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 Not State Unknown
Task.input:regulatoryDocument.​type Base example Not State Unknown
Task.output.type Base example Not State Unknown
Task.output:regulatoryDocument.​type Base example Not State Unknown

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()
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
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: 18 elements(25 nested mandatory elements)
Must-Support: 51 elements
Fixed: 9 elements
Prohibited: 7 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.contained
  • The element 1 is sliced based on the value of Task.identifier (Closed)
  • The element 1 is sliced based on the value of Task.requester.contained.contact.telecom
  • The element 1 is sliced based on the value of Task.requestedPerformer.contained.contact.telecom
  • The element 1 is sliced based on the value of Task.input
  • The element 1 is sliced based on the value of Task.output

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Task C 0..* Task A task to be performed
Constraints: inv-1, tsk-1
... meta Σ 1..1 Meta Metadata about the resource
.... versionId Σ 1..1 id Version specific identifier
.... lastUpdated Σ 1..1 instant When the resource version last changed
.... profile Σ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to

Fixed Value: http://hl7.org/fhir/uv/apix/StructureDefinition/apix-task
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text S 1..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
.... contained:documentReference S 0..* APIXDocumentReference Embedded or Referenced Regulatory Document
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... Slices for identifier 1..2 Identifier Task instance UUID (required) + official regulator procedure number (optional)
Slice: Unordered, Closed by value:type.coding.code
.... identifier:TaskInstance S 1..1 Identifier Technical UUID for this specific Task instance
..... 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
...... 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 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... system Σ 0..1 uri The namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986
..... value ΣC 1..1 string The value that is unique
Required Pattern: urn:uuid:
.... 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 .
..... 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
...... 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: RN
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: https://ema.europa.eu/procedure|https://fda.gov/ind|https://pmda.go.jp/application-number
..... value ΣC 1..1 string The actual regulator-assigned procedure number (format varies by authority)
Example General: 123456
... 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)
... businessStatus Σ 0..1 CodeableConcept Detailed regulatory status (e.g., clock-stop)
Binding: APIX Regulatory Business Status (required)
... intent Σ 1..1 code unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required)
Fixed Value: proposal
... priority S 1..1 code routine | urgent | asap | stat
Binding: RequestPriority (required)
... doNotPerform ?!Σ 0..1 boolean True if Task is prohibiting action
... code ΣC 1..1 CodeableConcept ​Task Type
Binding: http://hl7.org/fhir/uv/apix/ValueSet/apix-submission-type-vs (extensible)
... for SΣ 0..1 Reference(Resource) Beneficiary of the Task
... 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
... authoredOn C 1..1 dateTime Task Creation Date
... lastModified ΣC 1..1 dateTime Task Last Modified Date
... requester SΣ 1..1 Reference() Requesting organization
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
... requestedPerformer S 1..1 CodeableReference(Organization) Requesting performer organization
Binding: ProcedurePerformerRoleCodes (preferred): The type(s) of task performers allowed.
... Slices for input S 0..* BackboneElement Input parameters for the task
Slice: Unordered, Open by pattern:type.coding
.... input:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 CodeableConcept Label for the input
Binding Description: (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
.... input:regulatoryDocument S 0..* BackboneElement Regulatory document (CTD section, via DocumentReference index)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 CodeableConcept Label for the input
Binding Description: (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.
Fixed Value: As shown
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..0 Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/uv/apix/CodeSystem/apix-task-input-type
...... version 0..0 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: regulatory-document
...... display 1..1 string Representation defined by the system
Fixed Value: Regulatory Document
...... userSelected 0..0 boolean If this coding was chosen directly by the user
..... value[x] S 1..1 Reference() Content to use in performing the task
... Slices for output S 0..* BackboneElement Output produced by the task
Slice: Unordered, Open by pattern:type.coding
.... output:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 CodeableConcept Label for output
Binding Description: (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
.... output:regulatoryDocument S 0..* BackboneElement Regulatory document produced as output (via DocumentReference index)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 CodeableConcept Label for output
Binding Description: (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.
Fixed Value: As shown
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..0 Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/uv/apix/CodeSystem/apix-task-output-type
...... version 0..0 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: regulatory-document
...... display 1..1 string Representation defined by the system
Fixed Value: Regulatory Document
...... userSelected 0..0 boolean If this coding was chosen directly by the user
..... value[x] S 1..1 Reference() Result of output

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.businessStatus Base required APIX Regulatory Business Status 📦0.1.0 This IG
Task.intent Base required RequestIntent 📍5.0.0 FHIR Std.
Task.priority Base required RequestPriority 📍5.0.0 FHIR Std.
Task.code Base extensible ​ http://hl7.org/fhir/uv/apix/ValueSet/apix-submission-type-vs Not State Unknown
Task.requestedPerformer Base preferred Procedure Performer Role Codes 📍5.0.0 FHIR Std.
Task.input.type Base example Not State Unknown
Task.input:regulatoryDocument.​type Base example Not State Unknown
Task.output.type Base example Not State Unknown
Task.output:regulatoryDocument.​type Base example Not State Unknown

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()
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
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 0..* Task A task to be performed
... meta 1..1 Meta Metadata about the resource
.... versionId 1..1 id Version specific identifier
.... lastUpdated 1..1 instant When the resource version last changed
.... profile 1..* canonical(StructureDefinition) Profiles this resource claims to conform to
Fixed Value: http://hl7.org/fhir/uv/apix/StructureDefinition/apix-task
... text S 1..1 Narrative Text summary of the resource, for human interpretation
... Slices for contained S 0..* Resource Contained, inline Resources
Slice: Unordered, Open by profile:$this
.... contained:documentReference S 0..* APIXDocumentReference Embedded or Referenced Regulatory Document
.... identifier:TaskInstance S 1..1 Identifier Technical UUID for this specific Task instance
..... type 1..1 CodeableConcept Description of identifier
Required Pattern: At least the following
...... 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
..... system 0..1 uri The namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986
..... value 1..1 string The value that is unique
Required Pattern: urn:uuid:
.... identifier:RegulatorProcedureNumber S 0..1 Identifier Official regulator procedure/submission number (EMA, FDA, PMDA, etc.)
..... type 1..1 CodeableConcept Description of identifier
Required Pattern: At least the following
...... 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: RN
..... system 1..1 uri The namespace for the identifier value
Required Pattern: https://ema.europa.eu/procedure|https://fda.gov/ind|https://pmda.go.jp/application-number
..... 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
... status 1..1 code draft | requested | received | accepted | +
Binding: TaskStatus (required)
... businessStatus 0..1 CodeableConcept Detailed regulatory status (e.g., clock-stop)
Binding: APIX Regulatory Business Status (required)
... intent 1..1 code unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required)
Fixed Value: proposal
... priority S 1..1 code routine | urgent | asap | stat
Binding: RequestPriority (required)
... code 1..1 CodeableConcept ​Task Type
Binding: http://hl7.org/fhir/uv/apix/ValueSet/apix-submission-type-vs (extensible)
... description 0..0 Human-readable explanation of task
... focus 0..0 What task is acting on
... for S 0..1 Reference(Resource) Beneficiary of the Task
... 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 0..0 Start and end time of execution
... authoredOn 1..1 dateTime Task Creation Date
... lastModified 1..1 dateTime Task Last Modified Date
... requester S 1..1 Reference() Requesting organization
​.... contained S Organization Contained requesting organization
​..... name S 1..1 Organization name
​..... identifier S 1..* Organization identifier(s)
​..... address S 1..1 Organization address
​...... text S Full formatted address
​...... line S Street address line(s)
​...... city S City
​...... district S District/sub-division
​...... state S State / Province / Prefecture
​...... postalCode S Postal code
​...... country S Country (ISO 3166-1 alpha-2)
Binding: Iso316612 (required)
​..... contact
​...... Slices for telecom S 1..1 Organization contact points (email and phone)
Slice: Unordered, Open by value:system
​....... telecom:email S 1..1 Email address
​........ system 1..1 Fixed Value: email
​........ value S 1..1
​....... telecom:phone S 0..1 Phone number
​........ system 1..1 Fixed Value: phone
​........ value S 1..1
... requestedPerformer S 1..1 CodeableReference(Organization) Requesting performer organization
​.... contained S Organization Contained requesting performer organization
​..... name S 1..1 Organization name
​..... identifier S 1..* Organization identifier(s)
​..... address S 1..1 Organization address
​...... text S Full formatted address
​...... line S Street address line(s)
​...... city S City
​...... district S District/sub-division
​...... state S State / Province / Prefecture
​...... postalCode S Postal code
​...... country S Country (ISO 3166-1 alpha-2)
Binding: Iso316612 (required)
​..... contact
​...... Slices for telecom S 1..1 Organization contact points (email and phone)
Slice: Unordered, Open by value:system
​....... telecom:email S 1..1 Email address
​........ system 1..1 Fixed Value: email
​........ value S 1..1
​....... telecom:phone S 0..1 Phone number
​........ system 1..1 Fixed Value: phone
​........ value S 1..1
... owner 0..0 Responsible individual
... relevantHistory 0..0 Key events in history of the Task
... restriction 0..0 Constraints on fulfillment tasks
... Slices for input S 0..* BackboneElement Input parameters for the task
Slice: Unordered, Open by pattern:type.coding
.... input:regulatoryDocument S 0..* BackboneElement Regulatory document (CTD section, via DocumentReference index)
..... type 1..1 CodeableConcept Label for the input
Fixed Value: As shown
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/uv/apix/CodeSystem/apix-task-input-type
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: regulatory-document
...... display 1..1 string Representation defined by the system
Fixed Value: Regulatory Document
..... value[x] S 1..1 Reference() Content to use in performing the task
... Slices for output S 0..* BackboneElement Output produced by the task
Slice: Unordered, Open by pattern:type.coding
.... output:regulatoryDocument S 0..* BackboneElement Regulatory document produced as output (via DocumentReference index)
..... type 1..1 CodeableConcept Label for output
Fixed Value: As shown
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/uv/apix/CodeSystem/apix-task-output-type
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: regulatory-document
...... display 1..1 string Representation defined by the system
Fixed Value: Regulatory Document
..... value[x] S 1..1 Reference() Result of output

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Task.status Base required Task Status 📍5.0.0 FHIR Std.
Task.businessStatus Base required APIX Regulatory Business Status 📦0.1.0 This IG
Task.intent Base required RequestIntent 📍5.0.0 FHIR Std.
Task.priority Base required RequestPriority 📍5.0.0 FHIR Std.
Task.code Base extensible ​ http://hl7.org/fhir/uv/apix/ValueSet/apix-submission-type-vs Not State Unknown
Task.requester.contained.​address.country Base required Iso 3166 Part 1: 2 Letter Codes 📦5.0.0 FHIR Std.
Task.requestedPerformer.​contained.address.country Base required Iso 3166 Part 1: 2 Letter Codes 📦5.0.0 FHIR Std.

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Task C 0..* Task A task to be performed
Constraints: inv-1, tsk-1
... 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 Σ 1..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 1..* canonical(StructureDefinition) Profiles this resource claims to conform to

Fixed Value: http://hl7.org/fhir/uv/apix/StructureDefinition/apix-task
.... 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 Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... Slices for contained S 0..* Resource Contained, inline Resources
Slice: Unordered, Open by profile:$this
.... contained:documentReference S 0..* APIXDocumentReference Embedded or Referenced Regulatory Document
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... Slices for identifier 1..2 Identifier Task instance UUID (required) + official regulator procedure number (optional)
Slice: Unordered, Closed by value:type.coding.code
.... identifier:TaskInstance S 1..1 Identifier Technical UUID for this specific Task instance
..... 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
...... 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 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... system Σ 0..1 uri The namespace for the identifier value
Fixed Value: urn:ietf:rfc:3986
..... value ΣC 1..1 string The value that is unique
Required Pattern: urn:uuid:
..... 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 Σ 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
...... 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: RN
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... system Σ 1..1 uri The namespace for the identifier value
Required Pattern: https://ema.europa.eu/procedure|https://fda.gov/ind|https://pmda.go.jp/application-number
..... 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 Σ 0..* Reference(Resource) Request fulfilled by this task
... 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)
... statusReason Σ 0..1 CodeableReference() Reason for current status
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 (required)
... intent Σ 1..1 code unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required)
Fixed Value: proposal
... priority S 1..1 code routine | urgent | asap | stat
Binding: RequestPriority (required)
... doNotPerform ?!Σ 0..1 boolean True if Task is prohibiting action
... code ΣC 1..1 CodeableConcept ​Task Type
Binding: http://hl7.org/fhir/uv/apix/ValueSet/apix-submission-type-vs (extensible)
... for SΣ 0..1 Reference(Resource) Beneficiary of the Task
... 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
... authoredOn C 1..1 dateTime Task Creation Date
... lastModified ΣC 1..1 dateTime Task Last Modified Date
... requester SΣ 1..1 Reference() Requesting organization
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient") - must be a resource in resources
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier ΣC 0..1 Identifier Logical reference, when literal reference is not known
.... display ΣC 0..1 string Text alternative for the resource
... requestedPerformer S 1..1 CodeableReference(Organization) Requesting performer organization
Binding: ProcedurePerformerRoleCodes (preferred): The type(s) of task performers allowed.
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... concept Σ 0..1 CodeableConcept Reference to a concept (by class)
.... reference Σ 0..1 Reference() Reference to a resource (by instance)
... performer Σ 0..* BackboneElement Who or what 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
... Slices for input S 0..* BackboneElement Input parameters for the task
Slice: Unordered, Open by pattern:type.coding
.... input:All Slices Content/Rules for all slices
..... 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 1..1 CodeableConcept Label for the input
Binding Description: (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
.... input:regulatoryDocument S 0..* BackboneElement Regulatory document (CTD section, via DocumentReference index)
..... 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 1..1 CodeableConcept Label for the input
Binding Description: (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.
Fixed Value: As shown
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..0 Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/uv/apix/CodeSystem/apix-task-input-type
...... version 0..0 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: regulatory-document
...... display 1..1 string Representation defined by the system
Fixed Value: Regulatory Document
...... userSelected 0..0 boolean If this coding was chosen directly by the user
..... value[x] S 1..1 Reference() Content to use in performing the task
... Slices for output S 0..* BackboneElement Output produced by the task
Slice: Unordered, Open by pattern:type.coding
.... output:All Slices Content/Rules for all slices
..... 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 1..1 CodeableConcept Label for output
Binding Description: (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
.... output:regulatoryDocument S 0..* BackboneElement Regulatory document produced as output (via DocumentReference index)
..... 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 1..1 CodeableConcept Label for output
Binding Description: (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.
Fixed Value: As shown
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..0 Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.org/fhir/uv/apix/CodeSystem/apix-task-output-type
...... version 0..0 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: regulatory-document
...... display 1..1 string Representation defined by the system
Fixed Value: Regulatory Document
...... userSelected 0..0 boolean If this coding was chosen directly by the user
..... value[x] S 1..1 Reference() Result of output

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 required APIX Regulatory Business Status 📦0.1.0 This IG
Task.intent Base required RequestIntent 📍5.0.0 FHIR Std.
Task.priority Base required RequestPriority 📍5.0.0 FHIR Std.
Task.code Base extensible ​ http://hl7.org/fhir/uv/apix/ValueSet/apix-submission-type-vs Not State Unknown
Task.requester.type Base extensible Resource Types 📍5.0.0 FHIR Std.
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 Not State Unknown
Task.input:regulatoryDocument.​type Base example Not State Unknown
Task.output.type Base example Not State Unknown
Task.output:regulatoryDocument.​type Base example Not State Unknown

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()
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
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: 18 elements(25 nested mandatory elements)
Must-Support: 51 elements
Fixed: 9 elements
Prohibited: 7 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.contained
  • The element 1 is sliced based on the value of Task.identifier (Closed)
  • The element 1 is sliced based on the value of Task.requester.contained.contact.telecom
  • The element 1 is sliced based on the value of Task.requestedPerformer.contained.contact.telecom
  • The element 1 is sliced based on the value of Task.input
  • The element 1 is sliced based on the value of Task.output

 

Other representations of profile: CSV, Excel, Schematron