AU eRequesting Implementation Guide
0.3.0-preview - Preview

Publication Build: This will be filled in by the publication tooling

## Resource Profile: AU eRequesting Diagnostic Request ( Abstract )

Official URL: http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-diagnosticrequest | Version: 0.3.0-preview
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:
  - pathology requests SHALL use AU eRequesting Pathology Request profile
  - imaging requests SHALL use AU eRequesting Imaging Request profile
- 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:

- Derived from this Resource Profile: AU eRequesting Imaging Request and AU eRequesting Pathology Request

### Formal Views of Profile Content

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

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
ServiceRequest | C | 0..* | AUBaseDiagnosticRequest | This is an abstract profile. Child profiles: AUeRequestingImagingRequest, AUeRequestingPathologyRequest Deprecated: A diagnostic service request in an Australian healthcare context 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
Obligations | Actor
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. ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Obligations | Actor
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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Obligations | Actor
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) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Obligations | Actor
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
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
Obligations | Actor
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 ele-1: All FHIR elements must have a @value or children
Obligations | Actor
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
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
Obligations | Actor
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 Binding: RequestIntent (required): The kind of service request. ele-1: All FHIR elements must have a @value or children Required Pattern: order
Obligations | Actor
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 Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. ele-1: All FHIR elements must have a @value or children
Obligations | Actor
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 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
Obligations | Actor
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
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 | What is being requested/ordered Binding: Evaluation Procedure (example) ele-1: All FHIR elements must have a @value or children
Obligations | Actor
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 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
Obligations | Actor
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 ele-1: All FHIR elements must have a @value or children
Obligations | Actor
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 ele-1: All FHIR elements must have a @value or children
Obligations | Actor
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 | Σ 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
Obligations | Actor
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
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
Obligations | Actor
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) ele-1: All FHIR elements must have a @value or children
Obligations | Actor
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 Binding: Reason for Request (preferred) ele-1: All FHIR elements must have a @value or children
Obligations | Actor
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 ele-1: All FHIR elements must have a @value or children
Obligations | Actor
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() ele-1: All FHIR elements must have a @value or children
supportingInfo:pregnancyStatus | SO C | 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
Obligations | Actor
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 Binding: Body Site (preferred) ele-1: All FHIR elements must have a @value or children
Obligations | Actor
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 ele-1: All FHIR elements must have a @value or children
Obligations | Actor
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
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
ServiceRequest.requisition.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
ServiceRequest.requisition.type | required | OrderIdentifierType `http://terminology.hl7.org.au/ValueSet/order-identifier-type`
ServiceRequest.status | required | AUeRequestingRequestStatus `http://terminology.hl7.org.au/ValueSet/au-erequesting-request-status` from this IG
ServiceRequest.intent | required | Pattern: order `http://hl7.org/fhir/ValueSet/request-intent|4.0.1` from the FHIR Standard
ServiceRequest.category | example | ServiceRequestCategoryCodes `http://hl7.org/fhir/ValueSet/servicerequest-category` from the FHIR Standard
ServiceRequest.priority | required | RequestPriority `http://hl7.org/fhir/ValueSet/request-priority|4.0.1` from the FHIR Standard
ServiceRequest.code | example | EvaluationProcedure `https://healthterminologies.gov.au/fhir/ValueSet/evaluation-procedure-1` from https://tx.ontoserver.csiro.au/fhir
ServiceRequest.reasonCode | preferred | ReasonForRequest `https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1` from https://tx.ontoserver.csiro.au/fhir
ServiceRequest.bodySite | preferred | BodySite `https://healthterminologies.gov.au/fhir/ValueSet/body-site-1` from https://tx.ontoserver.csiro.au/fhir

#### Constraints

Id | Grade | Path(s) | Details | Requirements
au-ereq-srr-01 | error | ServiceRequest.authoredOn | Date must include at least year, month, and day : $this.toString().length() >= 10 |
au-ereq-srr-02 | error | ServiceRequest.supportingInfo:pregnancyStatus | Pregnancy status must only be Pregnant : $this.resolve().value.coding.where(system='http://snomed.info/sct').code = '77386006' |

