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/hl7au/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.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Task
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Task |
0..* | Task | This is an abstract profile. Child profiles: AUeRequestingTaskDiagnosticRequest, AUeRequestingTaskGroup A task to be performed | |
  meta |
||||
   Slices for tag |
1..* | Coding | Tags applied to this resource Slice: Unordered, Open by value:$this | |
   tag:eRequestingFulfilmentTask |
1..1 | Coding | fulfilment-task | fulfilment-task-group Binding: AU eRequesting Fulfilment Task Tags (required) | |
 groupIdentifier |
S | 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 |
S | 1..1 | code | draft | requested | received | accepted | + Binding: AU eRequesting Task Status (required) |
| statusReason |
S | 0..1 | CodeableConcept | Reason for current status |
| intent |
S | 1..1 | code | unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option Fixed Value: order |
| priority |
S | 0..1 | code | routine | urgent | asap | stat |
 for |
S | 1..1 | Reference(AU Core Patient) | Beneficiary of the Task |
| authoredOn |
S | 1..1 | dateTime | Task Creation Date |
| lastModified |
S | 0..1 | dateTime | Task Last Modified Date |
| requester |
S | 1..1 | Reference(AU Core PractitionerRole) | Who is asking for task to be done |
| owner |
S | 0..1 | Reference(AU Core Organization) | Responsible individual |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Task.meta.tag:eRequestingFulfilmentTask | required | AUeRequestingFulfilmentTaskTagshttp://hl7.org.au/fhir/ereq/ValueSet/au-erequesting-fulfilment-task-tagsfrom this IG | |
| Task.status | required | AUeRequestingTaskStatushttp://terminology.hl7.org.au/ValueSet/au-erequesting-task-statusfrom this IG |
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 |
|
| _lastUpdated+status+owner | SHALL | MAY | MAY | MAY | date+token+reference |
|
| 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 |
|
| _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:requesterGET [base]/Task?_lastUpdated=[date]
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 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])GET [base]/Task?_lastUpdated=[date]&status={system|}{value}&owner={Type/}[id] or optionally GET [base]/Task?_lastUpdated=[date]&status={system|}{value}&owner.identifier=[system|][code]
Example:
Implementation Notes: Fetches a bundle containing Task resources matching the _lastUpdated, owner and status, 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 date, how to search by token, how to search by reference)
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])GET [base]/Task?owner={Type/}[id]&status={system|}{value} or optionally GET [base]/Task?owner.identifier=[system|][code]&status={system|}{value}
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])GET [base]/Task?patient={Type/}[id]&status={system|}{value} or optionally GET [base]/Task?patient.identifier=[system|][code]&status={system|}{value}
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])GET [base]/Task?requester={Type/}[id]&status={system|}{value} or optionally GET [base]/Task?requester.identifier=[system|][code]&status={system|}{value}
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:requesterGET [base]/Task?status={system|}{value}
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-04-03
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change