AU eRequesting Implementation Guide
1.0.0-preview - Preview

AU eRequesting Implementation Guide - Downloaded Version 1.0.0-preview See the Directory of published versions

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

Official URL: http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-diagnosticrequest | Version: 1.0.0-preview
Standards status: Draft | Maturity Level: 1 | 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 ServiceRequest profile and identifies the additional constraints, extensions, vocabularies and value sets that SHALL be present in the ServiceRequest resource when conforming to this profile.

### 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
- This profile supports the sex and gender related concept of Sex Parameter for Clinical Use:
  - When exchanging concepts of sex or gender, refer to the guidance in Sex and Gender and the Gender Harmony Implementation Guide.
- See guidance on the construction of identifiers in each Identifier profile and the section on Business Identifiers in AU Base.
- Refer to the AU eRequesting Workflow Guidance page for guidance on managing workflow states in AU eRequesting.
- See the Diagnostic Request Grouping section for guidance on grouping diagnostic requests in AU eRequesting.
- 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.
- `ServiceRequest.encounter` and `ServiceRequest.encounter.reference` are mandatory to support `Encounter.class`, which classifies the patient encounter and is required by the filler for billing purposes.
- `ServiceRequest.occurenceTiming.repeat.count` can be used to specify the number of diagnostic requests to be performed.
- Resources referenced by `ServiceRequest.supportingInfo` can be referenced by all ServiceRequests in a group when the information applies across the group, or by individual ServiceRequests when the information is specific to particular requests.
  - Use `ServiceRequest.supportingInfo:pregnancyStatus` to record pregnancy, with the permitted value of Pregnant, only when it applies to the request.
  - Use `ServiceRequest.supportingInfo:clinicalContext` to supply text narrative that provides the broader clinical background or circumstances related to the request.
- Use `ServiceRequest.note` to record general comments or administrative notes about the request.
  - Information recorded in `ServiceRequest.note` SHALL NOT duplicate or overlap with clinical context captured in `ServiceRequest.supportingInfo:clinicalContext`, or with any other information recorded in the ServiceRequest.

Usages:

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

You can also check for usages in the FHIR IG Statistics

Changes since version 1.0.0-ballot:

- The resource metadata has changed (description)
- The data elements list has changed
- One or more text definitions, invariants or bindings have changed

### 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 Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
ServiceRequest | C | 0..* | AUBaseServiceRequest | This is an abstract profile. Child profiles: AUeRequestingImagingRequest, AUeRequestingPathologyRequest A service request in an Australian healthcare context Constraints: prr-1
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
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:targetBodyStructure |  | 0..* | Reference(BodyStructure) | The target point for this procedure URL: http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure
extension:statusReason | SO | 0..1 | CodeableConcept | Reason for current status URL: http://hl7.org/fhir/StructureDefinition/request-statusReason Binding Description: (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 | 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 | 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:handle | 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
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) Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
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
status | ?!SO Σ | 1..1 | code | The status of the request 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 | The kind of service request Binding: RequestIntent (required): The kind of service request. Fixed Value: order
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
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: 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
text | SO Σ | 1..1 | string | Plain text representation of the concept
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
subject | SO Σ | 1..1 | Reference(AU eRequesting 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 eRequesting Encounter) | Encounter in which the request was created
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
reference | SO Σ C | 1..1 | string | Literal reference, Relative, internal or absolute URL
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
occurrence[x] | SO Σ | 0..1 |  | When service should occur
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 Constraints: au-ereq-srr-01
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 eRequesting PractitionerRole) | Who/what is requesting 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
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:handle | 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:handle | 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 (IPS)) | The patient's pregnancy status Constraints: au-ereq-srr-02
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
supportingInfo:clinicalContext | SO | 0..* | Reference(AU eRequesting Clinical Context DocumentReference) | Clinical context narrative information providing an overview of the patient's current clinical situation
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

