AU eRequesting Implementation Guide
0.3.0-preview - Preview Australia flag

This page is part of the AU eRequesting (v0.3.0-preview: QA Preview) based on FHIR (HL7® FHIR® Standard) R4. No current official version has been published yet. For a full list of available versions, see the Directory of published versions

Resource Profile: AU eRequesting Task Group

Official URL: http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-task-group Version: 0.3.0-preview
Standards status: Draft Maturity Level: 0 Computable Name: AUeRequestingTaskGroup

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 group of tasks that are part of the same fulfilment group. It is based on the AU eRequesting Task and identifies the additional constraints, extensions, vocabularies and value sets that SHALL be present when conforming to this profile.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Task C 0..* AUeRequestingTask A task to be performed
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
inv-1: Last modified date must be greater than or equal to authored-on date.
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... groupIdentifier SΣ 1..1 AULocalOrderIdentifier Requisition or grouper id
ele-1: All FHIR elements must have a @value or children
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
.... type Σ 1..1 CodeableConcept Coded identifier type for local order identifier
Binding: Order Identifier Type (required)
ele-1: All FHIR elements must have a @value or children
..... coding Σ 1..1 Coding Code defined by a terminology system
ele-1: All FHIR elements must have a @value or children

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
.... system Σ 1..1 uri System identifier namespace for the organisation that assigned the order identifier
ele-1: All FHIR elements must have a @value or children
Example General: http://www.acme.com/identifiers/patient
.... value Σ 1..1 string Order identifier
ele-1: All FHIR elements must have a @value or children
Example General: 123456
... status ?!SΣ 1..1 code draft | requested | received | accepted | +
Binding: AU eRequesting Task Status (required)
ele-1: All FHIR elements must have a @value or children
... statusReason SΣ 0..1 CodeableConcept Reason for current status
Binding Description (No ValueSet): (example): Codes to identify the reason for current status. These will typically be specific to a particular workflow.


ele-1: All FHIR elements must have a @value or children
... intent SΣ 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.


ele-1: All FHIR elements must have a @value or children
Fixed Value: order
... priority S 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): The task's priority.


ele-1: All FHIR elements must have a @value or children
... for SΣ 1..1 Reference(AU Core Patient) Beneficiary of the Task
ele-1: All FHIR elements must have a @value or children
... authoredOn SC 1..1 dateTime Task Creation Date
ele-1: All FHIR elements must have a @value or children
... lastModified SΣC 0..1 dateTime Task Last Modified Date
ele-1: All FHIR elements must have a @value or children
... requester SΣ 1..1 Reference(AU Core PractitionerRole) Who is asking for task to be done
ele-1: All FHIR elements must have a @value or children
... owner SΣ 0..1 Reference(AU Core Organization) Responsible individual
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Task.groupIdentifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Task.groupIdentifier.typerequiredOrderIdentifierType
http://terminology.hl7.org.au/ValueSet/order-identifier-type
Task.statusrequiredAUeRequestingTaskStatus
http://terminology.hl7.org.au/ValueSet/au-erequesting-task-status
from this IG
Task.statusReasonexample
Task.intentrequiredFixed Value: order
http://hl7.org/fhir/ValueSet/task-intent|4.0.1
from the FHIR Standard
Task.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
from the FHIR Standard

 

Other representations of profile: CSV, Excel, Schematron

Notes:

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 - - - token
_lastUpdated SHALL - - - date
_lastUpdated+status+owner SHALL - - - date+token+reference
focus SHALL - - - reference
group-identifier SHALL - - - token
owner SHALL - - - 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 - - - reference+token
patient SHALL - - - 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 - - - reference+token
requester SHALL - - - 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 - - - reference+token
status SHALL - - - token
_include=Task:focus SHALL - - - reference Modifies search results from a query using other search parameters by including the referenced focus resource
_include=Task:owner SHALL - - - reference Modifies search results from a query using other search parameters by including the referenced focus resource
_include=Task:patient SHALL - - - reference Modifies search results from a query using other search parameters by including the referenced focus resource
_include=Task:requester SHALL - - - reference Modifies search results from a query using other search parameters by including the referenced focus resource

