AU eRequesting Implementation Guide
0.3.0-ci-build - CI Build
AU eRequesting Implementation Guide
0.3.0-ci-build - CI Build
AU eRequesting Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 0.3.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/mjosborne1/mjo-au-fhir-erequesting/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-task | Version: 0.3.0-ci-build | |||
| Standards status: Draft | Maturity Level: 0 | Computable Name: AUeRequestingTask | ||
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2024+; Licensed Under Creative Commons No Rights Reserved. |
||||
This profile sets minimum expectations for a Task resource that is used to record, search, and fetch information about a task to be performed. It is based on the Task and identifies the additional constraints, extensions, vocabularies and value sets that SHALL be present in the Task when conforming to this profile.
Usages:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Task
| Path | Conformance | ValueSet | URI |
| Task.meta.tag:eRequestingFulfilmentTask | required | AUeRequestingFulfilmentTaskTagshttp://terminology.hl7.org.au/ValueSet/au-erequesting-fulfilment-task-tagsFrom this IG | |
| Task.status | required | AUeRequestingTaskStatushttp://terminology.hl7.org.au/ValueSet/au-erequesting-task-statusFrom this IG | |
| Task.businessStatus | extensible | AUeRequestingTaskBusinessStatus(a valid code from Task Business Status)http://terminology.hl7.org.au/ValueSet/au-erequesting-task-businessstatusFrom this IG |
| Name | Flags | Card. | Type | Description & Constraints Filter:   | |||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
  Task |
C | 0..* | Task | This is an abstract profile. Child profiles: AUeRequestingTaskCommunicationRequest, AUeRequestingTaskDiagnosticRequest, AUeRequestingTaskGroup A task to be performed Constraints: inv-1 | |||||||||||||||||
  meta |
SOΣ | 1..1 | Meta | Metadata about the resource
| |||||||||||||||||
   Slices for tag |
Σ | 1..* | Coding | Tags applied to this resource Slice: Unordered, Open by value:$this Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | |||||||||||||||||
   tag:eRequestingFulfilmentTask |
SOΣ | 1..1 | Coding | Tags applied to this resource Binding: AU eRequesting Fulfilment Task Tags (required)
| |||||||||||||||||
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||||||||||||||
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||||||||||
| identifier |
SO | 0..* | Identifier, AULocalOrderIdentifier | Task Instance Identifier
| |||||||||||||||||
| groupIdentifier |
SOΣ | 1..1 | AULocalOrderIdentifier | Requisition or grouper id
| |||||||||||||||||
| 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 | Coded identifier type for local order identifier Binding: Order Identifier Type (required) | |||||||||||||||||
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system 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: PGN | ||||||||||||||||||
| 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 | System identifier namespace for the organisation that assigned the order identifier Example General: http://www.acme.com/identifiers/patient | |||||||||||||||||
| value |
Σ | 1..1 | string | Order identifier Example General: 123456 | |||||||||||||||||
| status |
?!SOΣ | 1..1 | code | draft | requested | received | accepted | + Binding: AU eRequesting Task Status (required)
| |||||||||||||||||
| statusReason |
SOΣ | 0..1 | CodeableConcept | Reason for current status Binding Description: (example): Codes to identify the reason for current status. These will typically be specific to a particular workflow.
| |||||||||||||||||
| businessStatus |
SOΣ | 0..1 | CodeableConcept | Business status of the Task e.g. Booked Binding: AU eRequesting Task Business Status (extensible)
| |||||||||||||||||
| intent |
SOΣ | 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. Fixed Value: order
| |||||||||||||||||
| priority |
SO | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): The task's priority.
| |||||||||||||||||
 for |
SOΣ | 1..1 | Reference(AU Core Patient) | Beneficiary of the Task
| |||||||||||||||||
| authoredOn |
SOC | 1..1 | dateTime | Task Creation Date
| |||||||||||||||||
| lastModified |
SOΣC | 0..1 | dateTime | Task Last Modified Date
| |||||||||||||||||
| requester |
SOΣ | 1..1 | Reference(AU Core PractitionerRole) | Who is asking for task to be done
| |||||||||||||||||
| owner |
SOΣ | 0..1 | Reference(AU Core Organization) | Responsible individual
| |||||||||||||||||
| Documentation for this format | |||||||||||||||||||||
| Path | Conformance | ValueSet / Code | URI |
| Task.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsFrom the FHIR Standard | |
| Task.meta.tag:eRequestingFulfilmentTask | required | AUeRequestingFulfilmentTaskTagshttp://terminology.hl7.org.au/ValueSet/au-erequesting-fulfilment-task-tagsFrom this IG | |
| Task.groupIdentifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | |
| Task.groupIdentifier.type | required | OrderIdentifierTypehttp://terminology.hl7.org.au/ValueSet/order-identifier-type | |
| Task.status | required | AUeRequestingTaskStatushttp://terminology.hl7.org.au/ValueSet/au-erequesting-task-statusFrom this IG | |
| Task.statusReason | example | ||
| Task.businessStatus | extensible | AUeRequestingTaskBusinessStatus(a valid code from Task Business Status)http://terminology.hl7.org.au/ValueSet/au-erequesting-task-businessstatusFrom this IG | |
| Task.intent | required | Fixed Value: orderhttp://hl7.org/fhir/ValueSet/task-intent|4.0.1From the FHIR Standard | |
| Task.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1From the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | 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 |
| Name | Flags | Card. | Type | Description & Constraints Filter: | |||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Task |
C | 0..* | Task | This is an abstract profile. Child profiles: AUeRequestingTaskCommunicationRequest, AUeRequestingTaskDiagnosticRequest, AUeRequestingTaskGroup A task to be performed Constraints: inv-1 | |||||||||||||||||
| id |
Σ | 0..1 | id | Logical id of this artifact | |||||||||||||||||
| meta |
SOΣ | 1..1 | Meta | Metadata about the resource
| |||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||
 extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||||||||||||||||