Path | Status | Usage | ValueSet | Version | Source
ServiceRequest.requisition.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
ServiceRequest.requisition.​type | Base | required | Order Identifier Type | 📦6.0.0-preview | AU Base Implementation Guide v6.0
ServiceRequest.status | Base | required | AU eRequesting RequestStatus | 📦1.0.0-preview | This IG
ServiceRequest.intent | Base | required | RequestIntent | 📍4.0.1 | FHIR Std.
ServiceRequest.category | Base | example | Service Request Category Codes | 📍4.0.1 | FHIR Std.
ServiceRequest.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std.
ServiceRequest.code | Base | example | Procedure | ⏿1.0.2 | tx.ontoserver.csiro.au
ServiceRequest.reasonCode | Base | preferred | Reason for Request | ⏿1.0.1 | tx.ontoserver.csiro.au

#### Constraints

Id | Grade | Path(s) | Description | Expression
au-ereq-srr-01 | error | ServiceRequest.authoredOn | Date shall include at least year, month, and day | `$this.toString().length() >= 10`
au-ereq-srr-02 | error | ServiceRequest.supportingInfo:pregnancyStatus | Pregnancy status shall be pregnant (SNOMED CT code 77386006) | `$this.resolve().value.coding.where(system = 'http://snomed.info/sct' and code = '77386006').exists()`
dom-2 | error | ServiceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | ServiceRequest | 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 | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | ServiceRequest | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present | `orderDetail.empty() or code.exists()`

This structure is derived from AUBaseServiceRequest

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
ServiceRequest |  | 0..* | AUBaseServiceRequest | This is an abstract profile. Child profiles: AUeRequestingImagingRequest, AUeRequestingPathologyRequest A service request in an Australian healthcare context
extension |  | 1..* | Extension | Extension
Slices for extension |  |  |  | Content/Rules for all slices
extension:sexParameterForClinicalUse | SO | 0..1 | PatSexParameterForClinicalUse(5.2.0) | A context-specific sex parameter for clinical use
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: (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 | 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 | 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:handle | 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 |  | 1..1 | CodeableConcept | Coded identifier type for local order identifier Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://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 | The status of the request 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 | The kind of service request Fixed Value: order
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
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 | SO | 1..1 | string | Plain text representation of the concept
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
subject | SO | 1..1 | Reference(AU eRequesting 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 eRequesting Encounter) | Encounter in which the request was created
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
reference | SO | 1..1 | string | Literal reference, Relative, internal or absolute URL
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
occurrence[x] | SO | 0..1 | dateTime, Period, Timing | When service should occur
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 Constraints: au-ereq-srr-01
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 eRequesting PractitionerRole) | Who/what is requesting 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
reasonCode | SO | 0..* | CodeableConcept | Explanation/Justification for procedure or service
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
insurance | SO | 0..* | Reference(AU eRequesting Coverage) | Associated insurance coverage
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
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 (IPS)) | The patient's pregnancy status Constraints: au-ereq-srr-02
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
supportingInfo:clinicalContext | SO | 0..* | Reference(AU eRequesting Clinical Context DocumentReference) | Clinical context narrative information providing an overview of the patient's current clinical situation
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 | Status | Usage | ValueSet | Version | Source
ServiceRequest.status | Base | required | AU eRequesting RequestStatus | 📦1.0.0-preview | This IG

