AU eRequesting Implementation Guide
0.3.0-preview - Preview
AU eRequesting Implementation Guide
0.3.0-preview - Preview
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
| Official URL: http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-servicerequest-path | Version: 0.3.0-preview | |||
| Standards status: Draft | Maturity Level: 0 | Computable Name: AUeRequestingPathologyRequest | ||
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 ServiceRequest resource that is used to record, search, and fetch information about pathology requests for a patient. It is based on the AU eRequesting Diagnostic Request and identifies the additional constraints, extensions, vocabularies and value sets that SHALL be present in the ServiceRequest when conforming to this profile.
ServiceRequest.code
ServiceRequest.code.text so that fillers can at least display the service requested, even if they do not recognise the code supplied.ServiceRequest.code:
While the current RCPA - SPIA Requesting Pathology Reference Set binding is preferred, it is intended that this binding will move to extensible in the future to ensure the consistent coding of eRequests. Subject to discussion with the Technical Design Group this could commence with a progressive move to extensible through stronger binding of identified subsets of the RCPA - SPIA Requesting Pathology Terminology Reference Set. National registries or exchange networks may make additional conformance requirements around support for nationally agreed value sets, even if this specification does not require their use.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
  ServiceRequest |
C | 0..* | AUeRequestingDiagnosticRequest | A pathology test request 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 prr-1: orderDetail SHALL only be present if code is present | ||||||||||||
  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 | ||||||||||||
 Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||||||||||
   extension:targetBodyStructure |
0..* | Reference(BodyStructure) | The target point for this procedure URL: http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||||||||||
| extension:sexParameterForClinicalUse |
SO | 0..1 | (Complex) | A context-specific sex parameter for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
| ||||||||||||
| extension:statusReason |
SO | 0..1 | CodeableConcept | Reason for current status URL: http://hl7.org/fhir/StructureDefinition/request-statusReason Binding Description (No ValueSet): (example): Codes identifying the reason for the current state of an event. ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
| ||||||||||||
| extension:displaySequence |
SO | 1..1 | integer | AU eRequesting Display Sequence URL: http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-displaysequence ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
| ||||||||||||
 extension:fastingPrecondition |
SO | 0..1 | CodeableConcept | AU eRequesting Fasting Precondition URL: http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-fastingprecondition Binding: Pathology Fasting Status  (required)ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
| ||||||||||||
 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 | ||||||||||||
 identifier |
SOΣ | 0..* | Identifier, AULocalOrderIdentifier | Identifiers assigned to this order ele-1: All FHIR elements must have a @value or children
| ||||||||||||
| requisition |
SOΣ | 1..1 | AULocalOrderIdentifier | Composite Request 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 |
?!SOΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: AU eRequesting RequestStatus (required) ele-1: All FHIR elements must have a @value or children
| ||||||||||||
| intent |
?!SOΣ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. ele-1: All FHIR elements must have a @value or children Required Pattern: order
| ||||||||||||
 Slices for category |
SOΣ | 1..* | CodeableConcept | Classification of service Slice: Unordered, Open by pattern:$this Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. ele-1: All FHIR elements must have a @value or children
| ||||||||||||
| category:path |
SOΣ | 1..1 | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following
| ||||||||||||
 coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||||||||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |||||||||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 108252007 | |||||||||||||
| priority |
SOΣ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. ele-1: All FHIR elements must have a @value or children
| ||||||||||||
| doNotPerform |
?!Σ | 0..1 | boolean | True if service/procedure should not be performed ele-1: All FHIR elements must have a @value or children | ||||||||||||
| code |
SOΣ | 1..1 | CodeableConcept | Refer to the Profile Specific Implementation Guidance on ServiceRequest.code Binding: RCPA - SPIA Requesting Pathology Terminology Reference Set (preferred)ele-1: All FHIR elements must have a @value or children
| ||||||||||||
| text |
Σ | 1..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children | ||||||||||||
 quantity[x] |
SOΣ | 0..1 | An informative value indicating the number of fulfilments requested. If not provided the quantity is 1. For Rule 3 Exemption, this value may be greater than 1; however, the server does not currently support tracking multiple fulfilments from a single order. ele-1: All FHIR elements must have a @value or children
| |||||||||||||
| quantityQuantity |
Quantity | |||||||||||||||
| quantityRange |
Range | |||||||||||||||
 subject |
