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

AU eRequesting Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 0.2.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7au/au-fhir-erequesting/ and changes regularly. See the Directory of published versions

Resource Profile: AU eRequesting Pathology Request

Official URL: http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-servicerequest-path Version: 0.2.0-ci-build
Standards status: Draft Maturity Level: 0 Computable Name: AUeRequestingPathologyRequest

Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2024+; Licensed Under Creative Commons No Rights Reserved.

This profile sets minimum expectations for a ServiceRequest resource that is used to record, search, and fetch information about pathology requests for a patient. It is based on the AU eRequesting Diagnostic Request and identifies the additional constraints, extensions, vocabularies and value sets that SHALL be present in the ServiceRequest when conforming to this profile.

It is intended that this profile will always support the latest version of the SPIA Requesting Pathology Terminology Reference Set available. At this time the latest version of the SPIA Requesting Pathology Terminology Reference Set is v4.2. Implementers are advised to take note that the current binding RCPA - SPIA Requesting Pathology Terminology Reference Set currently supports v3.1 and will be replaced with a version that support v4.2 as soon as it is available in the National Clinical Terminology Service.

Profile specific implementation guidance

  • ServiceRequest.code
    • The use of coding for the requested test can vary significantly across systems, filler systems need to understand that they may encounter codes they do not recognise and be prepared to handle those resources appropriately. Placer systems SHALL populate ServiceRequest.code.text so that fillers can at least display the service requested, even if they do not recognise the code supplied.
    • Placer systems SHALL adhere to the following order of preference when populating the ServiceRequest.code:
      1. A code selected from the RCPA - SPIA Requesting Pathology Terminology Reference Set value set is the preferred option
      2. A code selected from the SNOMED CT Pathology Procedure value set is the second most preferred option
      3. A local code is preferred over free text, preferably from a published and accessible FHIR code system​
      4. Free text is the least preferred option which should not be used if a local code is known
ServiceRequest Code Diagram 1


While the current RCPA - SPIA Requesting Pathology Reference Set binding is preferred, it is intended that this binding will move to extensible in the future to ensure the consistent coding of eRequests. Subject to discussion with the Technical Design Group this could commence with a progressive move to extensible through stronger binding of identified subsets of the RCPA - SPIA Requesting Pathology Terminology Reference Set. National registries or exchange networks may make additional conformance requirements around support for nationally agreed value sets, even if this specification does not require their use.

  • See guidance on the construction of identifiers in each Identifier profile and the section on Business Identifiers in AU Base.
  • The provision of an insurance attribute describes a recommendation to be considered by the Filler and does not guarantee that this recommendation will be satisfied.

Usage:

Formal Views of Profile Content

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

This structure is derived from AUeRequestingDiagnosticRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest 0..* AUeRequestingDiagnosticRequest A pathology test request
... Slices for category 1..* CodeableConcept Classification of service
Slice: Unordered, Open by pattern:$this
.... category:path 1..1 CodeableConcept Classification of service
Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 108252007
... code 1..1 CodeableConcept Refer to the Profile Specific Implementation Guidance on ServiceRequest.code
Binding: RCPA - SPIA Requesting Pathology Terminology Reference Set . (preferred)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ServiceRequest.codepreferredspia-requesting-refset .
https://www.rcpa.edu.au/fhir/ValueSet/spia-requesting-refset-3
NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C 0..* AUeRequestingDiagnosticRequest A pathology test request
prr-1: orderDetail SHALL only be present if code is present
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... targetBodyStructure 0..* Reference(BodyStructure) The target point for this procedure
URL: http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure
.... statusReason SO 0..1 CodeableConcept Reason for current status
URL: http://hl7.org/fhir/StructureDefinition/request-statusReason
Binding Description (No ValueSet): (example): Codes identifying the reason for the current state of an event.


ObligationsActor
SHALL:populate-if-known AU eRequesting Placer
SHALL:no-error AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SO 0..* Identifier, AULocalOrderIdentifier Identifiers assigned to this order
ObligationsActor
SHALL:populate-if-known AU eRequesting Placer
SHALL:no-error AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
... requisition SO 1..1 AULocalOrderIdentifier Local Order Identifier
ObligationsActor
SHALL:populate AU eRequesting Placer
SHALL:handle AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
.... 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)
..... coding Σ 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PGN
.... 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 draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: AU eRequesting RequestStatus (required)
ObligationsActor
SHALL:populate AU eRequesting Placer
SHALL:handle AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
... intent ?!SOΣ 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of service request.