#### Constraints

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

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
ServiceRequest | C | 0..* | AUBaseServiceRequest | This is an abstract profile. Child profiles: AUeRequestingImagingRequest, AUeRequestingPathologyRequest A service request in an Australian healthcare context Constraints: prr-1
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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
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:targetBodyStructure |  | 0..* | Reference(BodyStructure) | The target point for this procedure URL: http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure
extension:statusReason | SO | 0..1 | CodeableConcept | Reason for current status URL: http://hl7.org/fhir/StructureDefinition/request-statusReason Binding Description: (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 | 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 | 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:handle | 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) Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
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 | The status of the request 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 | The kind of service request Binding: RequestIntent (required): The kind of service request. Fixed Value: order
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
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: 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 | SO Σ | 1..1 | string | Plain text representation of the concept
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
orderDetail | Σ C | 0..* | CodeableConcept | Additional order information Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context.
quantity[x] | Σ | 0..1 |  | Service amount
quantityQuantity |  |  | Quantity |
quantityRatio |  |  | Ratio |
quantityRange |  |  | Range |
subject | SO Σ | 1..1 | Reference(AU eRequesting 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 eRequesting Encounter) | Encounter in which the request was created
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
reference | SO Σ C | 1..1 | string | Literal reference, Relative, internal or absolute URL
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 | Σ | 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 |  | When service should occur
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 Constraints: au-ereq-srr-01
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 eRequesting PractitionerRole) | Who/what is requesting 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
performerType | Σ | 0..1 | CodeableConcept | Performer role Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc.
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:handle | 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:handle | 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 (IPS)) | The patient's pregnancy status Constraints: au-ereq-srr-02
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
supportingInfo:clinicalContext | SO | 0..* | Reference(AU eRequesting Clinical Context DocumentReference) | Clinical context narrative information providing an overview of the patient's current clinical situation
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(Specimen) | Procedure Samples
bodySite | Σ | 0..* | CodeableConcept | Location on Body Binding: Body Site (preferred)
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 | Status | Usage | ValueSet | Version | Source
ServiceRequest.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
ServiceRequest.requisition.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
ServiceRequest.requisition.​type | Base | required | Order Identifier Type | 📦6.0.0-preview | AU Base Implementation Guide v6.0
ServiceRequest.requisition.​assigner.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std.
ServiceRequest.status | Base | required | AU eRequesting RequestStatus | 📦1.0.0-preview | This IG
ServiceRequest.intent | Base | required | RequestIntent | 📍4.0.1 | FHIR Std.
ServiceRequest.category | Base | example | Service Request Category Codes | 📍4.0.1 | FHIR Std.
ServiceRequest.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std.
ServiceRequest.code | Base | example | Procedure | ⏿1.0.2 | tx.ontoserver.csiro.au
ServiceRequest.orderDetail | Base | example | Service Request Order Details Codes | 📍4.0.1 | FHIR Std.
ServiceRequest.encounter.​type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std.
ServiceRequest.asNeeded[x] | Base | example | SNOMED CT Medication As Needed Reason Codes | 📍4.0.1 | FHIR Std.
ServiceRequest.performerType | Base | example | Participant Roles | 📍4.0.1 | FHIR Std.
ServiceRequest.locationCode | Base | example | ServiceDeliveryLocationRoleType | 📦3.0.0 | THO v7.0
ServiceRequest.reasonCode | Base | preferred | Reason for Request | ⏿1.0.1 | tx.ontoserver.csiro.au
ServiceRequest.bodySite | Base | preferred | Body Site | ⏿1.0.2 | tx.ontoserver.csiro.au

#### Constraints

Id | Grade | Path(s) | Description | Expression
au-ereq-srr-01 | error | ServiceRequest.authoredOn | Date shall include at least year, month, and day | `$this.toString().length() >= 10`
au-ereq-srr-02 | error | ServiceRequest.supportingInfo:pregnancyStatus | Pregnancy status shall be pregnant (SNOMED CT code 77386006) | `$this.resolve().value.coding.where(system = 'http://snomed.info/sct' and code = '77386006').exists()`
dom-2 | error | ServiceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | ServiceRequest | 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 | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | ServiceRequest | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present | `orderDetail.empty() or code.exists()`

This structure is derived from AUBaseServiceRequest

Summary

Mandatory: 10 elements
Must-Support: 23 elements
Fixed: 1 element

Structures

This structure refers to these other structures:

- AU Local Order Identifier (http://hl7.org.au/fhir/StructureDefinition/au-localorderidentifier)
- AU eRequesting Patient (http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-patient)
- AU eRequesting Encounter (http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-encounter)
- AU eRequesting PractitionerRole (http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-practitionerrole)
- AU eRequesting Coverage (http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-coverage)
- Observation Pregnancy - Status (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Observation-pregnancy-status-uv-ips)
- AU eRequesting Clinical Context DocumentReference (http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-clinicalcontext-documentreference)

Extensions

This structure refers to these extensions:

- 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: 1

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
ServiceRequest | C | 0..* | AUBaseServiceRequest | This is an abstract profile. Child profiles: AUeRequestingImagingRequest, AUeRequestingPathologyRequest A service request in an Australian healthcare context Constraints: prr-1
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
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:targetBodyStructure |  | 0..* | Reference(BodyStructure) | The target point for this procedure URL: http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure
extension:statusReason | SO | 0..1 | CodeableConcept | Reason for current status URL: http://hl7.org/fhir/StructureDefinition/request-statusReason Binding Description: (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 | 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 | 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:handle | 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
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) Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
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
status | ?!SO Σ | 1..1 | code | The status of the request 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 | The kind of service request Binding: RequestIntent (required): The kind of service request. Fixed Value: order
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
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: 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
text | SO Σ | 1..1 | string | Plain text representation of the concept
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
subject | SO Σ | 1..1 | Reference(AU eRequesting 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 eRequesting Encounter) | Encounter in which the request was created
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
reference | SO Σ C | 1..1 | string | Literal reference, Relative, internal or absolute URL
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
occurrence[x] | SO Σ | 0..1 |  | When service should occur
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 Constraints: au-ereq-srr-01
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 eRequesting PractitionerRole) | Who/what is requesting 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
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:handle | 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:handle | 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 (IPS)) | The patient's pregnancy status Constraints: au-ereq-srr-02
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
supportingInfo:clinicalContext | SO | 0..* | Reference(AU eRequesting Clinical Context DocumentReference) | Clinical context narrative information providing an overview of the patient's current clinical situation
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

Path | Status | Usage | ValueSet | Version | Source
ServiceRequest.requisition.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
ServiceRequest.requisition.​type | Base | required | Order Identifier Type | 📦6.0.0-preview | AU Base Implementation Guide v6.0
ServiceRequest.status | Base | required | AU eRequesting RequestStatus | 📦1.0.0-preview | This IG
ServiceRequest.intent | Base | required | RequestIntent | 📍4.0.1 | FHIR Std.
ServiceRequest.category | Base | example | Service Request Category Codes | 📍4.0.1 | FHIR Std.
ServiceRequest.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std.
ServiceRequest.code | Base | example | Procedure | ⏿1.0.2 | tx.ontoserver.csiro.au
ServiceRequest.reasonCode | Base | preferred | Reason for Request | ⏿1.0.1 | tx.ontoserver.csiro.au

#### Constraints

Id | Grade | Path(s) | Description | Expression
au-ereq-srr-01 | error | ServiceRequest.authoredOn | Date shall include at least year, month, and day | `$this.toString().length() >= 10`
au-ereq-srr-02 | error | ServiceRequest.supportingInfo:pregnancyStatus | Pregnancy status shall be pregnant (SNOMED CT code 77386006) | `$this.resolve().value.coding.where(system = 'http://snomed.info/sct' and code = '77386006').exists()`
dom-2 | error | ServiceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | ServiceRequest | 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 | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | ServiceRequest | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present | `orderDetail.empty() or code.exists()`

Differential View

This structure is derived from AUBaseServiceRequest

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
ServiceRequest |  | 0..* | AUBaseServiceRequest | This is an abstract profile. Child profiles: AUeRequestingImagingRequest, AUeRequestingPathologyRequest A service request in an Australian healthcare context
extension |  | 1..* | Extension | Extension
Slices for extension |  |  |  | Content/Rules for all slices
extension:sexParameterForClinicalUse | SO | 0..1 | PatSexParameterForClinicalUse(5.2.0) | A context-specific sex parameter for clinical use
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: (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 | 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 | 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:handle | 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 |  | 1..1 | CodeableConcept | Coded identifier type for local order identifier Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://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 | The status of the request 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 | The kind of service request Fixed Value: order
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
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 | SO | 1..1 | string | Plain text representation of the concept
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
subject | SO | 1..1 | Reference(AU eRequesting 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 eRequesting Encounter) | Encounter in which the request was created
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
reference | SO | 1..1 | string | Literal reference, Relative, internal or absolute URL
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
occurrence[x] | SO | 0..1 | dateTime, Period, Timing | When service should occur
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 Constraints: au-ereq-srr-01
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 eRequesting PractitionerRole) | Who/what is requesting 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
reasonCode | SO | 0..* | CodeableConcept | Explanation/Justification for procedure or service
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
insurance | SO | 0..* | Reference(AU eRequesting Coverage) | Associated insurance coverage
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
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 (IPS)) | The patient's pregnancy status Constraints: au-ereq-srr-02
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
supportingInfo:clinicalContext | SO | 0..* | Reference(AU eRequesting Clinical Context DocumentReference) | Clinical context narrative information providing an overview of the patient's current clinical situation
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 | Status | Usage | ValueSet | Version | Source
ServiceRequest.status | Base | required | AU eRequesting RequestStatus | 📦1.0.0-preview | This IG