SOΣ | 1..1 | Reference(AU Core Patient) | Individual or Entity the service is ordered for ele-1: All FHIR elements must have a @value or children
| ||||||||||||
| encounter |
SOΣ | 1..1 | Reference(AU Core Encounter) | Encounter in which the request was created ele-1: All FHIR elements must have a @value or children
| ||||||||||||
| reference |
ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children | ||||||||||||
| occurrence[x] |
SOΣ | 0..1 | This may be used to cover three needs: 1. A target date for the test to be performed. 2. A date range for the test to be performed (possible Rule 3 Exemption use). 3. A frequency for the test to be performed (more complex Rule 3 Exemption use). The server will not process this information which is informative only and there is no alignment to diagnostic service regulations or policy. ele-1: All FHIR elements must have a @value or children
| |||||||||||||
| occurrenceDateTime |
dateTime | |||||||||||||||
| occurrencePeriod |
Period | |||||||||||||||
| occurrenceTiming |
Timing | |||||||||||||||
| authoredOn |
SOΣC | 1..1 | dateTime | Date request signed ele-1: All FHIR elements must have a @value or children au-ereq-srr-01: Date must include at least year, month, and day
| ||||||||||||
| requester |
SOΣ | 1..1 | Reference(AU Core PractitionerRole) | Authorising individual, organisation or program (e.g. National Bowel Cancer Screening Program) ele-1: All FHIR elements must have a @value or children
| ||||||||||||
| reasonCode |
SOΣ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: Reason for Request (preferred)ele-1: All FHIR elements must have a @value or children
| ||||||||||||
| insurance |
SO | 0..* | Reference(AU eRequesting Coverage) | Associated insurance coverage ele-1: All FHIR elements must have a @value or children
| ||||||||||||
| Slices for supportingInfo |
0..* | Reference(Resource) | Additional clinical information Slice: Unordered, Open by profile:$this.resolve() ele-1: All FHIR elements must have a @value or children | |||||||||||||
| supportingInfo:pregnancyStatus |
SOC | 0..1 | Reference(Observation - Pregnancy: status) | Additional clinical information ele-1: All FHIR elements must have a @value or children au-ereq-srr-02: Pregnancy status must only be Pregnant
| ||||||||||||
| bodySite |
SOΣ | 0..* | CodeableConcept | Location on Body Binding: Body Site (preferred)ele-1: All FHIR elements must have a @value or children
| ||||||||||||
| note |
SO | 0..* | Annotation | Comments ele-1: All FHIR elements must have a @value or children
| ||||||||||||
| Documentation for this format | ||||||||||||||||
| Path | Conformance | ValueSet / Code | URI |
| ServiceRequest.requisition.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| ServiceRequest.requisition.type | required | OrderIdentifierTypehttp://terminology.hl7.org.au/ValueSet/order-identifier-type | |
| ServiceRequest.status | required | AUeRequestingRequestStatushttp://terminology.hl7.org.au/ValueSet/au-erequesting-request-statusfrom this IG | |
| ServiceRequest.intent | required | Pattern: orderhttp://hl7.org/fhir/ValueSet/request-intent|4.0.1from the FHIR Standard | |
| ServiceRequest.category | example | ServiceRequestCategoryCodeshttp://hl7.org/fhir/ValueSet/servicerequest-categoryfrom the FHIR Standard | |
| ServiceRequest.category:path | example | Pattern: SNOMED-CT Code 108252007http://hl7.org/fhir/ValueSet/servicerequest-categoryfrom the FHIR Standard | |
| ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1from the FHIR Standard | |
| ServiceRequest.code | preferred | spia-requesting-refset https://www.rcpa.edu.au/fhir/ValueSet/spia-requesting-refset-3 | |
| ServiceRequest.reasonCode | preferred | ReasonForRequest https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 | |
| ServiceRequest.bodySite | preferred | BodySite https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 |
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 | - | - | - | token |
|
| requisition | SHALL | - | - | - | token |
|
| _include=ServiceRequest:patient | SHALL | SHOULD | SHOULD | SHOULD | reference |
Modifies search results from a query using other search parameters by including the referenced focus resource |
| _include=ServiceRequest:requester | SHALL | SHOULD | SHOULD | SHOULD | reference |
Modifies search results from a query using other search parameters by including the referenced focus resource |
| _include=ServiceRequest:encounter | SHOULD | SHOULD | SHOULD | SHOULD | 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: ServiceRequest:patient,ServiceRequest:requester,ServiceRequest:encounterGET [base]/ServiceRequest?_id=[id]
Example:
Implementation Notes: Fetches a bundle with the requested ServiceRequest, 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)
requisition search parameter
_include parameters: ServiceRequest:patient,ServiceRequest:requester,ServiceRequest:encounterGET [base]/ServiceRequest?requisition={system|}{code}
Example:
Implementation Notes: Fetches a bundle of all ServiceRequest resources for the specified requisition identifier (how to search by token)
IG © 2025 HL7 Australia. Package hl7.fhir.au.ereq#0.3.0-preview based on FHIR 4.0.1. Generated 2025-03-12
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change