Required Pattern: order
ObligationsActor
SHALL:populate AU eRequesting Placer
SHALL:no-error AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
... Slices for category SOΣ 1..* CodeableConcept Classification of service
Slice: Unordered, Open by pattern:$this
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.


ObligationsActor
SHALL:populate AU eRequesting Placer
SHALL:handle AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
.... category:path SOΣ 1..1 CodeableConcept Classification of service
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.



Required Pattern: At least the following
ObligationsActor
SHALL:populate AU eRequesting Placer
SHALL:handle AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 108252007
... priority SOΣ 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

ObligationsActor
SHALL:populate-if-known AU eRequesting Placer
SHALL:handle AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
... doNotPerform ?!Σ 0..1 boolean True if service/procedure should not be performed
... code SOΣ 1..1 CodeableConcept Refer to the Profile Specific Implementation Guidance on ServiceRequest.code
Binding: RCPA - SPIA Requesting Pathology Terminology Reference Set . (preferred)
ObligationsActor
SHALL:populate AU eRequesting Placer
SHALL:handle AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
.... text Σ 1..1 string Plain text representation of the concept
... subject SOΣ 1..1 Reference(AU Core Patient) Individual or Entity the service is ordered for
ObligationsActor
SHALL:populate AU eRequesting Placer
SHALL:handle AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
... encounter SOΣ 1..1 Reference(AU Core Encounter) Encounter in which the request was created
ObligationsActor
SHALL:populate-if-known AU eRequesting Placer
SHALL:no-error AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
... authoredOn SOΣC 1..1 dateTime Date request signed
au-ereq-srr-01: Date must include at least year, month, and day
ObligationsActor
SHALL:populate AU eRequesting Placer
SHALL:handle AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
... requester SOΣ 1..1 Reference(AU Core PractitionerRole) Authorising individual, organisation or program (e.g. National Bowel Cancer Screening Program)
ObligationsActor
SHALL:populate AU eRequesting Placer
SHALL:handle AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
... reasonCode SOΣ 0..* CodeableConcept Explanation/Justification for procedure or service
Binding: Reason for Request . (preferred)
ObligationsActor
SHALL:populate-if-known AU eRequesting Placer
SHALL:no-error AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
... insurance SO 0..* Reference(AU eRequesting Coverage) Associated insurance coverage
ObligationsActor
SHALL:populate-if-known AU eRequesting Placer
SHALL:no-error AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
... bodySite SOΣ 0..* CodeableConcept Location on Body
Binding: Body Site . (preferred)
ObligationsActor
SHALL:populate-if-known AU eRequesting Placer
SHALL:handle AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
... note SO 0..* Annotation Comments
ObligationsActor
SHALL:populate-if-known AU eRequesting Placer
SHALL:handle AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ServiceRequest.requisition.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
ServiceRequest.requisition.typerequiredOrderIdentifierType
http://terminology.hl7.org.au/ValueSet/order-identifier-type
ServiceRequest.statusrequiredAUeRequestingRequestStatus
http://hl7.org.au/fhir/ereq/ValueSet/au-erequesting-request-status
from this IG
ServiceRequest.intentrequiredPattern: order
http://hl7.org/fhir/ValueSet/request-intent|4.0.1
from the FHIR Standard
ServiceRequest.categoryexampleServiceRequestCategoryCodes
http://hl7.org/fhir/ValueSet/servicerequest-category
from the FHIR Standard
ServiceRequest.category:pathexamplePattern: SNOMED-CT Code 108252007
http://hl7.org/fhir/ValueSet/servicerequest-category
from the FHIR Standard
ServiceRequest.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
from the FHIR Standard
ServiceRequest.codepreferredspia-requesting-refset .
https://www.rcpa.edu.au/fhir/ValueSet/spia-requesting-refset-3
ServiceRequest.reasonCodepreferredReasonForRequest .
https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1
ServiceRequest.bodySitepreferredBodySite .
https://healthterminologies.gov.au/fhir/ValueSet/body-site-1
NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C 0..* AUeRequestingDiagnosticRequest A pathology test request
prr-1: orderDetail SHALL only be present if code is present
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... targetBodyStructure 0..* Reference(BodyStructure) The target point for this procedure
URL: http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure
.... statusReason SO 0..1 CodeableConcept Reason for current status
URL: http://hl7.org/fhir/StructureDefinition/request-statusReason
Binding Description (No ValueSet): (example): Codes identifying the reason for the current state of an event.


