AU eRequesting Implementation Guide
0.3.0-ci-build - CI Build Australia flag

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

Resource Profile: AU eRequesting Diagnostic Request ( Abstract )

Official URL: http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-diagnosticrequest Version: 0.3.0-ci-build
Standards status: Draft Maturity Level: 0 Computable Name: AUeRequestingDiagnosticRequest

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 diagnostic requests for a patient. It is based on the AU Base Diagnostic Request and identifies the additional constraints, extensions, vocabularies and value sets that SHALL be present in the ServiceRequest when conforming to this profile.

Input is requested on the appropriateness of allowing Missing Data or Suppressed Data for all elements. Please comment by raising HL7 Jira Issues.

Profile specific implementation guidance

  • This abstract profile provides a shared base that is common across requests for specific domains. It is not intended for direct implementation. Where a profile is defined for a specific domain that profile SHALL be used:
  • The provision of an insurance attribute describes a recommendation to be considered by the Filler and does not guarantee that this recommendation will be satisfied.

Usage:

Formal Views of Profile Content

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

This structure is derived from AUBaseDiagnosticRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest AUBaseDiagnosticRequest This is an abstract profile. Child profiles: AUeRequestingImagingRequest, AUeRequestingPathologyRequest
... extension 1..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:sexParameterForClinicalUse SO 0..1 (Complex) A context-specific sex parameter for clinical use
URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
ObligationsActor
SHALL:populate-if-known AU eRequesting Placer
SHALL:handle AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
.... 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.

ObligationsActor
SHALL:populate-if-known AU eRequesting Placer
SHALL:no-error AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
.... extension:displaySequence SO 1..1 integer AU eRequesting Display Sequence
URL: http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-displaysequence
ObligationsActor
SHALL:populate AU eRequesting Placer
SHALL:handle AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:handle AU eRequesting Patient
.... 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)
ObligationsActor
SHALL:populate-if-known AU eRequesting Placer
SHALL:handle AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
... identifier SO 0..* Identifier, AULocalOrderIdentifier Identifiers assigned to this order
ObligationsActor
SHALL:populate-if-known AU eRequesting Placer
SHALL:no-error AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
... requisition SO 1..1 AULocalOrderIdentifier Composite Request ID
ObligationsActor
SHALL:populate AU eRequesting Placer
SHALL:handle AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
.... 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 | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: AU eRequesting RequestStatus (required)
ObligationsActor
SHALL:populate AU eRequesting Placer
SHALL:handle AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
... intent SO 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Required Pattern: order
ObligationsActor
SHALL:populate AU eRequesting Placer
SHALL:no-error AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
... category SO 1..* CodeableConcept Classification of service
ObligationsActor
SHALL:populate AU eRequesting Placer
SHALL:handle AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
... priority SO 0..1 code routine | urgent | asap | stat
ObligationsActor
SHALL:populate-if-known AU eRequesting Placer
SHALL:handle AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
... code SO 1..1 CodeableConcept What is being requested/ordered
ObligationsActor
SHALL:populate AU eRequesting Placer
SHALL:handle AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
.... text 1..1 string Plain text representation of the concept
... 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.
ObligationsActor
SHALL:populate-if-known AU eRequesting Placer
SHALL:handle AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
.... quantityQuantity Quantity
.... quantityRange Range
... subject SO 1..1 Reference(AU Core Patient) Individual or Entity the service is ordered for
ObligationsActor
SHALL:populate AU eRequesting Placer
SHALL:handle AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
... encounter SO 1..1 Reference(AU Core Encounter) Encounter in which the request was created
ObligationsActor
SHALL:populate-if-known AU eRequesting Placer
SHALL:no-error AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
.... reference 1..1 string Literal reference, Relative, internal or absolute URL
... occurrence[x] SO 0..1 dateTime, Period, Timing 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.
ObligationsActor
SHALL:populate-if-known AU eRequesting Placer
SHALL:handle AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
... authoredOn SOC 1..1 dateTime Date request signed
au-ereq-srr-01: Date must include at least year, month, and day
ObligationsActor
SHALL:populate AU eRequesting Placer
SHALL:handle AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
... requester SO 1..1 Reference(AU Core PractitionerRole) Authorising individual, organisation or program (e.g. National Bowel Cancer Screening Program)
ObligationsActor
SHALL:populate AU eRequesting Placer
SHALL:handle AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
... reasonCode SO 0..* CodeableConcept Explanation/Justification for procedure or service
ObligationsActor
SHALL:populate-if-known AU eRequesting Placer
SHALL:no-error AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
... insurance SO 0..* Reference(AU eRequesting Coverage) Associated insurance coverage
ObligationsActor
SHALL:populate-if-known AU eRequesting Placer
SHALL:no-error AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
... Slices for supportingInfo 0..* Reference(Resource) Additional clinical information
Slice: Unordered, Open by profile:$this.resolve()
.... supportingInfo:pregnancyStatus SOC 0..1 Reference(Observation Pregnancy - Status (IPS)) Additional clinical information
au-ereq-srr-02: Pregnancy status must only be Pregnant
ObligationsActor
SHALL:populate-if-known AU eRequesting Placer
SHALL:handle AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
... bodySite SO 0..* CodeableConcept Location on Body
ObligationsActor
SHALL:populate-if-known AU eRequesting Placer
SHALL:handle AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
... note SO 0..* Annotation Comments
ObligationsActor
SHALL:populate-if-known AU eRequesting Placer
SHALL:handle AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ServiceRequest.statusrequiredAUeRequestingRequestStatus
http://terminology.hl7.org.au/ValueSet/au-erequesting-request-status
from this IG

Constraints

IdGradePath(s)DetailsRequirements
au-ereq-srr-01errorServiceRequest.authoredOnDate must include at least year, month, and day
: $this.toString().length() >= 10
au-ereq-srr-02errorServiceRequest.supportingInfo:pregnancyStatusPregnancy status must only be Pregnant
: $this.resolve().value.coding.where(system='http://snomed.info/sct').code = '77386006'

 

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 MAY MAY MAY token
requisition SHALL MAY MAY MAY 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

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: ServiceRequest:patient,ServiceRequest:requester,ServiceRequest:encounter

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

    Example:

    1. GET [base]/ServiceRequest?_id=2169591
    2. GET [base]/ServiceRequest?_id=2169591&_include=ServiceRequest:patient&_include=ServiceRequest:requester&_include=ServiceRequest:encounter

    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)

  2. requisition search parameter
    • including support for these _include parameters: ServiceRequest:patient,ServiceRequest:requester,ServiceRequest:encounter

    GET [base]/ServiceRequest?requisition={system|}{code}

    Example:

    1. GET [base]/ServiceRequest?requisition=EMC4542244-5624
    2. GET [base]/ServiceRequest?requisition=https://elimbahmedicalcentre.example.com.au/orders/order-identifier|EMC4542244-5624
    3. GET [base]/ServiceRequest?requisition=EMC4542244-5624&_include=ServiceRequest:patient&_include=ServiceRequest:requester&_include=ServiceRequest:encounter

    Implementation Notes: Fetches a bundle of all ServiceRequest resources for the specified requisition identifier (how to search by token)