#### Constraints

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

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
ServiceRequest | C | 0..* | AUBaseServiceRequest | This is an abstract profile. Child profiles: AUeRequestingImagingRequest, AUeRequestingPathologyRequest A service request in an Australian healthcare context Constraints: prr-1
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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 1..* | Extension | Extension Slice: Unordered, Open by value:url
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:targetBodyStructure |  | 0..* | Reference(BodyStructure) | The target point for this procedure URL: http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure
extension:statusReason | SO | 0..1 | CodeableConcept | Reason for current status URL: http://hl7.org/fhir/StructureDefinition/request-statusReason Binding Description: (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 | 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 | 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:handle | 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) Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
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 | The status of the request 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 | The kind of service request Binding: RequestIntent (required): The kind of service request. Fixed Value: order
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
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: 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 | SO Σ | 1..1 | string | Plain text representation of the concept
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
orderDetail | Σ C | 0..* | CodeableConcept | Additional order information Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context.
quantity[x] | Σ | 0..1 |  | Service amount
quantityQuantity |  |  | Quantity |
quantityRatio |  |  | Ratio |
quantityRange |  |  | Range |
subject | SO Σ | 1..1 | Reference(AU eRequesting 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 eRequesting Encounter) | Encounter in which the request was created
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
reference | SO Σ C | 1..1 | string | Literal reference, Relative, internal or absolute URL
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 | Σ | 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 |  | When service should occur
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 Constraints: au-ereq-srr-01
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 eRequesting PractitionerRole) | Who/what is requesting 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
performerType | Σ | 0..1 | CodeableConcept | Performer role Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc.
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:handle | 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:handle | 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 (IPS)) | The patient's pregnancy status Constraints: au-ereq-srr-02
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
supportingInfo:clinicalContext | SO | 0..* | Reference(AU eRequesting Clinical Context DocumentReference) | Clinical context narrative information providing an overview of the patient's current clinical situation
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(Specimen) | Procedure Samples
bodySite | Σ | 0..* | CodeableConcept | Location on Body Binding: Body Site (preferred)
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 | Status | Usage | ValueSet | Version | Source
ServiceRequest.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
ServiceRequest.requisition.​use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
ServiceRequest.requisition.​type | Base | required | Order Identifier Type | 📦6.0.0-preview | AU Base Implementation Guide v6.0
ServiceRequest.requisition.​assigner.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std.
ServiceRequest.status | Base | required | AU eRequesting RequestStatus | 📦1.0.0-preview | This IG
ServiceRequest.intent | Base | required | RequestIntent | 📍4.0.1 | FHIR Std.
ServiceRequest.category | Base | example | Service Request Category Codes | 📍4.0.1 | FHIR Std.
ServiceRequest.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std.
ServiceRequest.code | Base | example | Procedure | ⏿1.0.2 | tx.ontoserver.csiro.au
ServiceRequest.orderDetail | Base | example | Service Request Order Details Codes | 📍4.0.1 | FHIR Std.
ServiceRequest.encounter.​type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std.
ServiceRequest.asNeeded[x] | Base | example | SNOMED CT Medication As Needed Reason Codes | 📍4.0.1 | FHIR Std.
ServiceRequest.performerType | Base | example | Participant Roles | 📍4.0.1 | FHIR Std.
ServiceRequest.locationCode | Base | example | ServiceDeliveryLocationRoleType | 📦3.0.0 | THO v7.0
ServiceRequest.reasonCode | Base | preferred | Reason for Request | ⏿1.0.1 | tx.ontoserver.csiro.au
ServiceRequest.bodySite | Base | preferred | Body Site | ⏿1.0.2 | tx.ontoserver.csiro.au