ObligationsActor
SHALL:populate-if-known AU eRequesting Placer
SHALL:no-error AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SO 0..* Identifier, AULocalOrderIdentifier Identifiers assigned to this order
ObligationsActor
SHALL:populate-if-known AU eRequesting Placer
SHALL:no-error AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
... 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 Local Order Identifier
ObligationsActor
SHALL:populate AU eRequesting Placer
SHALL:handle AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ 1..1 CodeableConcept Coded identifier type for local order identifier
Binding: Order Identifier Type (required)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PGN
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... system Σ 1..1 uri System identifier namespace for the organisation that assigned the order identifier
Example General: http://www.acme.com/identifiers/patient
.... value Σ 1..1 string Order identifier
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organisation that assigned the order identifier
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 1..1 string Name of the assigning organisation
... status ?!SOΣ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: AU eRequesting RequestStatus (required)
ObligationsActor
SHALL:populate AU eRequesting Placer
SHALL:handle AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
... intent ?!SOΣ 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of service request.


Required Pattern: order
ObligationsActor
SHALL:populate AU eRequesting Placer
SHALL:no-error AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
... Slices for category SOΣ 1..* CodeableConcept Classification of service
Slice: Unordered, Open by pattern:$this
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.


ObligationsActor
SHALL:populate AU eRequesting Placer
SHALL:handle AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
.... category:path SOΣ 1..1 CodeableConcept Classification of service
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.



Required Pattern: At least the following
ObligationsActor
SHALL:populate AU eRequesting Placer
SHALL:handle AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
..... 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://snomed.info/sct
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 108252007
...... 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
... priority SOΣ 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

ObligationsActor
SHALL:populate-if-known AU eRequesting Placer
SHALL:handle AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
... doNotPerform ?!Σ 0..1 boolean True if service/procedure should not be performed
... code SOΣ 1..1 CodeableConcept Refer to the Profile Specific Implementation Guidance on ServiceRequest.code
Binding: RCPA - SPIA Requesting Pathology Terminology Reference Set . (preferred)
ObligationsActor
SHALL:populate AU eRequesting Placer
SHALL:handle AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
.... text Σ 1..1 string Plain text representation of the concept
... orderDetail ΣC 0..* CodeableConcept Additional order information
Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context.


... quantity[x] Σ 0..1 Service amount
.... quantityQuantity Quantity
.... quantityRatio Ratio
.... quantityRange Range
... subject SOΣ 1..1 Reference(AU Core Patient) Individual or Entity the service is ordered for
ObligationsActor
SHALL:populate AU eRequesting Placer
SHALL:handle AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
... encounter SOΣ 1..1 Reference(AU Core Encounter) Encounter in which the request was created
ObligationsActor
SHALL:populate-if-known AU eRequesting Placer
SHALL:no-error AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... occurrence[x] Σ 0..1 When service should occur
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
.... occurrenceTiming Timing
... asNeeded[x] Σ 0..1 Preconditions for service
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc.

.... asNeededBoolean boolean
.... asNeededCodeableConcept CodeableConcept
... authoredOn SOΣC 1..1 dateTime Date request signed
au-ereq-srr-01: Date must include at least year, month, and day
ObligationsActor
SHALL:populate AU eRequesting Placer
SHALL:handle AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
... requester SOΣ 1..1 Reference(AU Core PractitionerRole) Authorising individual, organisation or program (e.g. National Bowel Cancer Screening Program)
ObligationsActor
SHALL:populate AU eRequesting Placer
SHALL:handle AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
... performerType Σ 0..1 CodeableConcept Performer role
Binding: Practitioner Role . (preferred)
... performer Σ 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) Requested performer
... locationCode Σ 0..* CodeableConcept Requested location
Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered.