This structure is derived from AUBaseDiagnosticRequest

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
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
Obligations | Actor
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.
Obligations | Actor
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
Obligations | Actor
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)
Obligations | Actor
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
Obligations | Actor
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
Obligations | Actor
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)
Obligations | Actor
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
Obligations | Actor
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
Obligations | Actor
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
Obligations | Actor
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
Obligations | Actor
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.
Obligations | Actor
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
Obligations | Actor
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
Obligations | Actor
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.
Obligations | Actor
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 | SO C | 1..1 | dateTime | Date request signed au-ereq-srr-01: Date must include at least year, month, and day
Obligations | Actor
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)
Obligations | Actor
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
Obligations | Actor
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
Obligations | Actor
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 | SO C | 0..1 | Reference(Observation - Pregnancy: status) | Additional clinical information au-ereq-srr-02: Pregnancy status must only be Pregnant
Obligations | Actor
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
Obligations | Actor
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
Obligations | Actor
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
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
ServiceRequest.status | required | AUeRequestingRequestStatus `http://terminology.hl7.org.au/ValueSet/au-erequesting-request-status` from this IG

#### Constraints

Id | Grade | Path(s) | Details | Requirements
au-ereq-srr-01 | error | ServiceRequest.authoredOn | Date must include at least year, month, and day : $this.toString().length() >= 10 |
au-ereq-srr-02 | error | ServiceRequest.supportingInfo:pregnancyStatus | Pregnancy status must only be Pregnant : $this.resolve().value.coding.where(system='http://snomed.info/sct').code = '77386006' |

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
ServiceRequest | C | 0..* | AUBaseDiagnosticRequest | This is an abstract profile. Child profiles: AUeRequestingImagingRequest, AUeRequestingPathologyRequest Deprecated: A diagnostic service request in an Australian healthcare context prr-1: orderDetail SHALL only be present if code is present
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
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.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
extension:targetBodyStructure |  | 0..* | Reference(BodyStructure) | The target point for this procedure URL: http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure
extension:sexParameterForClinicalUse | SO | 0..1 | (Complex) | A context-specific sex parameter for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
Obligations | Actor
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.
Obligations | Actor
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
Obligations | Actor
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)
Obligations | Actor
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
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | SO Σ | 0..* | Identifier, AULocalOrderIdentifier | Identifiers assigned to this order
Obligations | Actor
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
instantiatesCanonical | Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition
instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition
basedOn | Σ | 0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) | What request fulfills
replaces | Σ | 0..* | Reference(ServiceRequest) | What request replaces
requisition | SO Σ | 1..1 | AULocalOrderIdentifier | Composite Request ID
Obligations | Actor
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
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
status | ?!SO Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: AU eRequesting RequestStatus (required)
Obligations | Actor
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 Binding: RequestIntent (required): The kind of service request. Required Pattern: order
Obligations | Actor
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 Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.
Obligations | Actor
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 Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
Obligations | Actor
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
doNotPerform | ?!Σ | 0..1 | boolean | True if service/procedure should not be performed
code | SO Σ | 1..1 | CodeableConcept | What is being requested/ordered Binding: Evaluation Procedure (example)
Obligations | Actor
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
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 | Σ | 0..* | Coding | Code defined by a terminology system
text | Σ | 1..1 | string | Plain text representation of the concept
orderDetail | Σ C | 0..* | CodeableConcept | Additional order information Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context.
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.
Obligations | Actor
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
Obligations | Actor
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
Obligations | Actor
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
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 | 1..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 | Σ | 0..1 | string | Text alternative for the resource
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.
Obligations | Actor
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
occurrenceDateTime |  |  | dateTime |
occurrencePeriod |  |  | Period |
occurrenceTiming |  |  | Timing |
asNeeded[x] | Σ | 0..1 |  | Preconditions for service Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc.
asNeededBoolean |  |  | boolean |
asNeededCodeableConcept |  |  | CodeableConcept |
authoredOn | SO Σ C | 1..1 | dateTime | Date request signed au-ereq-srr-01: Date must include at least year, month, and day
Obligations | Actor
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)
Obligations | Actor
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
performerType | Σ | 0..1 | CodeableConcept | Performer role Binding: Practitioner Role (preferred)
performer | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested performer
locationCode | Σ | 0..* | CodeableConcept | Requested location Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered.
locationReference | Σ | 0..* | Reference(Location) | Requested location
reasonCode | SO Σ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: Reason for Request (preferred)
Obligations | Actor
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
reasonReference | Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service
insurance | SO | 0..* | Reference(AU eRequesting Coverage) | Associated insurance coverage
Obligations | Actor
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 | SO C | 0..1 | Reference(Observation - Pregnancy: status) | Additional clinical information au-ereq-srr-02: Pregnancy status must only be Pregnant
Obligations | Actor
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
specimen | Σ | 0..* | Reference(AU Base Specimen) | Procedure Samples
bodySite | SO Σ | 0..* | CodeableConcept | Location on Body Binding: Body Site (preferred)
Obligations | Actor
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
Obligations | Actor
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
patientInstruction | Σ | 0..1 | string | Patient or consumer-oriented instructions
relevantHistory |  | 0..* | Reference(Provenance) | Request provenance
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
ServiceRequest.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
ServiceRequest.requisition.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
ServiceRequest.requisition.type | required | OrderIdentifierType `http://terminology.hl7.org.au/ValueSet/order-identifier-type`
ServiceRequest.requisition.assigner.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
ServiceRequest.status | required | AUeRequestingRequestStatus `http://terminology.hl7.org.au/ValueSet/au-erequesting-request-status` from this IG
ServiceRequest.intent | required | Pattern: order `http://hl7.org/fhir/ValueSet/request-intent|4.0.1` from the FHIR Standard
ServiceRequest.category | example | ServiceRequestCategoryCodes `http://hl7.org/fhir/ValueSet/servicerequest-category` from the FHIR Standard
ServiceRequest.priority | required | RequestPriority `http://hl7.org/fhir/ValueSet/request-priority|4.0.1` from the FHIR Standard
ServiceRequest.code | example | EvaluationProcedure `https://healthterminologies.gov.au/fhir/ValueSet/evaluation-procedure-1` from https://tx.ontoserver.csiro.au/fhir
ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodes `http://hl7.org/fhir/ValueSet/servicerequest-orderdetail` from the FHIR Standard
ServiceRequest.encounter.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodes `http://hl7.org/fhir/ValueSet/medication-as-needed-reason` from the FHIR Standard
ServiceRequest.performerType | preferred | PractitionerRole `https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1` from https://tx.ontoserver.csiro.au/fhir
ServiceRequest.locationCode | example | ServiceDeliveryLocationRoleType `http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType`
ServiceRequest.reasonCode | preferred | ReasonForRequest `https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1` from https://tx.ontoserver.csiro.au/fhir
ServiceRequest.bodySite | preferred | BodySite `https://healthterminologies.gov.au/fhir/ValueSet/body-site-1` from https://tx.ontoserver.csiro.au/fhir