Search Parameters:

The following search parameters and search parameter combinations are supported. Conformance obligations are detailed in the table above.

  1. _id search parameter
    • including support for these _include parameters: Task:focus, Task:owner, Task:patient, and Task:requester

    GET [base]/Task?_id=[id]

    Example:

    1. GET [base]/Task?_id=2169591
    2. GET [base]/Task?_id=2169591&_include=Task:patient&_include=Task:requester&_include=Task:owner&_include=Task:focus

    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)

  2. _lastUpdated search parameter
    • including support for these _include parameters: Task:focus, Task:owner, Task:patient, and Task:requester

    GET [base]/Task?_lastUpdated=[date]

    Example:

    1. GET [base]/Task?_lastUpdated=gt2010-10-01
    2. GET [base]/Task?_lastUpdated=gt2010-10-01&_include=Task:patient&_include=Task:requester&_include=Task:owner&_include=Task:focus

    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)

  3. Combined _lastUpdated_ and status and owner search parameters
    • including support for these _include parameters: Task:focus, Task:owner, Task:patient, and Task:requester
    • including support for chained searching of owner canonical identifier owner.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:

    1. GET [base]/Task?_lastUpdated=gt2010-10-01&status=completed&owner=https://elimbahmedicalcentre.example.com.au/orders/practitioner-identifier|EMC1234567-1234
    2. GET [base]/Task?_lastUpdated=gt2010-10-01&status=completed&owner.identifier=http://ns.electronichealth.net.au/id/hi/hpio/1.0|8003621566684455
    3. GET [base]/Task?_lastUpdated=gt2010-10-01&status=completed&owner=https://elimbahmedicalcentre.example.com.au/orders/practitioner-identifier|EMC1234567-1234&_include=Task:patient&_include=Task:requester&_include=Task:owner&_include=Task:focus

    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)

  4. focus search parameter
    • including support for these _include parameters: Task:focus, Task:owner, Task:patient, and Task:requester

    GET [base]/Task?focus={Type/}[id]

    Example:

    1. GET [base]/Task?focus=AUeRequestingDiagnosticRequest/1234
    2. GET [base]/Task?focus=AUeRequestingDiagnosticRequest/1234&_include=Task:patient&_include=Task:requester&_include=Task:owner&_include=Task:focus

    Implementation Notes: Fetches a bundle containing Task resources matching the focus (how to search by reference)

  5. group-identifier search parameter
    • including support for these _include parameters: Task:focus, Task:owner, Task:patient, and Task:requester

    GET [base]/Task?groupIdentifier={system|}{value}

    Example:

    1. GET [base]/Task?groupIdentifier=https://elimbahmedicalcentre.example.com.au/orders/task-identifier|EMC1234567-1234
    2. GET [base]/Task?groupIdentifier=https://elimbahmedicalcentre.example.com.au/orders/task-identifier|EMC1234567-1234&_include=Task:patient&_include=Task:requester&_include=Task:owner&_include=Task:focus

    Implementation Notes: Fetches a bundle containing Task resources matching the group identifier (how to search by token)

  6. owner search parameter
    • including support for these _include parameters: Task:focus, Task:owner, Task:patient, and Task:requester
    • including support for chained searching of owner canonical identifier owner.identifier (e.g. owner.identifier=[system|][code])

    GET [base]/Task?owner={Type/}[id] or optionally GET [base]/Task?owner.identifier=[system|][code]

    Example:

    1. GET [base]/Task?owner=5678
    2. GET [base]/Task?owner.identifier=http://ns.electronichealth.net.au/id/hi/hpio/1.0|8003621566684455
    3. GET [base]/Task?owner=5678&_include=Task:patient&_include=Task:requester&_include=Task:owner&_include=Task:focus

    Implementation Notes: Fetches a bundle containing Task resources matching the owner (how to search by reference)

  7. Combined owner and status search parameters:
    • including support for these _include parameters: Task:focus, Task:owner, Task:patient, and Task:requester
    • including support for chained searching of owner canonical identifier owner.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:

    1. GET [base]/Task?owner=5678&status=completed
    2. GET [base]/Task?owner.identifier=http://ns.electronichealth.net.au/id/hi/hpio/1.0|8003621566684455&status=completed
    3. GET [base]/Task?owner=5678&status=completed&_include=Task:patient&_include=Task:requester&_include=Task:owner&_include=Task:focus

    Implementation Notes: Fetches a bundle containing Task resources matching the owner and status (how to search by reference, how to search by token)

  8. patient search parameter
    • including support for these _include parameters: Task:focus, Task:owner, Task:patient, and Task:requester
    • including support for chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code])

    GET [base]/Task?patient={Type/}[id] or optionally GET [base]/Task?patient.identifier=[system|][code]

    Example:

    1. GET [base]/Task?patient=5678
    2. GET [base]/Task?patient.identifier=http://ns.electronichealth.net.au/id/medicare-number|32788511952
    3. GET [base]/Task?patient=5678&_include=Task:patient&_include=Task:requester&_include=Task:owner&_include=Task:focus

    Implementation Notes: Fetches a bundle containing Task resources matching the patient (how to search by reference)

  9. Combined patient and status search parameters
    • including support for these _include parameters: Task:focus, Task:owner, Task:patient, and Task:requester
    • including support for chained searching of patient canonical identifier patient.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:

    1. GET [base]/Task?patient=5678&status=completed
    2. GET [base]/Task?patient.identifier=http://ns.electronichealth.net.au/id/medicare-number|32788511952&status=completed
    3. GET [base]/Task?patient=5678&status=completed&_include=Task:patient&_include=Task:requester&_include=Task:owner&_include=Task:focus

    Implementation Notes: Fetches a bundle containing Task resources matching the patient and status (how to search by reference, how to search by token)

  10. requester search parameter
    • including support for these _include parameters: Task:focus, Task:owner, Task:patient, and Task:requester
    • including support for chained searching of requester canonical identifier requester.identifier (e.g. requester.identifier=[system|][code])

    GET [base]/Task?requester={Type/}[id] or optionally GET [base]/Task?requester.identifier=[system|][code]

    Example:

    1. GET [base]/Task?requester=5678
    2. GET [base]/Task?requester.identifier=http://ns.electronichealth.net.au/id/medicare-provider-number|553255
    3. GET [base]/Task?requester=5678&_include=Task:patient&_include=Task:requester&_include=Task:owner&_include=Task:focus

    Implementation Notes: Fetches a bundle containing Task resources matching the requester (how to search by reference)

  11. Combined requester and status search parameters
    • including support for these _include parameters: Task:focus, Task:owner, Task:patient, and Task:requester
    • including support for chained searching of requester canonical identifier requester.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:

    1. GET [base]/Task?requester=5678&status=completed
    2. GET [base]/Task?requester.identifier=http://ns.electronichealth.net.au/id/medicare-provider-number|553255&status=completed
    3. GET [base]/Task?requester=5678&status=completed&_include=Task:patient&_include=Task:requester&_include=Task:owner&_include=Task:focus

    Implementation Notes: Fetches a bundle containing Task resources matching the requester and status (how to search by reference, how to search by token)

  12. status search parameter
    • including support for these _include parameters: Task:focus, Task:owner, Task:patient, and Task:requester

    GET [base]/Task?status={system|}{value}

    Example:

    1. GET [base]/Task?status=completed
    2. GET [base]/Task?status=completed&_include=Task:patient&_include=Task:requester&_include=Task:owner&_include=Task:focus

    Implementation Notes: Fetches a bundle containing Task resources matching the status (how to search by token)