... locationReference Σ 0..* Reference(Location) Requested location
... reasonCode SOΣ 0..* CodeableConcept Explanation/Justification for procedure or service
Binding: Reason for Request . (preferred)
ObligationsActor
SHALL:populate-if-known AU eRequesting Placer
SHALL:no-error AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
... reasonReference Σ 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Explanation/Justification for service or service
... insurance SO 0..* Reference(AU eRequesting Coverage) Associated insurance coverage
ObligationsActor
SHALL:populate-if-known AU eRequesting Placer
SHALL:no-error AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
... supportingInfo 0..* Reference(Resource) Additional clinical information
... specimen Σ 0..* Reference(AU Base Specimen) Procedure Samples
... bodySite SOΣ 0..* CodeableConcept Location on Body
Binding: Body Site . (preferred)
ObligationsActor
SHALL:populate-if-known AU eRequesting Placer
SHALL:handle AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
... note SO 0..* Annotation Comments
ObligationsActor
SHALL:populate-if-known AU eRequesting Placer
SHALL:handle AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
... patientInstruction Σ 0..1 string Patient or consumer-oriented instructions
... relevantHistory 0..* Reference(Provenance) Request provenance

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ServiceRequest.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
ServiceRequest.requisition.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
ServiceRequest.requisition.typerequiredOrderIdentifierType
http://terminology.hl7.org.au/ValueSet/order-identifier-type
ServiceRequest.requisition.assigner.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
ServiceRequest.statusrequiredAUeRequestingRequestStatus
http://hl7.org.au/fhir/ereq/ValueSet/au-erequesting-request-status
from this IG
ServiceRequest.intentrequiredPattern: order
http://hl7.org/fhir/ValueSet/request-intent|4.0.1
from the FHIR Standard
ServiceRequest.categoryexampleServiceRequestCategoryCodes
http://hl7.org/fhir/ValueSet/servicerequest-category
from the FHIR Standard
ServiceRequest.category:pathexamplePattern: SNOMED-CT Code 108252007
http://hl7.org/fhir/ValueSet/servicerequest-category
from the FHIR Standard
ServiceRequest.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
from the FHIR Standard
ServiceRequest.codepreferredspia-requesting-refset .
https://www.rcpa.edu.au/fhir/ValueSet/spia-requesting-refset-3
ServiceRequest.orderDetailexampleServiceRequestOrderDetailsCodes
http://hl7.org/fhir/ValueSet/servicerequest-orderdetail
from the FHIR Standard
ServiceRequest.encounter.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
ServiceRequest.asNeeded[x]exampleSNOMEDCTMedicationAsNeededReasonCodes
http://hl7.org/fhir/ValueSet/medication-as-needed-reason
from the FHIR Standard
ServiceRequest.performerTypepreferredPractitionerRole .
https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1
ServiceRequest.locationCodeexampleServiceDeliveryLocationRoleType
http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
ServiceRequest.reasonCodepreferredReasonForRequest .
https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1
ServiceRequest.bodySitepreferredBodySite .
https://healthterminologies.gov.au/fhir/ValueSet/body-site-1

This structure is derived from AUeRequestingDiagnosticRequest

Summary

Mandatory: 1 element

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of ServiceRequest.category

Maturity: 0

Differential View

This structure is derived from AUeRequestingDiagnosticRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest 0..* AUeRequestingDiagnosticRequest A pathology test request
... Slices for category 1..* CodeableConcept Classification of service
Slice: Unordered, Open by pattern:$this
.... category:path 1..1 CodeableConcept Classification of service
Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 108252007
... code 1..1 CodeableConcept Refer to the Profile Specific Implementation Guidance on ServiceRequest.code
Binding: RCPA - SPIA Requesting Pathology Terminology Reference Set . (preferred)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ServiceRequest.codepreferredspia-requesting-refset .
https://www.rcpa.edu.au/fhir/ValueSet/spia-requesting-refset-3

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C 0..* AUeRequestingDiagnosticRequest A pathology test request
prr-1: orderDetail SHALL only be present if code is present
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... targetBodyStructure 0..* Reference(BodyStructure) The target point for this procedure
URL: http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure
.... statusReason SO 0..1 CodeableConcept Reason for current status
URL: http://hl7.org/fhir/StructureDefinition/request-statusReason
Binding Description (No ValueSet): (example): Codes identifying the reason for the current state of an event.