#### Constraints

Id | Grade | Path(s) | Details | Requirements
au-ereq-srr-01 | error | ServiceRequest.authoredOn | Date must include at least year, month, and day : $this.toString().length() >= 10 |
au-ereq-srr-02 | error | ServiceRequest.supportingInfo:pregnancyStatus | Pregnancy status must only be Pregnant : $this.resolve().value.coding.where(system='http://snomed.info/sct').code = '77386006' |

This structure is derived from AUBaseDiagnosticRequest

Summary

Mandatory: 11 elements
Must-Support: 22 elements

Structures

This structure refers to these other structures:

- AU Local Order Identifier (http://hl7.org.au/fhir/StructureDefinition/au-localorderidentifier)
- AU Core Patient (http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient)
- AU Core Encounter (http://hl7.org.au/fhir/core/StructureDefinition/au-core-encounter)
- AU Core PractitionerRole (http://hl7.org.au/fhir/core/StructureDefinition/au-core-practitionerrole)
- AU eRequesting Coverage (http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-coverage)
- Observation - Pregnancy: status (http://hl7.org/fhir/uv/ips/StructureDefinition/Observation-pregnancy-status-uv-ips)

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
- http://hl7.org/fhir/StructureDefinition/request-statusReason
- http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-displaysequence
- http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-fastingprecondition

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of ServiceRequest.supportingInfo

Maturity: 0

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
ServiceRequest | C | 0..* | AUBaseDiagnosticRequest | This is an abstract profile. Child profiles: AUeRequestingImagingRequest, AUeRequestingPathologyRequest Deprecated: A diagnostic service request in an Australian healthcare context 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
Obligations | Actor
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. ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Obligations | Actor
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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Obligations | Actor
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) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Obligations | Actor
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
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
Obligations | Actor
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 ele-1: All FHIR elements must have a @value or children
Obligations | Actor
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
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
Obligations | Actor
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 Binding: RequestIntent (required): The kind of service request. ele-1: All FHIR elements must have a @value or children Required Pattern: order
Obligations | Actor
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 Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. ele-1: All FHIR elements must have a @value or children
Obligations | Actor
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 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
Obligations | Actor
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
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 | What is being requested/ordered Binding: Evaluation Procedure (example) ele-1: All FHIR elements must have a @value or children
Obligations | Actor
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 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
Obligations | Actor
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 ele-1: All FHIR elements must have a @value or children
Obligations | Actor
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 ele-1: All FHIR elements must have a @value or children
Obligations | Actor
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 | Σ 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
Obligations | Actor
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
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
Obligations | Actor
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) ele-1: All FHIR elements must have a @value or children
Obligations | Actor
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 Binding: Reason for Request (preferred) ele-1: All FHIR elements must have a @value or children
Obligations | Actor
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 ele-1: All FHIR elements must have a @value or children
Obligations | Actor
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() ele-1: All FHIR elements must have a @value or children
supportingInfo:pregnancyStatus | SO C | 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
Obligations | Actor
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 Binding: Body Site (preferred) ele-1: All FHIR elements must have a @value or children
Obligations | Actor
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 ele-1: All FHIR elements must have a @value or children
Obligations | Actor
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
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
ServiceRequest.requisition.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
ServiceRequest.requisition.type | required | OrderIdentifierType `http://terminology.hl7.org.au/ValueSet/order-identifier-type`
ServiceRequest.status | required | AUeRequestingRequestStatus `http://terminology.hl7.org.au/ValueSet/au-erequesting-request-status` from this IG
ServiceRequest.intent | required | Pattern: order `http://hl7.org/fhir/ValueSet/request-intent|4.0.1` from the FHIR Standard
ServiceRequest.category | example | ServiceRequestCategoryCodes `http://hl7.org/fhir/ValueSet/servicerequest-category` from the FHIR Standard
ServiceRequest.priority | required | RequestPriority `http://hl7.org/fhir/ValueSet/request-priority|4.0.1` from the FHIR Standard
ServiceRequest.code | example | EvaluationProcedure `https://healthterminologies.gov.au/fhir/ValueSet/evaluation-procedure-1` from https://tx.ontoserver.csiro.au/fhir
ServiceRequest.reasonCode | preferred | ReasonForRequest `https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1` from https://tx.ontoserver.csiro.au/fhir
ServiceRequest.bodySite | preferred | BodySite `https://healthterminologies.gov.au/fhir/ValueSet/body-site-1` from https://tx.ontoserver.csiro.au/fhir

#### Constraints

Id | Grade | Path(s) | Details | Requirements
au-ereq-srr-01 | error | ServiceRequest.authoredOn | Date must include at least year, month, and day : $this.toString().length() >= 10 |
au-ereq-srr-02 | error | ServiceRequest.supportingInfo:pregnancyStatus | Pregnancy status must only be Pregnant : $this.resolve().value.coding.where(system='http://snomed.info/sct').code = '77386006' |

Differential View

This structure is derived from AUBaseDiagnosticRequest

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
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
Obligations | Actor
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.
Obligations | Actor
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
Obligations | Actor
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)
Obligations | Actor
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
Obligations | Actor
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
Obligations | Actor
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)
Obligations | Actor
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
Obligations | Actor
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
Obligations | Actor
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
Obligations | Actor
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
Obligations | Actor
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.
Obligations | Actor
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
Obligations | Actor
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
Obligations | Actor
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.
Obligations | Actor
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 | SO C | 1..1 | dateTime | Date request signed au-ereq-srr-01: Date must include at least year, month, and day
Obligations | Actor
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)
Obligations | Actor
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
Obligations | Actor
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
Obligations | Actor
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 | SO C | 0..1 | Reference(Observation - Pregnancy: status) | Additional clinical information au-ereq-srr-02: Pregnancy status must only be Pregnant
Obligations | Actor
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
Obligations | Actor
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
Obligations | Actor
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
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
ServiceRequest.status | required | AUeRequestingRequestStatus `http://terminology.hl7.org.au/ValueSet/au-erequesting-request-status` from this IG