| versionId |
Σ | 0..1 | id | Version specific identifier | |||||||||||||||||
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed | |||||||||||||||||
| 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: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |||||||||||||||||
| Slices for tag |
Σ | 1..* | Coding | Tags applied to this resource Slice: Unordered, Open by value:$this Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | |||||||||||||||||
| tag:eRequestingFulfilmentTask |
SOΣ | 1..1 | Coding | Tags applied to this resource Binding: AU eRequesting Fulfilment Task Tags (required)
| |||||||||||||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||||||||||||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| ||||||||||||||||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | ||||||||||||||||||
| contained |
0..* | Resource | Contained, inline Resources | ||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | ||||||||||||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||||||||||
| identifier |
SO | 0..* | Identifier, AULocalOrderIdentifier | Task Instance Identifier
| |||||||||||||||||
| 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 |
SOΣ | 1..1 | AULocalOrderIdentifier | Requisition or grouper id
| |||||||||||||||||
| id |
0..1 | string | 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 | Coded identifier type for local order identifier Binding: Order Identifier Type (required) | |||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||||||||||||||||
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system 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: PGN | ||||||||||||||||||
| display |
0..1 | string | Representation defined by the system | ||||||||||||||||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | ||||||||||||||||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | |||||||||||||||||
| system |
Σ | 1..1 | uri | System identifier namespace for the organisation that assigned the order identifier Example General: http://www.acme.com/identifiers/patient | |||||||||||||||||
| value |
Σ | 1..1 | string | Order identifier Example General: 123456 | |||||||||||||||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | |||||||||||||||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organisation that assigned the order identifier | |||||||||||||||||
| id |
0..1 | string | 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") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||||||||||||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | |||||||||||||||||
| display |
Σ | 1..1 | string | Name of the assigning organisation | |||||||||||||||||
| partOf |
Σ | 0..* | Reference(Task) | Composite task | |||||||||||||||||
| status |
?!SOΣ | 1..1 | code | draft | requested | received | accepted | + Binding: AU eRequesting Task Status (required)
| |||||||||||||||||
| statusReason |
SOΣ | 0..1 | CodeableConcept | Reason for current status Binding Description: (example): Codes to identify the reason for current status. These will typically be specific to a particular workflow.
| |||||||||||||||||
| businessStatus |
SOΣ | 0..1 | CodeableConcept | Business status of the Task e.g. Booked Binding: AU eRequesting Task Business Status (extensible)
| |||||||||||||||||
| intent |
SOΣ | 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. Fixed Value: order
| |||||||||||||||||
| priority |
SO | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): The task's priority.
| |||||||||||||||||
| code |
Σ | 0..1 | CodeableConcept | Task Type Binding: TaskCode (example): Codes to identify what the task involves. These will typically be specific to a particular workflow. | |||||||||||||||||
| description |
Σ | 0..1 | string | Human-readable explanation of task | |||||||||||||||||
| focus |
Σ | 0..1 | Reference(Resource) | What task is acting on | |||||||||||||||||
| for |
SOΣ | 1..1 | Reference(AU Core Patient) | Beneficiary of the Task
| |||||||||||||||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Healthcare event during which this task originated | |||||||||||||||||
| executionPeriod |
Σ | 0..1 | Period | Start and end time of execution | |||||||||||||||||
| authoredOn |
SOC | 1..1 | dateTime | Task Creation Date
| |||||||||||||||||
| lastModified |
SOΣC | 0..1 | dateTime | Task Last Modified Date
| |||||||||||||||||
| requester |
SOΣ | 1..1 | Reference(AU Core PractitionerRole) | Who is asking for task to be done
| |||||||||||||||||
| performerType |
0..* | CodeableConcept | Requested performer Binding: ProcedurePerformerRoleCodes (preferred): The type(s) of task performers allowed. | ||||||||||||||||||
| owner |
SOΣ | 0..1 | Reference(AU Core Organization) | Responsible individual
| |||||||||||||||||
| location |
Σ | 0..1 | Reference(Location) | Where task occurs | |||||||||||||||||
| reasonCode |
0..1 | CodeableConcept | Why task is needed Binding Description: (example): Indicates why the task is needed. E.g. Suspended because patient admitted to hospital. | ||||||||||||||||||
| reasonReference |
0..1 | Reference(Resource) | Why task is needed | ||||||||||||||||||
| insurance |
0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | ||||||||||||||||||
| note |
0..* | Annotation | Comments made about the task | ||||||||||||||||||
| relevantHistory |
0..* | Reference(Provenance) | Key events in history of the Task | ||||||||||||||||||
| restriction |
0..1 | BackboneElement | Constraints on fulfillment tasks | ||||||||||||||||||
| 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 | |||||||||||||||||
| repetitions |
0..1 | positiveInt | How many times to repeat | ||||||||||||||||||
| period |
0..1 | Period | When fulfillment sought | ||||||||||||||||||
| recipient |
0..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Group | Organization) | For whom is fulfillment sought? | ||||||||||||||||||
| input |
0..* | BackboneElement | Information used to perform 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 |
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 | ||||||||||||||||||||
| 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 | ||||||||||||||||||||
| valueCoding |
Coding | ||||||||||||||||||||
| valueContactPoint |
ContactPoint | ||||||||||||||||||||
| valueCount |
Count | ||||||||||||||||||||
| valueDistance |
Distance | ||||||||||||||||||||
| valueDuration |
Duration | ||||||||||||||||||||
| valueHumanName |
HumanName | ||||||||||||||||||||
| valueIdentifier |
Identifier | ||||||||||||||||||||
| valueMoney |
Money | ||||||||||||||||||||
| valuePeriod |
Period | ||||||||||||||||||||
| valueQuantity |
Quantity | ||||||||||||||||||||
| valueRange |
Range | ||||||||||||||||||||
| valueRatio |
Ratio | ||||||||||||||||||||
| valueReference |
Reference(Any) | ||||||||||||||||||||
| valueSampledData |
SampledData | ||||||||||||||||||||
| valueSignature |
Signature | ||||||||||||||||||||
| valueTiming |
Timing | ||||||||||||||||||||
| valueContactDetail |
ContactDetail | ||||||||||||||||||||
| valueContributor |
Contributor | ||||||||||||||||||||
| valueDataRequirement |
DataRequirement | ||||||||||||||||||||
| valueExpression |
Expression | ||||||||||||||||||||
| valueParameterDefinition |
ParameterDefinition | ||||||||||||||||||||
| valueRelatedArtifact |
RelatedArtifact | ||||||||||||||||||||
| valueTriggerDefinition |
TriggerDefinition | ||||||||||||||||||||
| valueUsageContext |
UsageContext | ||||||||||||||||||||
| valueDosage |
Dosage | ||||||||||||||||||||
| valueMeta |
Meta | ||||||||||||||||||||
| output |
0..* | BackboneElement | Information produced as part of 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 |
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 | ||||||||||||||||||||
| 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 | ||||||||||||||||||||
| valueCoding |
Coding | ||||||||||||||||||||
| valueContactPoint |
ContactPoint | ||||||||||||||||||||
| valueCount |
Count | ||||||||||||||||||||
| valueDistance |
Distance | ||||||||||||||||||||
| valueDuration |
Duration | ||||||||||||||||||||
| valueHumanName |
HumanName | ||||||||||||||||||||
| valueIdentifier |
Identifier | ||||||||||||||||||||
| valueMoney |
Money | ||||||||||||||||||||
| valuePeriod |
Period | ||||||||||||||||||||
| valueQuantity |
Quantity | ||||||||||||||||||||
| valueRange |
Range | ||||||||||||||||||||
| valueRatio |
Ratio | ||||||||||||||||||||
| valueReference |
Reference(Any) | ||||||||||||||||||||
| valueSampledData |
SampledData | ||||||||||||||||||||
| valueSignature |
Signature | ||||||||||||||||||||
| valueTiming |
Timing | ||||||||||||||||||||
| valueContactDetail |
ContactDetail | ||||||||||||||||||||
| valueContributor |
Contributor | ||||||||||||||||||||
| valueDataRequirement |
DataRequirement | ||||||||||||||||||||
| valueExpression |
Expression | ||||||||||||||||||||
| valueParameterDefinition |
ParameterDefinition | ||||||||||||||||||||
| valueRelatedArtifact |
RelatedArtifact | ||||||||||||||||||||
| valueTriggerDefinition |
TriggerDefinition | ||||||||||||||||||||
| valueUsageContext |
UsageContext | ||||||||||||||||||||
| valueDosage |
Dosage | ||||||||||||||||||||
| valueMeta |
Meta | ||||||||||||||||||||
| Documentation for this format | |||||||||||||||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Task.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsFrom the FHIR Standard | ||||
| Task.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsFrom the FHIR Standard | ||||
| Task.meta.tag:eRequestingFulfilmentTask | required | AUeRequestingFulfilmentTaskTagshttp://terminology.hl7.org.au/ValueSet/au-erequesting-fulfilment-task-tagsFrom this IG | ||||
| Task.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| Task.groupIdentifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | ||||
| Task.groupIdentifier.type | required | OrderIdentifierTypehttp://terminology.hl7.org.au/ValueSet/order-identifier-type | ||||
| Task.groupIdentifier.assigner.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard | ||||
| Task.status | required | AUeRequestingTaskStatushttp://terminology.hl7.org.au/ValueSet/au-erequesting-task-statusFrom this IG | ||||
| Task.statusReason | example | |||||
| Task.businessStatus | extensible | AUeRequestingTaskBusinessStatus(a valid code from Task Business Status)http://terminology.hl7.org.au/ValueSet/au-erequesting-task-businessstatusFrom this IG | ||||
| Task.intent | required | Fixed Value: orderhttp://hl7.org/fhir/ValueSet/task-intent|4.0.1From the FHIR Standard | ||||
| Task.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1From the FHIR Standard | ||||
| Task.code | example | TaskCodehttp://hl7.org/fhir/ValueSet/task-codeFrom the FHIR Standard | ||||
| Task.performerType | preferred | ProcedurePerformerRoleCodeshttp://hl7.org/fhir/ValueSet/performer-roleFrom the FHIR Standard | ||||
| Task.reasonCode | example | |||||
| Task.input.type | example | |||||
| Task.output.type | example |
| Id | Grade | Path(s) | Details | Requirements |
| 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | 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 |
This structure is derived from Task
Summary
Mandatory: 8 elements
Must-Support: 14 elements
Fixed: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 0
Differential View
This structure is derived from Task
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Task |
Task | This is an abstract profile. Child profiles: AUeRequestingTaskCommunicationRequest, AUeRequestingTaskDiagnosticRequest, AUeRequestingTaskGroup | ||||||||||||||
 meta |