ObligationsActor
SHALL:populate-if-known AU eRequesting Placer
SHALL:no-error AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SO 0..* Identifier, AULocalOrderIdentifier Identifiers assigned to this order
ObligationsActor
SHALL:populate-if-known AU eRequesting Placer
SHALL:no-error AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
... requisition SO 1..1 AULocalOrderIdentifier Local Order Identifier
ObligationsActor
SHALL:populate AU eRequesting Placer
SHALL:handle AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
.... 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)
..... coding Σ 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PGN
.... 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 draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: AU eRequesting RequestStatus (required)
ObligationsActor
SHALL:populate AU eRequesting Placer
SHALL:handle AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
... intent ?!SOΣ 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of service request.


Required Pattern: order
ObligationsActor
SHALL:populate AU eRequesting Placer
SHALL:no-error AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
... Slices for category SOΣ 1..* CodeableConcept Classification of service
Slice: Unordered, Open by pattern:$this
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.


ObligationsActor
SHALL:populate AU eRequesting Placer
SHALL:handle AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
.... category:path SOΣ 1..1 CodeableConcept Classification of service
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.



Required Pattern: At least the following
ObligationsActor
SHALL:populate AU eRequesting Placer
SHALL:handle AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 108252007
... priority SOΣ 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

ObligationsActor
SHALL:populate-if-known AU eRequesting Placer
SHALL:handle AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
... doNotPerform ?!Σ 0..1 boolean True if service/procedure should not be performed
... code SOΣ 1..1 CodeableConcept Refer to the Profile Specific Implementation Guidance on ServiceRequest.code
Binding: RCPA - SPIA Requesting Pathology Terminology Reference Set . (preferred)
ObligationsActor
SHALL:populate AU eRequesting Placer
SHALL:handle AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
.... text Σ 1..1 string Plain text representation of the concept
... subject SOΣ 1..1 Reference(AU Core Patient) Individual or Entity the service is ordered for
ObligationsActor
SHALL:populate AU eRequesting Placer
SHALL:handle AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
... encounter SOΣ 1..1 Reference(AU Core Encounter) Encounter in which the request was created
ObligationsActor
SHALL:populate-if-known AU eRequesting Placer
SHALL:no-error AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
... authoredOn SOΣC 1..1 dateTime Date request signed
au-ereq-srr-01: Date must include at least year, month, and day
ObligationsActor
SHALL:populate AU eRequesting Placer
SHALL:handle AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
... requester SOΣ 1..1 Reference(AU Core PractitionerRole) Authorising individual, organisation or program (e.g. National Bowel Cancer Screening Program)
ObligationsActor
SHALL:populate AU eRequesting Placer
SHALL:handle AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
... reasonCode SOΣ 0..* CodeableConcept Explanation/Justification for procedure or service
Binding: Reason for Request . (preferred)
ObligationsActor
SHALL:populate-if-known AU eRequesting Placer
SHALL:no-error AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
... insurance SO 0..* Reference(AU eRequesting Coverage) Associated insurance coverage
ObligationsActor
SHALL:populate-if-known AU eRequesting Placer
SHALL:no-error AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
... bodySite SOΣ 0..* CodeableConcept Location on Body
Binding: Body Site . (preferred)
ObligationsActor
SHALL:populate-if-known AU eRequesting Placer
SHALL:handle AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
... note SO 0..* Annotation Comments
ObligationsActor
SHALL:populate-if-known AU eRequesting Placer
SHALL:handle AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ServiceRequest.requisition.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
ServiceRequest.requisition.typerequiredOrderIdentifierType
http://terminology.hl7.org.au/ValueSet/order-identifier-type
ServiceRequest.statusrequiredAUeRequestingRequestStatus
http://hl7.org.au/fhir/ereq/ValueSet/au-erequesting-request-status
from this IG
ServiceRequest.intentrequiredPattern: order
http://hl7.org/fhir/ValueSet/request-intent|4.0.1
from the FHIR Standard
ServiceRequest.categoryexampleServiceRequestCategoryCodes
http://hl7.org/fhir/ValueSet/servicerequest-category
from the FHIR Standard
ServiceRequest.category:pathexamplePattern: SNOMED-CT Code 108252007
http://hl7.org/fhir/ValueSet/servicerequest-category
from the FHIR Standard
ServiceRequest.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
from the FHIR Standard
ServiceRequest.codepreferredspia-requesting-refset .
https://www.rcpa.edu.au/fhir/ValueSet/spia-requesting-refset-3
ServiceRequest.reasonCodepreferredReasonForRequest .
https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1
ServiceRequest.bodySitepreferredBodySite .
https://healthterminologies.gov.au/fhir/ValueSet/body-site-1

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C 0..* AUeRequestingDiagnosticRequest A pathology test request
prr-1: orderDetail SHALL only be present if code is present
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... targetBodyStructure 0..* Reference(BodyStructure) The target point for this procedure
URL: http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure
.... statusReason SO 0..1 CodeableConcept Reason for current status
URL: http://hl7.org/fhir/StructureDefinition/request-statusReason
Binding Description (No ValueSet): (example): Codes identifying the reason for the current state of an event.