#### Constraints

Id | Grade | Path(s) | Details | Requirements
au-ereq-srr-01 | error | ServiceRequest.authoredOn | Date must include at least year, month, and day : $this.toString().length() >= 10 |
au-ereq-srr-02 | error | ServiceRequest.supportingInfo:pregnancyStatus | Pregnancy status must only be Pregnant : $this.resolve().value.coding.where(system='http://snomed.info/sct').code = '77386006' |

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
ServiceRequest | C | 0..* | AUBaseDiagnosticRequest | This is an abstract profile. Child profiles: AUeRequestingImagingRequest, AUeRequestingPathologyRequest Deprecated: A diagnostic service request in an Australian healthcare context prr-1: orderDetail SHALL only be present if code is present
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
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.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
extension:targetBodyStructure |  | 0..* | Reference(BodyStructure) | The target point for this procedure URL: http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure
extension:sexParameterForClinicalUse | SO | 0..1 | (Complex) | A context-specific sex parameter for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
Obligations | Actor
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.
Obligations | Actor
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
Obligations | Actor
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)
Obligations | Actor
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
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier | SO Σ | 0..* | Identifier, AULocalOrderIdentifier | Identifiers assigned to this order
Obligations | Actor
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
instantiatesCanonical | Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition
instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition
basedOn | Σ | 0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) | What request fulfills
replaces | Σ | 0..* | Reference(ServiceRequest) | What request replaces
requisition | SO Σ | 1..1 | AULocalOrderIdentifier | Composite Request ID
Obligations | Actor
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
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
status | ?!SO Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: AU eRequesting RequestStatus (required)
Obligations | Actor
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 Binding: RequestIntent (required): The kind of service request. Required Pattern: order
Obligations | Actor
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 Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.
Obligations | Actor
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 Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
Obligations | Actor
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
doNotPerform | ?!Σ | 0..1 | boolean | True if service/procedure should not be performed
code | SO Σ | 1..1 | CodeableConcept | What is being requested/ordered Binding: Evaluation Procedure (example)
Obligations | Actor
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
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 | Σ | 0..* | Coding | Code defined by a terminology system
text | Σ | 1..1 | string | Plain text representation of the concept
orderDetail | Σ C | 0..* | CodeableConcept | Additional order information Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context.
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.
Obligations | Actor
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
Obligations | Actor
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
Obligations | Actor
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
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 | 1..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 | Σ | 0..1 | string | Text alternative for the resource
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.
Obligations | Actor
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
occurrenceDateTime |  |  | dateTime |
occurrencePeriod |  |  | Period |
occurrenceTiming |  |  | Timing |
asNeeded[x] | Σ | 0..1 |  | Preconditions for service Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc.
asNeededBoolean |  |  | boolean |
asNeededCodeableConcept |  |  | CodeableConcept |
authoredOn | SO Σ C | 1..1 | dateTime | Date request signed au-ereq-srr-01: Date must include at least year, month, and day
Obligations | Actor
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)
Obligations | Actor
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
performerType | Σ | 0..1 | CodeableConcept | Performer role Binding: Practitioner Role (preferred)
performer | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested performer
locationCode | Σ | 0..* | CodeableConcept | Requested location Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered.
locationReference | Σ | 0..* | Reference(Location) | Requested location
reasonCode | SO Σ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: Reason for Request (preferred)
Obligations | Actor
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
reasonReference | Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service
insurance | SO | 0..* | Reference(AU eRequesting Coverage) | Associated insurance coverage
Obligations | Actor
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 | SO C | 0..1 | Reference(Observation - Pregnancy: status) | Additional clinical information au-ereq-srr-02: Pregnancy status must only be Pregnant
Obligations | Actor
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
specimen | Σ | 0..* | Reference(AU Base Specimen) | Procedure Samples
bodySite | SO Σ | 0..* | CodeableConcept | Location on Body Binding: Body Site (preferred)
Obligations | Actor
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
Obligations | Actor
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
patientInstruction | Σ | 0..1 | string | Patient or consumer-oriented instructions
relevantHistory |  | 0..* | Reference(Provenance) | Request provenance
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
ServiceRequest.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` from the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
ServiceRequest.requisition.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
ServiceRequest.requisition.type | required | OrderIdentifierType `http://terminology.hl7.org.au/ValueSet/order-identifier-type`
ServiceRequest.requisition.assigner.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
ServiceRequest.status | required | AUeRequestingRequestStatus `http://terminology.hl7.org.au/ValueSet/au-erequesting-request-status` from this IG
ServiceRequest.intent | required | Pattern: order `http://hl7.org/fhir/ValueSet/request-intent|4.0.1` from the FHIR Standard
ServiceRequest.category | example | ServiceRequestCategoryCodes `http://hl7.org/fhir/ValueSet/servicerequest-category` from the FHIR Standard
ServiceRequest.priority | required | RequestPriority `http://hl7.org/fhir/ValueSet/request-priority|4.0.1` from the FHIR Standard
ServiceRequest.code | example | EvaluationProcedure `https://healthterminologies.gov.au/fhir/ValueSet/evaluation-procedure-1` from https://tx.ontoserver.csiro.au/fhir
ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodes `http://hl7.org/fhir/ValueSet/servicerequest-orderdetail` from the FHIR Standard
ServiceRequest.encounter.type | extensible | ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard
ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodes `http://hl7.org/fhir/ValueSet/medication-as-needed-reason` from the FHIR Standard
ServiceRequest.performerType | preferred | PractitionerRole `https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1` from https://tx.ontoserver.csiro.au/fhir
ServiceRequest.locationCode | example | ServiceDeliveryLocationRoleType `http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType`
ServiceRequest.reasonCode | preferred | ReasonForRequest `https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1` from https://tx.ontoserver.csiro.au/fhir
ServiceRequest.bodySite | preferred | BodySite `https://healthterminologies.gov.au/fhir/ValueSet/body-site-1` from https://tx.ontoserver.csiro.au/fhir