SO | 1..1 | Meta | Metadata about the resource
| ||||||||||||
| Slices for tag |
1..* | Coding | Tags applied to this resource Slice: Unordered, Open by value:$this | |||||||||||||
| tag:eRequestingFulfilmentTask |
SO | 1..1 | Coding | Tags applied to this resource Binding: AU eRequesting Fulfilment Task Tags (required)
| ||||||||||||
| identifier |
SO | 0..* | Identifier, AULocalOrderIdentifier | Task Instance Identifier
| ||||||||||||
| groupIdentifier |
SO | 1..1 | AULocalOrderIdentifier | Requisition or grouper id
| ||||||||||||
| type |
||||||||||||||||
| coding |
1..1 | Coding | Code defined by a terminology system 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: PGN | |||||||||||||
| status |
SO | 1..1 | code | draft | requested | received | accepted | + Binding: AU eRequesting Task Status (required)
| ||||||||||||
| statusReason |
SO | 0..1 | CodeableConcept | Reason for current status
| ||||||||||||
| businessStatus |
SO | 0..1 | CodeableConcept | Business status of the Task e.g. Booked Binding: AU eRequesting Task Business Status (extensible)
| ||||||||||||
| intent |
SO | 1..1 | code | unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Fixed Value: order
| ||||||||||||
| priority |
SO | 0..1 | code | routine | urgent | asap | stat
| ||||||||||||
| for |
SO | 1..1 | Reference(AU Core Patient) | Beneficiary of the Task
| ||||||||||||
| authoredOn |
SO | 1..1 | dateTime | Task Creation Date
| ||||||||||||
| lastModified |
SO | 0..1 | dateTime | Task Last Modified Date
| ||||||||||||
| requester |
SO | 1..1 | Reference(AU Core PractitionerRole) | Who is asking for task to be done
| ||||||||||||
| owner |
SO | 0..1 | Reference(AU Core Organization) | Responsible individual
| ||||||||||||
| Documentation for this format | ||||||||||||||||
| Path | Conformance | ValueSet | URI |
| Task.meta.tag:eRequestingFulfilmentTask | required | AUeRequestingFulfilmentTaskTagshttp://terminology.hl7.org.au/ValueSet/au-erequesting-fulfilment-task-tagsFrom this IG | |
| Task.status | required | AUeRequestingTaskStatushttp://terminology.hl7.org.au/ValueSet/au-erequesting-task-statusFrom this IG | |
| Task.businessStatus | extensible | AUeRequestingTaskBusinessStatus(a valid code from Task Business Status)http://terminology.hl7.org.au/ValueSet/au-erequesting-task-businessstatusFrom this IG |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | |||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Task |
C | 0..* | Task | This is an abstract profile. Child profiles: AUeRequestingTaskCommunicationRequest, AUeRequestingTaskDiagnosticRequest, AUeRequestingTaskGroup A task to be performed Constraints: inv-1 | |||||||||||||||||
| meta |
SOΣ | 1..1 | Meta | Metadata about the resource
| |||||||||||||||||
| Slices for tag |
Σ | 1..* | Coding | Tags applied to this resource Slice: Unordered, Open by value:$this Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | |||||||||||||||||
| tag:eRequestingFulfilmentTask |
SOΣ | 1..1 | Coding | Tags applied to this resource Binding: AU eRequesting Fulfilment Task Tags (required)
| |||||||||||||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||||||||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||||||||||
| identifier |
SO | 0..* | Identifier, AULocalOrderIdentifier | Task Instance Identifier
| |||||||||||||||||
| groupIdentifier |
SOΣ | 1..1 | AULocalOrderIdentifier | Requisition or grouper id
| |||||||||||||||||
| 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 | Coded identifier type for local order identifier Binding: Order Identifier Type (required) | |||||||||||||||||
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system 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: PGN | ||||||||||||||||||
| 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 | System identifier namespace for the organisation that assigned the order identifier Example General: http://www.acme.com/identifiers/patient | |||||||||||||||||
| value |
Σ | 1..1 | string | Order identifier Example General: 123456 | |||||||||||||||||
| status |
?!SOΣ | 1..1 | code | draft | requested | received | accepted | + Binding: AU eRequesting Task Status (required)
| |||||||||||||||||
| statusReason |
SOΣ | 0..1 | CodeableConcept | Reason for current status Binding Description: (example): Codes to identify the reason for current status. These will typically be specific to a particular workflow.
| |||||||||||||||||
| businessStatus |
SOΣ | 0..1 | CodeableConcept | Business status of the Task e.g. Booked Binding: AU eRequesting Task Business Status (extensible)
| |||||||||||||||||
| intent |
SOΣ | 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. Fixed Value: order
| |||||||||||||||||
| priority |
SO | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): The task's priority.
| |||||||||||||||||
| for |
SOΣ | 1..1 | Reference(AU Core Patient) | Beneficiary of the Task
| |||||||||||||||||
| authoredOn |
SOC | 1..1 | dateTime | Task Creation Date
| |||||||||||||||||
| lastModified |
SOΣC | 0..1 | dateTime | Task Last Modified Date
| |||||||||||||||||
| requester |
SOΣ | 1..1 | Reference(AU Core PractitionerRole) | Who is asking for task to be done
| |||||||||||||||||
| owner |
SOΣ | 0..1 | Reference(AU Core Organization) | Responsible individual
| |||||||||||||||||
| Documentation for this format | |||||||||||||||||||||
| Path | Conformance | ValueSet / Code | URI |
| Task.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsFrom the FHIR Standard | |
| Task.meta.tag:eRequestingFulfilmentTask | required | AUeRequestingFulfilmentTaskTagshttp://terminology.hl7.org.au/ValueSet/au-erequesting-fulfilment-task-tagsFrom this IG | |
| Task.groupIdentifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | |
| Task.groupIdentifier.type | required | OrderIdentifierTypehttp://terminology.hl7.org.au/ValueSet/order-identifier-type | |
| Task.status | required | AUeRequestingTaskStatushttp://terminology.hl7.org.au/ValueSet/au-erequesting-task-statusFrom this IG | |
| Task.statusReason | example | ||
| Task.businessStatus | extensible | AUeRequestingTaskBusinessStatus(a valid code from Task Business Status)http://terminology.hl7.org.au/ValueSet/au-erequesting-task-businessstatusFrom this IG | |
| Task.intent | required | Fixed Value: orderhttp://hl7.org/fhir/ValueSet/task-intent|4.0.1From the FHIR Standard | |
| Task.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1From the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | 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 |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | |||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Task |
C | 0..* | Task | This is an abstract profile. Child profiles: AUeRequestingTaskCommunicationRequest, AUeRequestingTaskDiagnosticRequest, AUeRequestingTaskGroup A task to be performed Constraints: inv-1 | |||||||||||||||||
| id |
Σ | 0..1 | id | Logical id of this artifact | |||||||||||||||||
| meta |
SOΣ | 1..1 | Meta | Metadata about the resource
| |||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||||||||||||||||
| versionId |
Σ | 0..1 | id | Version specific identifier | |||||||||||||||||
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed | |||||||||||||||||
| 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: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |||||||||||||||||
| Slices for tag |
Σ | 1..* | Coding | Tags applied to this resource Slice: Unordered, Open by value:$this Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | |||||||||||||||||
| tag:eRequestingFulfilmentTask |
SOΣ | 1..1 | Coding | Tags applied to this resource Binding: AU eRequesting Fulfilment Task Tags (required)
| |||||||||||||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||||||||||||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| ||||||||||||||||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | ||||||||||||||||||
| contained |
0..* | Resource | Contained, inline Resources | ||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | ||||||||||||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||||||||||
| identifier |
SO | 0..* | Identifier, AULocalOrderIdentifier | Task Instance Identifier
| |||||||||||||||||
| 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 |
SOΣ | 1..1 | AULocalOrderIdentifier | Requisition or grouper id
| |||||||||||||||||
| id |
0..1 | string | 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 | Coded identifier type for local order identifier Binding: Order Identifier Type (required) | |||||||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||||||||||||||||
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system 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: PGN | ||||||||||||||||||
| display |
0..1 | string | Representation defined by the system | ||||||||||||||||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | ||||||||||||||||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | |||||||||||||||||
| system |
Σ | 1..1 | uri | System identifier namespace for the organisation that assigned the order identifier Example General: http://www.acme.com/identifiers/patient | |||||||||||||||||
| value |
Σ | 1..1 | string | Order identifier Example General: 123456 | |||||||||||||||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | |||||||||||||||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organisation that assigned the order identifier | |||||||||||||||||
| id |
0..1 | string | 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") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||||||||||||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | |||||||||||||||||
| display |
Σ | 1..1 | string | Name of the assigning organisation | |||||||||||||||||
| partOf |
Σ | 0..* | Reference(Task) | Composite task | |||||||||||||||||
| status |
?!SOΣ | 1..1 | code | draft | requested | received | accepted | + Binding: AU eRequesting Task Status (required)
| |||||||||||||||||
| statusReason |
SOΣ | 0..1 | CodeableConcept | Reason for current status Binding Description: (example): Codes to identify the reason for current status. These will typically be specific to a particular workflow.
| |||||||||||||||||
| businessStatus |
SOΣ | 0..1 | CodeableConcept | Business status of the Task e.g. Booked Binding: AU eRequesting Task Business Status (extensible)
| |||||||||||||||||
| intent |
SOΣ | 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. Fixed Value: order
| |||||||||||||||||
| priority |
SO | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): The task's priority.
| |||||||||||||||||
| code |
Σ | 0..1 | CodeableConcept | Task Type Binding: TaskCode (example): Codes to identify what the task involves. These will typically be specific to a particular workflow. | |||||||||||||||||
| description |
Σ | 0..1 | string | Human-readable explanation of task | |||||||||||||||||
| focus |
Σ | 0..1 | Reference(Resource) | What task is acting on | |||||||||||||||||
| for |
SOΣ | 1..1 | Reference(AU Core Patient) | Beneficiary of the Task
| |||||||||||||||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Healthcare event during which this task originated | |||||||||||||||||
| executionPeriod |
Σ | 0..1 | Period | Start and end time of execution | |||||||||||||||||
| authoredOn |
SOC | 1..1 | dateTime | Task Creation Date
| |||||||||||||||||
| lastModified |
SOΣC | 0..1 | dateTime | Task Last Modified Date
| |||||||||||||||||
| requester |
SOΣ | 1..1 | Reference(AU Core PractitionerRole) | Who is asking for task to be done
| |||||||||||||||||
| performerType |
0..* | CodeableConcept | Requested performer Binding: ProcedurePerformerRoleCodes (preferred): The type(s) of task performers allowed. | ||||||||||||||||||
| owner |
SOΣ | 0..1 | Reference(AU Core Organization) | Responsible individual
| |||||||||||||||||
| location |
Σ | 0..1 | Reference(Location) | Where task occurs | |||||||||||||||||
| reasonCode |
0..1 | CodeableConcept | Why task is needed Binding Description: (example): Indicates why the task is needed. E.g. Suspended because patient admitted to hospital. | ||||||||||||||||||
| reasonReference |
0..1 | Reference(Resource) | Why task is needed | ||||||||||||||||||
| insurance |
0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | ||||||||||||||||||
| note |
0..* | Annotation | Comments made about the task | ||||||||||||||||||
| relevantHistory |
0..* | Reference(Provenance) | Key events in history of the Task | ||||||||||||||||||
| restriction |
0..1 | BackboneElement | Constraints on fulfillment tasks | ||||||||||||||||||
| 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 | |||||||||||||||||
| repetitions |
0..1 | positiveInt | How many times to repeat | ||||||||||||||||||
| period |
0..1 | Period | When fulfillment sought | ||||||||||||||||||
| recipient |
0..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Group | Organization) | For whom is fulfillment sought? | ||||||||||||||||||
| input |
0..* | BackboneElement | Information used to perform 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 |
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 | ||||||||||||||||||||
| 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 | ||||||||||||||||||||
| valueCoding |
Coding | ||||||||||||||||||||
| valueContactPoint |
ContactPoint | ||||||||||||||||||||
| valueCount |
Count | ||||||||||||||||||||
| valueDistance |
Distance | ||||||||||||||||||||
| valueDuration |
Duration | ||||||||||||||||||||
| valueHumanName |
HumanName | ||||||||||||||||||||
| valueIdentifier |
Identifier | ||||||||||||||||||||
| valueMoney |
Money | ||||||||||||||||||||
| valuePeriod |
Period | ||||||||||||||||||||
| valueQuantity |
Quantity | ||||||||||||||||||||
| valueRange |
Range | ||||||||||||||||||||
| valueRatio |
Ratio | ||||||||||||||||||||
| valueReference |
Reference(Any) | ||||||||||||||||||||
| valueSampledData |
SampledData | ||||||||||||||||||||
| valueSignature |
Signature | ||||||||||||||||||||
| valueTiming |
Timing | ||||||||||||||||||||
| valueContactDetail |
ContactDetail | ||||||||||||||||||||
| valueContributor |
Contributor | ||||||||||||||||||||
| valueDataRequirement |
DataRequirement | ||||||||||||||||||||
| valueExpression |
Expression | ||||||||||||||||||||
| valueParameterDefinition |
ParameterDefinition | ||||||||||||||||||||
| valueRelatedArtifact |
RelatedArtifact | ||||||||||||||||||||
| valueTriggerDefinition |
TriggerDefinition | ||||||||||||||||||||
| valueUsageContext |
UsageContext | ||||||||||||||||||||
| valueDosage |
Dosage | ||||||||||||||||||||
| valueMeta |
Meta | ||||||||||||||||||||
| output |
0..* | BackboneElement | Information produced as part of 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 |
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 | ||||||||||||||||||||
| 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 | ||||||||||||||||||||
| valueCoding |
Coding | ||||||||||||||||||||
| valueContactPoint |
ContactPoint | ||||||||||||||||||||
| valueCount |
Count | ||||||||||||||||||||
| valueDistance |
Distance | ||||||||||||||||||||
| valueDuration |
Duration | ||||||||||||||||||||
| valueHumanName |
HumanName | ||||||||||||||||||||
| valueIdentifier |
Identifier | ||||||||||||||||||||
| valueMoney |
Money | ||||||||||||||||||||
| valuePeriod |
Period | ||||||||||||||||||||
| valueQuantity |
Quantity | ||||||||||||||||||||
| valueRange |
Range | ||||||||||||||||||||
| valueRatio |
Ratio | ||||||||||||||||||||
| valueReference |
Reference(Any) | ||||||||||||||||||||
| valueSampledData |
SampledData | ||||||||||||||||||||
| valueSignature |
Signature | ||||||||||||||||||||
| valueTiming |
Timing | ||||||||||||||||||||
| valueContactDetail |
ContactDetail | ||||||||||||||||||||
| valueContributor |
Contributor | ||||||||||||||||||||
| valueDataRequirement |
DataRequirement | ||||||||||||||||||||
| valueExpression |
Expression | ||||||||||||||||||||
| valueParameterDefinition |
ParameterDefinition | ||||||||||||||||||||
| valueRelatedArtifact |
RelatedArtifact | ||||||||||||||||||||
| valueTriggerDefinition |
TriggerDefinition | ||||||||||||||||||||
| valueUsageContext |
UsageContext | ||||||||||||||||||||
| valueDosage |
Dosage | ||||||||||||||||||||
| valueMeta |
Meta | ||||||||||||||||||||
| Documentation for this format | |||||||||||||||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Task.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsFrom the FHIR Standard | ||||
| Task.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsFrom the FHIR Standard | ||||
| Task.meta.tag:eRequestingFulfilmentTask | required | AUeRequestingFulfilmentTaskTagshttp://terminology.hl7.org.au/ValueSet/au-erequesting-fulfilment-task-tagsFrom this IG | ||||
| Task.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| Task.groupIdentifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | ||||
| Task.groupIdentifier.type | required | OrderIdentifierTypehttp://terminology.hl7.org.au/ValueSet/order-identifier-type | ||||
| Task.groupIdentifier.assigner.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard | ||||
| Task.status | required | AUeRequestingTaskStatushttp://terminology.hl7.org.au/ValueSet/au-erequesting-task-statusFrom this IG | ||||
| Task.statusReason | example | |||||
| Task.businessStatus | extensible | AUeRequestingTaskBusinessStatus(a valid code from Task Business Status)http://terminology.hl7.org.au/ValueSet/au-erequesting-task-businessstatusFrom this IG | ||||
| Task.intent | required | Fixed Value: orderhttp://hl7.org/fhir/ValueSet/task-intent|4.0.1From the FHIR Standard | ||||
| Task.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1From the FHIR Standard | ||||
| Task.code | example | TaskCodehttp://hl7.org/fhir/ValueSet/task-codeFrom the FHIR Standard | ||||
| Task.performerType | preferred | ProcedurePerformerRoleCodeshttp://hl7.org/fhir/ValueSet/performer-roleFrom the FHIR Standard | ||||
| Task.reasonCode | example | |||||
| Task.input.type | example | |||||
| Task.output.type | example |
| Id | Grade | Path(s) | Details | Requirements |
| 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | 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 |
This structure is derived from Task
Summary
Mandatory: 8 elements
Must-Support: 14 elements
Fixed: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron
Below is an overview of the mandatory and optional search parameters and combined search parameters. See the AU eRequesting CapabilityStatements for a complete list of supported RESTful interactions for this IG.
FHIR search operations are described here and the syntax used to describe AU eRequesting interactions is defined here.
Any search parameter defined in FHIR may be ‘allowed’ by the system unless explicitly marked as “SHALL NOT”.
| Parameter(s) | Server Conformance | Placer Conformance | Filler Conformance | Patient Conformance | Type(s) | Requirements (when used alone or in combination) |
|---|---|---|---|---|---|---|
| _id | SHALL | MAY | MAY | MAY | token |
|
| _lastUpdated | SHALL | MAY | MAY | MAY | date |
The Server SHALL support multipleAnd. The Server SHALL support search comparators gt, lt, ge, le.The Placer, Filler and AU eRequesting Patient actors MAY support multipleAnd.The Placer, Filler and AU eRequesting Patient actors MAY support search comparators gt, lt, ge, le. |
| _lastUpdated+status+owner | SHALL | MAY | MAY | MAY | date+token+reference |
|
| _tag | SHALL | MAY | MAY | MAY | token |
|
| focus | SHALL | MAY | MAY | MAY | reference |
|
| group-identifier | SHALL | MAY | MAY | MAY | token |
|
| owner | SHALL | MAY | MAY | MAY | reference |
The same conformance rules apply to the chained search owner.identifier using HPI-O and ABN identifiers as defined in the AU Core Organization profile. |
| owner+status | SHALL | MAY | MAY | MAY | reference+token |
|
| patient | SHALL | MAY | MAY | MAY | reference |
The same conformance rules apply to the chained search patient.identifier using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. |
| patient+status | SHALL | MAY | MAY | MAY | reference+token |
|
| requester | SHALL | MAY | MAY | MAY | reference |
The same conformance rules apply to the chained search requester.identifier using Medicare Provider Number identifier as defined in the AU Core PractitionerRole profile. |
| requester+status | SHALL | MAY | MAY | MAY | reference+token |
|
| status | SHALL | MAY | MAY | MAY | token |
The Server SHALL support multipleOr.The Placer, Filler and AU eRequesting Patient actors MAY support multipleOr. |
| _include=Task:focus | SHALL | MAY | MAY | MAY | reference |
Modifies search results from a query using other search parameters by including the referenced focus resource |
| _include=Task:owner | SHALL | MAY | MAY | MAY | reference |
Modifies search results from a query using other search parameters by including the referenced focus resource |
| _include=Task:patient | SHALL | MAY | MAY | MAY | reference |
Modifies search results from a query using other search parameters by including the referenced focus resource |
| _include=Task:requester | SHALL | MAY | MAY | MAY | reference |
Modifies search results from a query using other search parameters by including the referenced focus resource |
The following search parameters and search parameter combinations are supported. Conformance obligations are detailed in the table above.
_id search parameter
_include parameters: Task:focus, Task:owner, Task:patient, and Task:requesterGET [base]/Task?_id=[id]
Example:
Implementation Notes: Fetches a bundle with the requested Task, instead of just the resource itself, and allows for the inclusion of additional search parameters such as _include, _revinclude, or _lastUpdated (how to search by id of the resource)
_lastUpdated search parameter
_include parameters: Task:focus, Task:owner, Task:patient, and Task:requestermultipleAndgt, lt, ge, leGET [base]/Task?_lastUpdated={gt|lt|ge|le}[date]{&_lastUpdated={gt|lt|ge|le}[date]&...}
Example:
Implementation Notes: Fetches a bundle matching the _lastUpdated date (how to search by date)
_lastUpdated and status and owner search parameters
_include parameters: Task:focus, Task:owner, Task:patient, and Task:requesterowner.identifier (e.g. owner.identifier=[system|][code])multipleOr search on statusmultipleAnd search on _lastUpdatedgt, lt, ge, le on _lastUpdatedGET [base]/Task?_lastUpdated={gt|lt|ge|le}[date]&status={system|}[code]&owner={Type/}[id] or optionally GET [base]/Task?_lastUpdated={gt|lt|ge|le}[date]&status={system|}[code]&owner.identifier=[system|][code]
Example:
Implementation Notes: Fetches a bundle containing Task resources matching the _lastUpdated date, owner and status (how to search by date, how to search by token, how to search by reference)
_tag search parameter
_include parameters: Task:focus, Task:owner, Task:patient, and Task:requesterGET [base]/Task?_tag=[system|][code]
Example:
Implementation Notes: Fetches a bundle containing Task resources matching the tag (how to search by token)
focus search parameter
_include parameters: Task:focus, Task:owner, Task:patient, and Task:requesterGET [base]/Task?focus={Type/}[id]
Example:
Implementation Notes: Fetches a bundle containing Task resources matching the focus (how to search by reference)
group-identifier search parameter
_include parameters: Task:focus, Task:owner, Task:patient, and Task:requesterGET [base]/Task?groupIdentifier={system|}{value}
Example:
Implementation Notes: Fetches a bundle containing Task resources matching the group identifier (how to search by token)
owner search parameter
_include parameters: Task:focus, Task:owner, Task:patient, and Task:requesterowner.identifier (e.g. owner.identifier=[system|][code])GET [base]/Task?owner={Type/}[id] or optionally GET [base]/Task?owner.identifier=[system|][code]
Example:
Implementation Notes: Fetches a bundle containing Task resources matching the owner (how to search by reference)
owner and status search parameters:
_include parameters: Task:focus, Task:owner, Task:patient, and Task:requesterowner.identifier (e.g. owner.identifier=[system|][code])multipleOr search on statusGET [base]/Task?owner={Type/}[id]&status={system|}[code]{,{system|}[code],...} or optionally GET [base]/Task?owner.identifier=[system|][code]&status={system|}[code]{,{system|}[code],...}
Example:
Implementation Notes: Fetches a bundle containing Task resources matching the owner and status (how to search by reference, how to search by token)
patient search parameter
_include parameters: Task:focus, Task:owner, Task:patient, and Task:requesterpatient.identifier (e.g. patient.identifier=[system|][code])GET [base]/Task?patient={Type/}[id] or optionally GET [base]/Task?patient.identifier=[system|][code]
Example:
Implementation Notes: Fetches a bundle containing Task resources matching the patient (how to search by reference)
patient and status search parameters
_include parameters: Task:focus, Task:owner, Task:patient, and Task:requesterpatient.identifier (e.g. patient.identifier=[system|][code])multipleOr search on statusGET [base]/Task?patient={Type/}[id]&status={system|}[code]{,{system|}[code],...} or optionally GET [base]/Task?patient.identifier=[system|][code]&status={system|}[code]{,{system|}[code],...}
Example:
Implementation Notes: Fetches a bundle containing Task resources matching the patient and status (how to search by reference, how to search by token)
requester search parameter
_include parameters: Task:focus, Task:owner, Task:patient, and Task:requesterrequester.identifier (e.g. requester.identifier=[system|][code])GET [base]/Task?requester={Type/}[id] or optionally GET [base]/Task?requester.identifier=[system|][code]
Example:
Implementation Notes: Fetches a bundle containing Task resources matching the requester (how to search by reference)
requester and status search parameters
_include parameters: Task:focus, Task:owner, Task:patient, and Task:requesterrequester.identifier (e.g. requester.identifier=[system|][code])multipleOr search on statusGET [base]/Task?requester={Type/}[id]&status={system|}[code]{,{system|}[code],...} or optionally GET [base]/Task?requester.identifier=[system|][code]&status={system|}[code]{,{system|}[code],...}
Example:
Implementation Notes: Fetches a bundle containing Task resources matching the requester and status (how to search by reference, how to search by token)
status search parameter
_include parameters: Task:focus, Task:owner, Task:patient, and Task:requestermultipleOrGET [base]/Task?status={system|}[code]{,{system|}[code],...}
Example:
Implementation Notes: Fetches a bundle containing Task resources matching the status (how to search by token)
IG © 2024 HL7 Australia. Package hl7.fhir.au.ereq#0.3.0-ci-build based on FHIR 4.0.1. Generated 2025-06-11
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change