ObligationsActor
SHALL:populate-if-known AU eRequesting Placer
SHALL:no-error AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SO 0..* Identifier, AULocalOrderIdentifier Identifiers assigned to this order
ObligationsActor
SHALL:populate-if-known AU eRequesting Placer
SHALL:no-error AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
... 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 Local Order Identifier
ObligationsActor
SHALL:populate AU eRequesting Placer
SHALL:handle AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ 1..1 CodeableConcept Coded identifier type for local order identifier
Binding: Order Identifier Type (required)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 1..1 Coding Code defined by a terminology system

Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: PGN
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... system Σ 1..1 uri System identifier namespace for the organisation that assigned the order identifier
Example General: http://www.acme.com/identifiers/patient
.... value Σ 1..1 string Order identifier
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organisation that assigned the order identifier
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 1..1 string Name of the assigning organisation
... status ?!SOΣ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: AU eRequesting RequestStatus (required)
ObligationsActor
SHALL:populate AU eRequesting Placer
SHALL:handle AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
... intent ?!SOΣ 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of service request.


Required Pattern: order
ObligationsActor
SHALL:populate AU eRequesting Placer
SHALL:no-error AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
... Slices for category SOΣ 1..* CodeableConcept Classification of service
Slice: Unordered, Open by pattern:$this
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.


ObligationsActor
SHALL:populate AU eRequesting Placer
SHALL:handle AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
.... category:path SOΣ 1..1 CodeableConcept Classification of service
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.



Required Pattern: At least the following
ObligationsActor
SHALL:populate AU eRequesting Placer
SHALL:handle AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
..... 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://snomed.info/sct
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 108252007
...... 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
... priority SOΣ 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

ObligationsActor
SHALL:populate-if-known AU eRequesting Placer
SHALL:handle AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
... doNotPerform ?!Σ 0..1 boolean True if service/procedure should not be performed
... code SOΣ 1..1 CodeableConcept Refer to the Profile Specific Implementation Guidance on ServiceRequest.code
Binding: RCPA - SPIA Requesting Pathology Terminology Reference Set . (preferred)
ObligationsActor
SHALL:populate AU eRequesting Placer
SHALL:handle AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
.... text Σ 1..1 string Plain text representation of the concept
... orderDetail ΣC 0..* CodeableConcept Additional order information
Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context.


... quantity[x] Σ 0..1 Service amount
.... quantityQuantity Quantity
.... quantityRatio Ratio
.... quantityRange Range
... subject SOΣ 1..1 Reference(AU Core Patient) Individual or Entity the service is ordered for
ObligationsActor
SHALL:populate AU eRequesting Placer
SHALL:handle AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
... encounter SOΣ 1..1 Reference(AU Core Encounter) Encounter in which the request was created
ObligationsActor
SHALL:populate-if-known AU eRequesting Placer
SHALL:no-error AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... occurrence[x] Σ 0..1 When service should occur
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
.... occurrenceTiming Timing
... asNeeded[x] Σ 0..1 Preconditions for service
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc.

.... asNeededBoolean boolean
.... asNeededCodeableConcept CodeableConcept
... authoredOn SOΣC 1..1 dateTime Date request signed
au-ereq-srr-01: Date must include at least year, month, and day
ObligationsActor
SHALL:populate AU eRequesting Placer
SHALL:handle AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
... requester SOΣ 1..1 Reference(AU Core PractitionerRole) Authorising individual, organisation or program (e.g. National Bowel Cancer Screening Program)
ObligationsActor
SHALL:populate AU eRequesting Placer
SHALL:handle AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
... performerType Σ 0..1 CodeableConcept Performer role
Binding: Practitioner Role . (preferred)
... performer Σ 0..* Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) Requested performer
... locationCode Σ 0..* CodeableConcept Requested location
Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered.