#### Constraints

Id | Grade | Path(s) | Details | Requirements
au-ereq-srr-01 | error | ServiceRequest.authoredOn | Date must include at least year, month, and day : $this.toString().length() >= 10 |
au-ereq-srr-02 | error | ServiceRequest.supportingInfo:pregnancyStatus | Pregnancy status must only be Pregnant : $this.resolve().value.coding.where(system='http://snomed.info/sct').code = '77386006' |

This structure is derived from AUBaseDiagnosticRequest

Summary

Mandatory: 11 elements
Must-Support: 22 elements

Structures

This structure refers to these other structures:

- AU Local Order Identifier (http://hl7.org.au/fhir/StructureDefinition/au-localorderidentifier)
- AU Core Patient (http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient)
- AU Core Encounter (http://hl7.org.au/fhir/core/StructureDefinition/au-core-encounter)
- AU Core PractitionerRole (http://hl7.org.au/fhir/core/StructureDefinition/au-core-practitionerrole)
- AU eRequesting Coverage (http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-coverage)
- Observation - Pregnancy: status (http://hl7.org/fhir/uv/ips/StructureDefinition/Observation-pregnancy-status-uv-ips)

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
- http://hl7.org/fhir/StructureDefinition/request-statusReason
- http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-displaysequence
- http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-fastingprecondition

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of ServiceRequest.supportingInfo

Maturity: 0

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` |
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

#### 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)