#### Constraints

Id | Grade | Path(s) | Description | Expression
au-ereq-srr-01 | error | ServiceRequest.authoredOn | Date shall include at least year, month, and day | `$this.toString().length() >= 10`
au-ereq-srr-02 | error | ServiceRequest.supportingInfo:pregnancyStatus | Pregnancy status shall be pregnant (SNOMED CT code 77386006) | `$this.resolve().value.coding.where(system = 'http://snomed.info/sct' and code = '77386006').exists()`
dom-2 | error | ServiceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | ServiceRequest | 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 | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | ServiceRequest | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present | `orderDetail.empty() or code.exists()`

This structure is derived from AUBaseServiceRequest

Summary

Mandatory: 10 elements
Must-Support: 23 elements
Fixed: 1 element

Structures

This structure refers to these other structures:

- AU Local Order Identifier (http://hl7.org.au/fhir/StructureDefinition/au-localorderidentifier)
- AU eRequesting Patient (http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-patient)
- AU eRequesting Encounter (http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-encounter)
- AU eRequesting PractitionerRole (http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-practitionerrole)
- AU eRequesting Coverage (http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-coverage)
- Observation Pregnancy - Status (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Observation-pregnancy-status-uv-ips)
- AU eRequesting Clinical Context DocumentReference (http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-clinicalcontext-documentreference)

Extensions

This structure refers to these extensions:

- 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: 1

Other representations of profile: CSV, Excel, Schematron

### Notes:

Below is an overview of the mandatory and optional search parameters and combined search parameters. See the AU eRequesting CapabilityStatements for a complete list of supported RESTful interactions for this IG.

FHIR search operations are described here and the syntax used to describe AU eRequesting interactions is defined here.

Any search parameter defined in FHIR may be 'allowed' by the system unless explicitly marked as "SHALL NOT".

Parameter(s) | Server Conformance | Placer Conformance | Filler Conformance | Patient Conformance | Type(s) | Requirements (when used alone or in combination)
--- | --- | --- | --- | --- | --- | ---
_id | SHALL | MAY | MAY | MAY | `token` |
requisition | SHALL | MAY | MAY | MAY | `token` |
supporting-info | SHALL | MAY | MAY | MAY | `reference` |
_include=ServiceRequest:patient | SHALL | MAY | MAY | MAY | `reference` |
_include=ServiceRequest:requester | SHALL | MAY | MAY | MAY | `reference` |
_include=ServiceRequest:supporting-info | SHALL | MAY | MAY | MAY | `reference` |
_include=ServiceRequest:encounter | SHOULD | MAY | MAY | MAY | `reference` |

#### 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`, `ServiceRequest:supporting-info`

   `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&_include=ServiceRequest:supporting-info

   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`, `ServiceRequest:supporting-info`

   `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&_include=ServiceRequest:supporting-info

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

3. `supporting-info` search parameter
   - including support for these `_include` parameters: `ServiceRequest:patient`, `ServiceRequest:requester`, `ServiceRequest:encounter`, `ServiceRequest:supporting-info`

   `GET [base]/ServiceRequest?supporting-info={Type/}[id]`

   Example:

   1. GET [base]/ServiceRequest?supporting-info=9876
   2. GET [base]/ServiceRequest?supporting-info=Observation/9876
   3. GET [base]/ServiceRequest?supporting-info=9876&_include=ServiceRequest:patient&_include=ServiceRequest:requester&_include=ServiceRequest:encounter&_include=ServiceRequest:supporting-info

   Implementation Notes: Fetches a bundle of all ServiceRequest resources matching the supporting-info (how to search by reference)