... locationReference Σ 0..* Reference(Location) Requested location
... reasonCode SOΣ 0..* CodeableConcept Explanation/Justification for procedure or service
Binding: Reason for Request . (preferred)
ObligationsActor
SHALL:populate-if-known AU eRequesting Placer
SHALL:no-error AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
... reasonReference Σ 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Explanation/Justification for service or service
... insurance SO 0..* Reference(AU eRequesting Coverage) Associated insurance coverage
ObligationsActor
SHALL:populate-if-known AU eRequesting Placer
SHALL:no-error AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
... supportingInfo 0..* Reference(Resource) Additional clinical information
... specimen Σ 0..* Reference(AU Base Specimen) Procedure Samples
... bodySite SOΣ 0..* CodeableConcept Location on Body
Binding: Body Site . (preferred)
ObligationsActor
SHALL:populate-if-known AU eRequesting Placer
SHALL:handle AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
... note SO 0..* Annotation Comments
ObligationsActor
SHALL:populate-if-known AU eRequesting Placer
SHALL:handle AU eRequesting Filler
SHALL:handle AU eRequesting Server
SHALL:able-to-populate AU eRequesting Server
SHALL:no-error AU eRequesting Patient
... patientInstruction Σ 0..1 string Patient or consumer-oriented instructions
... relevantHistory 0..* Reference(Provenance) Request provenance

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ServiceRequest.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
ServiceRequest.requisition.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
ServiceRequest.requisition.typerequiredOrderIdentifierType
http://terminology.hl7.org.au/ValueSet/order-identifier-type
ServiceRequest.requisition.assigner.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
ServiceRequest.statusrequiredAUeRequestingRequestStatus
http://hl7.org.au/fhir/ereq/ValueSet/au-erequesting-request-status
from this IG
ServiceRequest.intentrequiredPattern: order
http://hl7.org/fhir/ValueSet/request-intent|4.0.1
from the FHIR Standard
ServiceRequest.categoryexampleServiceRequestCategoryCodes
http://hl7.org/fhir/ValueSet/servicerequest-category
from the FHIR Standard
ServiceRequest.category:pathexamplePattern: SNOMED-CT Code 108252007
http://hl7.org/fhir/ValueSet/servicerequest-category
from the FHIR Standard
ServiceRequest.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
from the FHIR Standard
ServiceRequest.codepreferredspia-requesting-refset .
https://www.rcpa.edu.au/fhir/ValueSet/spia-requesting-refset-3
ServiceRequest.orderDetailexampleServiceRequestOrderDetailsCodes
http://hl7.org/fhir/ValueSet/servicerequest-orderdetail
from the FHIR Standard
ServiceRequest.encounter.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
ServiceRequest.asNeeded[x]exampleSNOMEDCTMedicationAsNeededReasonCodes
http://hl7.org/fhir/ValueSet/medication-as-needed-reason
from the FHIR Standard
ServiceRequest.performerTypepreferredPractitionerRole .
https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1
ServiceRequest.locationCodeexampleServiceDeliveryLocationRoleType
http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
ServiceRequest.reasonCodepreferredReasonForRequest .
https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1
ServiceRequest.bodySitepreferredBodySite .
https://healthterminologies.gov.au/fhir/ValueSet/body-site-1

This structure is derived from AUeRequestingDiagnosticRequest

Summary

Mandatory: 1 element

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of ServiceRequest.category

Maturity: 0

 

Other representations of profile: CSV, Excel, Schematron

Notes:

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

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

Any search parameter defined in FHIR may be ‘allowed’ by the system unless explicitly marked as “SHALL NOT”.

Parameter(s) Conformance Type(s) Requirements (when used alone or in combination)
_id SHALL token
requisition SHALL token

Mandatory Search Parameters:

The following search parameters and search parameter combinations SHALL be supported:

  1. SHALL support searching using the _id search parameter:

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

    Example:

    1. GET [base]/ServiceRequest?_id=2169591

    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. SHALL support searching using the requisition search parameter:

    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

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