AU eRequesting Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 0.3.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7au/au-fhir-erequesting/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-diagnosticrequest | Version: 0.3.0-ci-build | |||
Standards status: Draft | Maturity Level: 0 | Computable Name: AUeRequestingDiagnosticRequest | ||
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2024+; Licensed Under Creative Commons No Rights Reserved. |
This profile sets minimum expectations for a ServiceRequest resource that is used to record, search, and fetch information about diagnostic requests for a patient. It is based on the AU Base Diagnostic Request and identifies the additional constraints, extensions, vocabularies and value sets that SHALL be present in the ServiceRequest when conforming to this profile.
Input is requested on the appropriateness of allowing Missing Data or Suppressed Data for all elements. Please comment by raising HL7 Jira Issues.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AUBaseDiagnosticRequest
Name | Flags | Card. | Type | Description & Constraints![]() | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
AUBaseDiagnosticRequest | This is an abstract profile. Child profiles: AUeRequestingImagingRequest, AUeRequestingPathologyRequest | ||||||||||||||
![]() ![]() ![]() |
1..* | Extension | Extension | |||||||||||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||||||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | (Complex) | A context-specific sex parameter for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
| ||||||||||||
![]() ![]() ![]() ![]() |
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.
| ||||||||||||
![]() ![]() ![]() ![]() |
SO | 1..1 | integer | AU eRequesting Display Sequence URL: http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-displaysequence
| ||||||||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | CodeableConcept | AU eRequesting Fasting Precondition URL: http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-fastingprecondition Binding: Pathology Fasting Status ![]()
| ||||||||||||
![]() ![]() ![]() |
SO | 0..* | Identifier, AULocalOrderIdentifier | Identifiers assigned to this order
| ||||||||||||
![]() ![]() ![]() |
SO | 1..1 | AULocalOrderIdentifier | Composite Request ID
| ||||||||||||
![]() ![]() ![]() ![]() |
||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PGN | |||||||||||||
![]() ![]() ![]() |
SO | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: AU eRequesting RequestStatus (required)
| ||||||||||||
![]() ![]() ![]() |
SO | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Required Pattern: order
| ||||||||||||
![]() ![]() ![]() |
SO | 1..* | CodeableConcept | Classification of service
| ||||||||||||
![]() ![]() ![]() |
SO | 0..1 | code | routine | urgent | asap | stat
| ||||||||||||
![]() ![]() ![]() |
SO | 1..1 | CodeableConcept | What is being requested/ordered
| ||||||||||||
![]() ![]() ![]() ![]() |
1..1 | string | Plain text representation of the concept | |||||||||||||
![]() ![]() ![]() |
SO | 0..1 | An informative value indicating the number of fulfilments requested. If not provided the quantity is 1. For Rule 3 Exemption, this value may be greater than 1; however, the server does not currently support tracking multiple fulfilments from a single order.
| |||||||||||||
![]() ![]() ![]() ![]() |
Quantity | |||||||||||||||
![]() ![]() ![]() ![]() |
Range | |||||||||||||||
![]() ![]() ![]() |
SO | 1..1 | Reference(AU Core Patient) | Individual or Entity the service is ordered for
| ||||||||||||
![]() ![]() ![]() |
SO | 1..1 | Reference(AU Core Encounter) | Encounter in which the request was created
| ||||||||||||
![]() ![]() ![]() ![]() |
1..1 | string | Literal reference, Relative, internal or absolute URL | |||||||||||||
![]() ![]() ![]() |
SO | 0..1 | dateTime, Period, Timing | This may be used to cover three needs: 1. A target date for the test to be performed. 2. A date range for the test to be performed (possible Rule 3 Exemption use). 3. A frequency for the test to be performed (more complex Rule 3 Exemption use). The server will not process this information which is informative only and there is no alignment to diagnostic service regulations or policy.
| ||||||||||||
![]() ![]() ![]() |
SOC | 1..1 | dateTime | Date request signed au-ereq-srr-01: Date must include at least year, month, and day
| ||||||||||||
![]() ![]() ![]() |
SO | 1..1 | Reference(AU Core PractitionerRole) | Authorising individual, organisation or program (e.g. National Bowel Cancer Screening Program)
| ||||||||||||
![]() ![]() ![]() |
SO | 0..* | CodeableConcept | Explanation/Justification for procedure or service
| ||||||||||||
![]() ![]() ![]() |
SO | 0..* | Reference(AU eRequesting Coverage) | Associated insurance coverage
| ||||||||||||
![]() ![]() ![]() |
0..* | Reference(Resource) | Additional clinical information Slice: Unordered, Open by profile:$this.resolve() | |||||||||||||
![]() ![]() ![]() ![]() |
SOC | 0..1 | Reference(Observation Pregnancy - Status (IPS)) | Additional clinical information au-ereq-srr-02: Pregnancy status must only be Pregnant
| ||||||||||||
![]() ![]() ![]() |
SO | 0..* | CodeableConcept | Location on Body
| ||||||||||||
![]() ![]() ![]() |
SO | 0..* | Annotation | Comments
| ||||||||||||
![]() |
Path | Conformance | ValueSet | URI |
ServiceRequest.status | required | AUeRequestingRequestStatushttp://terminology.hl7.org.au/ValueSet/au-erequesting-request-status from this IG |
Id | Grade | Path(s) | Details | Requirements |
au-ereq-srr-01 | error | ServiceRequest.authoredOn | Date must include at least year, month, and day : $this.toString().length() >= 10 | |
au-ereq-srr-02 | error | ServiceRequest.supportingInfo:pregnancyStatus | Pregnancy status must only be Pregnant : $this.resolve().value.coding.where(system='http://snomed.info/sct').code = '77386006' |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | AUBaseDiagnosticRequest | This is an abstract profile. Child profiles: AUeRequestingImagingRequest, AUeRequestingPathologyRequest Deprecated: A diagnostic service request in an Australian healthcare context dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management prr-1: orderDetail SHALL only be present if code is present | ||||||||||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children | ||||||||||||
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||||||||||
![]() ![]() ![]() ![]() |
0..* | Reference(BodyStructure) | The target point for this procedure URL: http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||||||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | (Complex) | A context-specific sex parameter for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
| ||||||||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | CodeableConcept | Reason for current status URL: http://hl7.org/fhir/StructureDefinition/request-statusReason Binding Description (No ValueSet): (example): Codes identifying the reason for the current state of an event. ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
| ||||||||||||
![]() ![]() ![]() ![]() |
SO | 1..1 | integer | AU eRequesting Display Sequence URL: http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-displaysequence ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
| ||||||||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | CodeableConcept | AU eRequesting Fasting Precondition URL: http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-fastingprecondition Binding: Pathology Fasting Status ![]() ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
| ||||||||||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||||||||||
![]() ![]() ![]() |
SOΣ | 0..* | Identifier, AULocalOrderIdentifier | Identifiers assigned to this order ele-1: All FHIR elements must have a @value or children
| ||||||||||||
![]() ![]() ![]() |
SOΣ | 1..1 | AULocalOrderIdentifier | Composite Request ID ele-1: All FHIR elements must have a @value or children
| ||||||||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children | ||||||||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Coded identifier type for local order identifier Binding: Order Identifier Type (required) ele-1: All FHIR elements must have a @value or children | ||||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following | ||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PGN | |||||||||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | System identifier namespace for the organisation that assigned the order identifier ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient | ||||||||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Order identifier ele-1: All FHIR elements must have a @value or children Example General: 123456 | ||||||||||||
![]() ![]() ![]() |
?!SOΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: AU eRequesting RequestStatus (required) ele-1: All FHIR elements must have a @value or children
| ||||||||||||
![]() ![]() ![]() |
?!SOΣ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. ele-1: All FHIR elements must have a @value or children Required Pattern: order
| ||||||||||||
![]() ![]() ![]() |
SOΣ | 1..* | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. ele-1: All FHIR elements must have a @value or children
| ||||||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. ele-1: All FHIR elements must have a @value or children
| ||||||||||||
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | True if service/procedure should not be performed ele-1: All FHIR elements must have a @value or children | ||||||||||||
![]() ![]() ![]() |
SOΣ | 1..1 | CodeableConcept | What is being requested/ordered Binding: Evaluation Procedure ![]() ele-1: All FHIR elements must have a @value or children
| ||||||||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children | ||||||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | An informative value indicating the number of fulfilments requested. If not provided the quantity is 1. For Rule 3 Exemption, this value may be greater than 1; however, the server does not currently support tracking multiple fulfilments from a single order. ele-1: All FHIR elements must have a @value or children
| |||||||||||||
![]() ![]() ![]() ![]() |
Quantity | |||||||||||||||
![]() ![]() ![]() ![]() |
Range | |||||||||||||||
![]() ![]() ![]() |
SOΣ | 1..1 | Reference(AU Core Patient) | Individual or Entity the service is ordered for ele-1: All FHIR elements must have a @value or children
| ||||||||||||
![]() ![]() ![]() |
SOΣ | 1..1 | Reference(AU Core Encounter) | Encounter in which the request was created ele-1: All FHIR elements must have a @value or children
| ||||||||||||
![]() ![]() ![]() ![]() |
ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children | ||||||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | This may be used to cover three needs: 1. A target date for the test to be performed. 2. A date range for the test to be performed (possible Rule 3 Exemption use). 3. A frequency for the test to be performed (more complex Rule 3 Exemption use). The server will not process this information which is informative only and there is no alignment to diagnostic service regulations or policy. ele-1: All FHIR elements must have a @value or children
| |||||||||||||
![]() ![]() ![]() ![]() |
dateTime | |||||||||||||||
![]() ![]() ![]() ![]() |
Period | |||||||||||||||
![]() ![]() ![]() ![]() |
Timing | |||||||||||||||
![]() ![]() ![]() |
SOΣC | 1..1 | dateTime | Date request signed ele-1: All FHIR elements must have a @value or children au-ereq-srr-01: Date must include at least year, month, and day
| ||||||||||||
![]() ![]() ![]() |
SOΣ | 1..1 | Reference(AU Core PractitionerRole) | Authorising individual, organisation or program (e.g. National Bowel Cancer Screening Program) ele-1: All FHIR elements must have a @value or children
| ||||||||||||
![]() ![]() ![]() |
SOΣ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: Reason for Request ![]() ele-1: All FHIR elements must have a @value or children
| ||||||||||||
![]() ![]() ![]() |
SO | 0..* | Reference(AU eRequesting Coverage) | Associated insurance coverage ele-1: All FHIR elements must have a @value or children
| ||||||||||||
![]() ![]() ![]() |
0..* | Reference(Resource) | Additional clinical information Slice: Unordered, Open by profile:$this.resolve() ele-1: All FHIR elements must have a @value or children | |||||||||||||
![]() ![]() ![]() ![]() |
SOC | 0..1 | Reference(Observation Pregnancy - Status (IPS)) | Additional clinical information ele-1: All FHIR elements must have a @value or children au-ereq-srr-02: Pregnancy status must only be Pregnant
| ||||||||||||
![]() ![]() ![]() |
SOΣ | 0..* | CodeableConcept | Location on Body Binding: Body Site ![]() ele-1: All FHIR elements must have a @value or children
| ||||||||||||
![]() ![]() ![]() |
SO | 0..* | Annotation | Comments ele-1: All FHIR elements must have a @value or children
| ||||||||||||
![]() |
Path | Conformance | ValueSet / Code | URI |
ServiceRequest.requisition.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
ServiceRequest.requisition.type | required | OrderIdentifierTypehttp://terminology.hl7.org.au/ValueSet/order-identifier-type | |
ServiceRequest.status | required | AUeRequestingRequestStatushttp://terminology.hl7.org.au/ValueSet/au-erequesting-request-status from this IG | |
ServiceRequest.intent | required | Pattern: orderhttp://hl7.org/fhir/ValueSet/request-intent|4.0.1 from the FHIR Standard | |
ServiceRequest.category | example | ServiceRequestCategoryCodeshttp://hl7.org/fhir/ValueSet/servicerequest-category from the FHIR Standard | |
ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1 from the FHIR Standard | |
ServiceRequest.code | example | EvaluationProcedure ![]() https://healthterminologies.gov.au/fhir/ValueSet/evaluation-procedure-1 | |
ServiceRequest.reasonCode | preferred | ReasonForRequest ![]() https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 | |
ServiceRequest.bodySite | preferred | BodySite ![]() https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 |
Id | Grade | Path(s) | Details | Requirements |
au-ereq-srr-01 | error | ServiceRequest.authoredOn | Date must include at least year, month, and day : $this.toString().length() >= 10 | |
au-ereq-srr-02 | error | ServiceRequest.supportingInfo:pregnancyStatus | Pregnancy status must only be Pregnant : $this.resolve().value.coding.where(system='http://snomed.info/sct').code = '77386006' |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | AUBaseDiagnosticRequest | This is an abstract profile. Child profiles: AUeRequestingImagingRequest, AUeRequestingPathologyRequest Deprecated: A diagnostic service request in an Australian healthcare context prr-1: orderDetail SHALL only be present if code is present | ||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||||||||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||||||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||||||||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||||||||||
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||||
![]() ![]() ![]() ![]() |
0..* | Reference(BodyStructure) | The target point for this procedure URL: http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure | |||||||||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | (Complex) | A context-specific sex parameter for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
| ||||||||||||
![]() ![]() ![]() ![]() |
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.
| ||||||||||||
![]() ![]() ![]() ![]() |
SO | 1..1 | integer | AU eRequesting Display Sequence URL: http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-displaysequence
| ||||||||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | CodeableConcept | AU eRequesting Fasting Precondition URL: http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-fastingprecondition Binding: Pathology Fasting Status ![]()
| ||||||||||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||
![]() ![]() ![]() |
SOΣ | 0..* | Identifier, AULocalOrderIdentifier | Identifiers assigned to this order
| ||||||||||||
![]() ![]() ![]() |
Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition | ||||||||||||
![]() ![]() ![]() |
Σ | 0..* | uri | Instantiates external protocol or definition | ||||||||||||
![]() ![]() ![]() |
Σ | 0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) | What request fulfills | ||||||||||||
![]() ![]() ![]() |
Σ | 0..* | Reference(ServiceRequest) | What request replaces | ||||||||||||
![]() ![]() ![]() |
SOΣ | 1..1 | AULocalOrderIdentifier | Composite Request ID
| ||||||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||||||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Coded identifier type for local order identifier Binding: Order Identifier Type (required) | ||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following | ||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PGN | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||||||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | System identifier namespace for the organisation that assigned the order identifier Example General: http://www.acme.com/identifiers/patient | ||||||||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Order identifier Example General: 123456 | ||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organisation that assigned the order identifier | ||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 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). | ||||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Name of the assigning organisation | ||||||||||||
![]() ![]() ![]() |
?!SOΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: AU eRequesting RequestStatus (required)
| ||||||||||||
![]() ![]() ![]() |
?!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
| ||||||||||||
![]() ![]() ![]() |
SOΣ | 1..* | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.
| ||||||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
| ||||||||||||
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | True if service/procedure should not be performed | ||||||||||||
![]() ![]() ![]() |
SOΣ | 1..1 | CodeableConcept | What is being requested/ordered Binding: Evaluation Procedure ![]()
| ||||||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system | ||||||||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Plain text representation of the concept | ||||||||||||
![]() ![]() ![]() |
ΣC | 0..* | CodeableConcept | Additional order information Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context. | ||||||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | An informative value indicating the number of fulfilments requested. If not provided the quantity is 1. For Rule 3 Exemption, this value may be greater than 1; however, the server does not currently support tracking multiple fulfilments from a single order.
| |||||||||||||
![]() ![]() ![]() ![]() |
Quantity | |||||||||||||||
![]() ![]() ![]() ![]() |
Range | |||||||||||||||
![]() ![]() ![]() |
SOΣ | 1..1 | Reference(AU Core Patient) | Individual or Entity the service is ordered for
| ||||||||||||
![]() ![]() ![]() |
SOΣ | 1..1 | Reference(AU Core Encounter) | Encounter in which the request was created
| ||||||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
![]() ![]() ![]() ![]() |
ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||||||||||
![]() ![]() ![]() ![]() |
Σ | 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). | ||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | This may be used to cover three needs: 1. A target date for the test to be performed. 2. A date range for the test to be performed (possible Rule 3 Exemption use). 3. A frequency for the test to be performed (more complex Rule 3 Exemption use). The server will not process this information which is informative only and there is no alignment to diagnostic service regulations or policy.
| |||||||||||||
![]() ![]() ![]() ![]() |
dateTime | |||||||||||||||
![]() ![]() ![]() ![]() |
Period | |||||||||||||||
![]() ![]() ![]() ![]() |
Timing | |||||||||||||||
![]() ![]() ![]() |
Σ | 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. | |||||||||||||
![]() ![]() ![]() ![]() |
boolean | |||||||||||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||||||||||
![]() ![]() ![]() |
SOΣC | 1..1 | dateTime | Date request signed au-ereq-srr-01: Date must include at least year, month, and day
| ||||||||||||
![]() ![]() ![]() |
SOΣ | 1..1 | Reference(AU Core PractitionerRole) | Authorising individual, organisation or program (e.g. National Bowel Cancer Screening Program)
| ||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Performer role Binding: Practitioner Role ![]() | ||||||||||||
![]() ![]() ![]() |
Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested performer | ||||||||||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Requested location Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered. | ||||||||||||
![]() ![]() ![]() |
Σ | 0..* | Reference(Location) | Requested location | ||||||||||||
![]() ![]() ![]() |
SOΣ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: Reason for Request ![]()
| ||||||||||||
![]() ![]() ![]() |
Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service | ||||||||||||
![]() ![]() ![]() |
SO | 0..* | Reference(AU eRequesting Coverage) | Associated insurance coverage
| ||||||||||||
![]() ![]() ![]() |
0..* | Reference(Resource) | Additional clinical information Slice: Unordered, Open by profile:$this.resolve() | |||||||||||||
![]() ![]() ![]() ![]() |
SOC | 0..1 | Reference(Observation Pregnancy - Status (IPS)) | Additional clinical information au-ereq-srr-02: Pregnancy status must only be Pregnant
| ||||||||||||
![]() ![]() ![]() |
Σ | 0..* | Reference(AU Base Specimen) | Procedure Samples | ||||||||||||
![]() ![]() ![]() |
SOΣ | 0..* | CodeableConcept | Location on Body Binding: Body Site ![]()
| ||||||||||||
![]() ![]() ![]() |
SO | 0..* | Annotation | Comments
| ||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | string | Patient or consumer-oriented instructions | ||||||||||||
![]() ![]() ![]() |
0..* | Reference(Provenance) | Request provenance | |||||||||||||
![]() |
Path | Conformance | ValueSet / Code | URI | |||
ServiceRequest.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
ServiceRequest.requisition.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
ServiceRequest.requisition.type | required | OrderIdentifierTypehttp://terminology.hl7.org.au/ValueSet/order-identifier-type | ||||
ServiceRequest.requisition.assigner.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
ServiceRequest.status | required | AUeRequestingRequestStatushttp://terminology.hl7.org.au/ValueSet/au-erequesting-request-status from this IG | ||||
ServiceRequest.intent | required | Pattern: orderhttp://hl7.org/fhir/ValueSet/request-intent|4.0.1 from the FHIR Standard | ||||
ServiceRequest.category | example | ServiceRequestCategoryCodeshttp://hl7.org/fhir/ValueSet/servicerequest-category from the FHIR Standard | ||||
ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1 from the FHIR Standard | ||||
ServiceRequest.code | example | EvaluationProcedure ![]() https://healthterminologies.gov.au/fhir/ValueSet/evaluation-procedure-1 | ||||
ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodeshttp://hl7.org/fhir/ValueSet/servicerequest-orderdetail from the FHIR Standard | ||||
ServiceRequest.encounter.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reason from the FHIR Standard | ||||
ServiceRequest.performerType | preferred | PractitionerRole ![]() https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 | ||||
ServiceRequest.locationCode | example | ServiceDeliveryLocationRoleTypehttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType | ||||
ServiceRequest.reasonCode | preferred | ReasonForRequest ![]() https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 | ||||
ServiceRequest.bodySite | preferred | BodySite ![]() https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 |
Id | Grade | Path(s) | Details | Requirements |
au-ereq-srr-01 | error | ServiceRequest.authoredOn | Date must include at least year, month, and day : $this.toString().length() >= 10 | |
au-ereq-srr-02 | error | ServiceRequest.supportingInfo:pregnancyStatus | Pregnancy status must only be Pregnant : $this.resolve().value.coding.where(system='http://snomed.info/sct').code = '77386006' |
This structure is derived from AUBaseDiagnosticRequest
Summary
Mandatory: 11 elements
Must-Support: 22 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 0
Differential View
This structure is derived from AUBaseDiagnosticRequest
Name | Flags | Card. | Type | Description & Constraints![]() | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
AUBaseDiagnosticRequest | This is an abstract profile. Child profiles: AUeRequestingImagingRequest, AUeRequestingPathologyRequest | ||||||||||||||
![]() ![]() ![]() |
1..* | Extension | Extension | |||||||||||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||||||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | (Complex) | A context-specific sex parameter for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
| ||||||||||||
![]() ![]() ![]() ![]() |
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.
| ||||||||||||
![]() ![]() ![]() ![]() |
SO | 1..1 | integer | AU eRequesting Display Sequence URL: http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-displaysequence
| ||||||||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | CodeableConcept | AU eRequesting Fasting Precondition URL: http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-fastingprecondition Binding: Pathology Fasting Status ![]()
| ||||||||||||
![]() ![]() ![]() |
SO | 0..* | Identifier, AULocalOrderIdentifier | Identifiers assigned to this order
| ||||||||||||
![]() ![]() ![]() |
SO | 1..1 | AULocalOrderIdentifier | Composite Request ID
| ||||||||||||
![]() ![]() ![]() ![]() |
||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PGN | |||||||||||||
![]() ![]() ![]() |
SO | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: AU eRequesting RequestStatus (required)
| ||||||||||||
![]() ![]() ![]() |
SO | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Required Pattern: order
| ||||||||||||
![]() ![]() ![]() |
SO | 1..* | CodeableConcept | Classification of service
| ||||||||||||
![]() ![]() ![]() |
SO | 0..1 | code | routine | urgent | asap | stat
| ||||||||||||
![]() ![]() ![]() |
SO | 1..1 | CodeableConcept | What is being requested/ordered
| ||||||||||||
![]() ![]() ![]() ![]() |
1..1 | string | Plain text representation of the concept | |||||||||||||
![]() ![]() ![]() |
SO | 0..1 | An informative value indicating the number of fulfilments requested. If not provided the quantity is 1. For Rule 3 Exemption, this value may be greater than 1; however, the server does not currently support tracking multiple fulfilments from a single order.
| |||||||||||||
![]() ![]() ![]() ![]() |
Quantity | |||||||||||||||
![]() ![]() ![]() ![]() |
Range | |||||||||||||||
![]() ![]() ![]() |
SO | 1..1 | Reference(AU Core Patient) | Individual or Entity the service is ordered for
| ||||||||||||
![]() ![]() ![]() |
SO | 1..1 | Reference(AU Core Encounter) | Encounter in which the request was created
| ||||||||||||
![]() ![]() ![]() ![]() |
1..1 | string | Literal reference, Relative, internal or absolute URL | |||||||||||||
![]() ![]() ![]() |
SO | 0..1 | dateTime, Period, Timing | This may be used to cover three needs: 1. A target date for the test to be performed. 2. A date range for the test to be performed (possible Rule 3 Exemption use). 3. A frequency for the test to be performed (more complex Rule 3 Exemption use). The server will not process this information which is informative only and there is no alignment to diagnostic service regulations or policy.
| ||||||||||||
![]() ![]() ![]() |
SOC | 1..1 | dateTime | Date request signed au-ereq-srr-01: Date must include at least year, month, and day
| ||||||||||||
![]() ![]() ![]() |
SO | 1..1 | Reference(AU Core PractitionerRole) | Authorising individual, organisation or program (e.g. National Bowel Cancer Screening Program)
| ||||||||||||
![]() ![]() ![]() |
SO | 0..* | CodeableConcept | Explanation/Justification for procedure or service
| ||||||||||||
![]() ![]() ![]() |
SO | 0..* | Reference(AU eRequesting Coverage) | Associated insurance coverage
| ||||||||||||
![]() ![]() ![]() |
0..* | Reference(Resource) | Additional clinical information Slice: Unordered, Open by profile:$this.resolve() | |||||||||||||
![]() ![]() ![]() ![]() |
SOC | 0..1 | Reference(Observation Pregnancy - Status (IPS)) | Additional clinical information au-ereq-srr-02: Pregnancy status must only be Pregnant
| ||||||||||||
![]() ![]() ![]() |
SO | 0..* | CodeableConcept | Location on Body
| ||||||||||||
![]() ![]() ![]() |
SO | 0..* | Annotation | Comments
| ||||||||||||
![]() |
Path | Conformance | ValueSet | URI |
ServiceRequest.status | required | AUeRequestingRequestStatushttp://terminology.hl7.org.au/ValueSet/au-erequesting-request-status from this IG |
Id | Grade | Path(s) | Details | Requirements |
au-ereq-srr-01 | error | ServiceRequest.authoredOn | Date must include at least year, month, and day : $this.toString().length() >= 10 | |
au-ereq-srr-02 | error | ServiceRequest.supportingInfo:pregnancyStatus | Pregnancy status must only be Pregnant : $this.resolve().value.coding.where(system='http://snomed.info/sct').code = '77386006' |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | AUBaseDiagnosticRequest | This is an abstract profile. Child profiles: AUeRequestingImagingRequest, AUeRequestingPathologyRequest Deprecated: A diagnostic service request in an Australian healthcare context dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management prr-1: orderDetail SHALL only be present if code is present | ||||||||||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children | ||||||||||||
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||||||||||
![]() ![]() ![]() ![]() |
0..* | Reference(BodyStructure) | The target point for this procedure URL: http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||||||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | (Complex) | A context-specific sex parameter for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
| ||||||||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | CodeableConcept | Reason for current status URL: http://hl7.org/fhir/StructureDefinition/request-statusReason Binding Description (No ValueSet): (example): Codes identifying the reason for the current state of an event. ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
| ||||||||||||
![]() ![]() ![]() ![]() |
SO | 1..1 | integer | AU eRequesting Display Sequence URL: http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-displaysequence ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
| ||||||||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | CodeableConcept | AU eRequesting Fasting Precondition URL: http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-fastingprecondition Binding: Pathology Fasting Status ![]() ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
| ||||||||||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||||||||||
![]() ![]() ![]() |
SOΣ | 0..* | Identifier, AULocalOrderIdentifier | Identifiers assigned to this order ele-1: All FHIR elements must have a @value or children
| ||||||||||||
![]() ![]() ![]() |
SOΣ | 1..1 | AULocalOrderIdentifier | Composite Request ID ele-1: All FHIR elements must have a @value or children
| ||||||||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children | ||||||||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Coded identifier type for local order identifier Binding: Order Identifier Type (required) ele-1: All FHIR elements must have a @value or children | ||||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following | ||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PGN | |||||||||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | System identifier namespace for the organisation that assigned the order identifier ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient | ||||||||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Order identifier ele-1: All FHIR elements must have a @value or children Example General: 123456 | ||||||||||||
![]() ![]() ![]() |
?!SOΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: AU eRequesting RequestStatus (required) ele-1: All FHIR elements must have a @value or children
| ||||||||||||
![]() ![]() ![]() |
?!SOΣ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. ele-1: All FHIR elements must have a @value or children Required Pattern: order
| ||||||||||||
![]() ![]() ![]() |
SOΣ | 1..* | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. ele-1: All FHIR elements must have a @value or children
| ||||||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. ele-1: All FHIR elements must have a @value or children
| ||||||||||||
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | True if service/procedure should not be performed ele-1: All FHIR elements must have a @value or children | ||||||||||||
![]() ![]() ![]() |
SOΣ | 1..1 | CodeableConcept | What is being requested/ordered Binding: Evaluation Procedure ![]() ele-1: All FHIR elements must have a @value or children
| ||||||||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children | ||||||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | An informative value indicating the number of fulfilments requested. If not provided the quantity is 1. For Rule 3 Exemption, this value may be greater than 1; however, the server does not currently support tracking multiple fulfilments from a single order. ele-1: All FHIR elements must have a @value or children
| |||||||||||||
![]() ![]() ![]() ![]() |
Quantity | |||||||||||||||
![]() ![]() ![]() ![]() |
Range | |||||||||||||||
![]() ![]() ![]() |
SOΣ | 1..1 | Reference(AU Core Patient) | Individual or Entity the service is ordered for ele-1: All FHIR elements must have a @value or children
| ||||||||||||
![]() ![]() ![]() |
SOΣ | 1..1 | Reference(AU Core Encounter) | Encounter in which the request was created ele-1: All FHIR elements must have a @value or children
| ||||||||||||
![]() ![]() ![]() ![]() |
ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children | ||||||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | This may be used to cover three needs: 1. A target date for the test to be performed. 2. A date range for the test to be performed (possible Rule 3 Exemption use). 3. A frequency for the test to be performed (more complex Rule 3 Exemption use). The server will not process this information which is informative only and there is no alignment to diagnostic service regulations or policy. ele-1: All FHIR elements must have a @value or children
| |||||||||||||
![]() ![]() ![]() ![]() |
dateTime | |||||||||||||||
![]() ![]() ![]() ![]() |
Period | |||||||||||||||
![]() ![]() ![]() ![]() |
Timing | |||||||||||||||
![]() ![]() ![]() |
SOΣC | 1..1 | dateTime | Date request signed ele-1: All FHIR elements must have a @value or children au-ereq-srr-01: Date must include at least year, month, and day
| ||||||||||||
![]() ![]() ![]() |
SOΣ | 1..1 | Reference(AU Core PractitionerRole) | Authorising individual, organisation or program (e.g. National Bowel Cancer Screening Program) ele-1: All FHIR elements must have a @value or children
| ||||||||||||
![]() ![]() ![]() |
SOΣ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: Reason for Request ![]() ele-1: All FHIR elements must have a @value or children
| ||||||||||||
![]() ![]() ![]() |
SO | 0..* | Reference(AU eRequesting Coverage) | Associated insurance coverage ele-1: All FHIR elements must have a @value or children
| ||||||||||||
![]() ![]() ![]() |
0..* | Reference(Resource) | Additional clinical information Slice: Unordered, Open by profile:$this.resolve() ele-1: All FHIR elements must have a @value or children | |||||||||||||
![]() ![]() ![]() ![]() |
SOC | 0..1 | Reference(Observation Pregnancy - Status (IPS)) | Additional clinical information ele-1: All FHIR elements must have a @value or children au-ereq-srr-02: Pregnancy status must only be Pregnant
| ||||||||||||
![]() ![]() ![]() |
SOΣ | 0..* | CodeableConcept | Location on Body Binding: Body Site ![]() ele-1: All FHIR elements must have a @value or children
| ||||||||||||
![]() ![]() ![]() |
SO | 0..* | Annotation | Comments ele-1: All FHIR elements must have a @value or children
| ||||||||||||
![]() |
Path | Conformance | ValueSet / Code | URI |
ServiceRequest.requisition.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
ServiceRequest.requisition.type | required | OrderIdentifierTypehttp://terminology.hl7.org.au/ValueSet/order-identifier-type | |
ServiceRequest.status | required | AUeRequestingRequestStatushttp://terminology.hl7.org.au/ValueSet/au-erequesting-request-status from this IG | |
ServiceRequest.intent | required | Pattern: orderhttp://hl7.org/fhir/ValueSet/request-intent|4.0.1 from the FHIR Standard | |
ServiceRequest.category | example | ServiceRequestCategoryCodeshttp://hl7.org/fhir/ValueSet/servicerequest-category from the FHIR Standard | |
ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1 from the FHIR Standard | |
ServiceRequest.code | example | EvaluationProcedure ![]() https://healthterminologies.gov.au/fhir/ValueSet/evaluation-procedure-1 | |
ServiceRequest.reasonCode | preferred | ReasonForRequest ![]() https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 | |
ServiceRequest.bodySite | preferred | BodySite ![]() https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 |
Id | Grade | Path(s) | Details | Requirements |
au-ereq-srr-01 | error | ServiceRequest.authoredOn | Date must include at least year, month, and day : $this.toString().length() >= 10 | |
au-ereq-srr-02 | error | ServiceRequest.supportingInfo:pregnancyStatus | Pregnancy status must only be Pregnant : $this.resolve().value.coding.where(system='http://snomed.info/sct').code = '77386006' |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | AUBaseDiagnosticRequest | This is an abstract profile. Child profiles: AUeRequestingImagingRequest, AUeRequestingPathologyRequest Deprecated: A diagnostic service request in an Australian healthcare context prr-1: orderDetail SHALL only be present if code is present | ||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||||||||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||||||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||||||||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||||||||||
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||||
![]() ![]() ![]() ![]() |
0..* | Reference(BodyStructure) | The target point for this procedure URL: http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure | |||||||||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | (Complex) | A context-specific sex parameter for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
| ||||||||||||
![]() ![]() ![]() ![]() |
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.
| ||||||||||||
![]() ![]() ![]() ![]() |
SO | 1..1 | integer | AU eRequesting Display Sequence URL: http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-displaysequence
| ||||||||||||
![]() ![]() ![]() ![]() |
SO | 0..1 | CodeableConcept | AU eRequesting Fasting Precondition URL: http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-fastingprecondition Binding: Pathology Fasting Status ![]()
| ||||||||||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||
![]() ![]() ![]() |
SOΣ | 0..* | Identifier, AULocalOrderIdentifier | Identifiers assigned to this order
| ||||||||||||
![]() ![]() ![]() |
Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition | ||||||||||||
![]() ![]() ![]() |
Σ | 0..* | uri | Instantiates external protocol or definition | ||||||||||||
![]() ![]() ![]() |
Σ | 0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) | What request fulfills | ||||||||||||
![]() ![]() ![]() |
Σ | 0..* | Reference(ServiceRequest) | What request replaces | ||||||||||||
![]() ![]() ![]() |
SOΣ | 1..1 | AULocalOrderIdentifier | Composite Request ID
| ||||||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||||||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Coded identifier type for local order identifier Binding: Order Identifier Type (required) | ||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following | ||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PGN | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||||||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | System identifier namespace for the organisation that assigned the order identifier Example General: http://www.acme.com/identifiers/patient | ||||||||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Order identifier Example General: 123456 | ||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organisation that assigned the order identifier | ||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 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). | ||||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||||||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Name of the assigning organisation | ||||||||||||
![]() ![]() ![]() |
?!SOΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: AU eRequesting RequestStatus (required)
| ||||||||||||
![]() ![]() ![]() |
?!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
| ||||||||||||
![]() ![]() ![]() |
SOΣ | 1..* | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.
| ||||||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
| ||||||||||||
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | True if service/procedure should not be performed | ||||||||||||
![]() ![]() ![]() |
SOΣ | 1..1 | CodeableConcept | What is being requested/ordered Binding: Evaluation Procedure ![]()
| ||||||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system | ||||||||||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Plain text representation of the concept | ||||||||||||
![]() ![]() ![]() |
ΣC | 0..* | CodeableConcept | Additional order information Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context. | ||||||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | An informative value indicating the number of fulfilments requested. If not provided the quantity is 1. For Rule 3 Exemption, this value may be greater than 1; however, the server does not currently support tracking multiple fulfilments from a single order.
| |||||||||||||
![]() ![]() ![]() ![]() |
Quantity | |||||||||||||||
![]() ![]() ![]() ![]() |
Range | |||||||||||||||
![]() ![]() ![]() |
SOΣ | 1..1 | Reference(AU Core Patient) | Individual or Entity the service is ordered for
| ||||||||||||
![]() ![]() ![]() |
SOΣ | 1..1 | Reference(AU Core Encounter) | Encounter in which the request was created
| ||||||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
![]() ![]() ![]() ![]() |
ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||||||||||
![]() ![]() ![]() ![]() |
Σ | 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). | ||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||||||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||||||||||
![]() ![]() ![]() |
SOΣ | 0..1 | This may be used to cover three needs: 1. A target date for the test to be performed. 2. A date range for the test to be performed (possible Rule 3 Exemption use). 3. A frequency for the test to be performed (more complex Rule 3 Exemption use). The server will not process this information which is informative only and there is no alignment to diagnostic service regulations or policy.
| |||||||||||||
![]() ![]() ![]() ![]() |
dateTime | |||||||||||||||
![]() ![]() ![]() ![]() |
Period | |||||||||||||||
![]() ![]() ![]() ![]() |
Timing | |||||||||||||||
![]() ![]() ![]() |
Σ | 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. | |||||||||||||
![]() ![]() ![]() ![]() |
boolean | |||||||||||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||||||||||
![]() ![]() ![]() |
SOΣC | 1..1 | dateTime | Date request signed au-ereq-srr-01: Date must include at least year, month, and day
| ||||||||||||
![]() ![]() ![]() |
SOΣ | 1..1 | Reference(AU Core PractitionerRole) | Authorising individual, organisation or program (e.g. National Bowel Cancer Screening Program)
| ||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Performer role Binding: Practitioner Role ![]() | ||||||||||||
![]() ![]() ![]() |
Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested performer | ||||||||||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Requested location Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered. | ||||||||||||
![]() ![]() ![]() |
Σ | 0..* | Reference(Location) | Requested location | ||||||||||||
![]() ![]() ![]() |
SOΣ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: Reason for Request ![]()
| ||||||||||||
![]() ![]() ![]() |
Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service | ||||||||||||
![]() ![]() ![]() |
SO | 0..* | Reference(AU eRequesting Coverage) | Associated insurance coverage
| ||||||||||||
![]() ![]() ![]() |
0..* | Reference(Resource) | Additional clinical information Slice: Unordered, Open by profile:$this.resolve() | |||||||||||||
![]() ![]() ![]() ![]() |
SOC | 0..1 | Reference(Observation Pregnancy - Status (IPS)) | Additional clinical information au-ereq-srr-02: Pregnancy status must only be Pregnant
| ||||||||||||
![]() ![]() ![]() |
Σ | 0..* | Reference(AU Base Specimen) | Procedure Samples | ||||||||||||
![]() ![]() ![]() |
SOΣ | 0..* | CodeableConcept | Location on Body Binding: Body Site ![]()
| ||||||||||||
![]() ![]() ![]() |
SO | 0..* | Annotation | Comments
| ||||||||||||
![]() ![]() ![]() |
Σ | 0..1 | string | Patient or consumer-oriented instructions | ||||||||||||
![]() ![]() ![]() |
0..* | Reference(Provenance) | Request provenance | |||||||||||||
![]() |
Path | Conformance | ValueSet / Code | URI | |||
ServiceRequest.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
ServiceRequest.requisition.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
ServiceRequest.requisition.type | required | OrderIdentifierTypehttp://terminology.hl7.org.au/ValueSet/order-identifier-type | ||||
ServiceRequest.requisition.assigner.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
ServiceRequest.status | required | AUeRequestingRequestStatushttp://terminology.hl7.org.au/ValueSet/au-erequesting-request-status from this IG | ||||
ServiceRequest.intent | required | Pattern: orderhttp://hl7.org/fhir/ValueSet/request-intent|4.0.1 from the FHIR Standard | ||||
ServiceRequest.category | example | ServiceRequestCategoryCodeshttp://hl7.org/fhir/ValueSet/servicerequest-category from the FHIR Standard | ||||
ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1 from the FHIR Standard | ||||
ServiceRequest.code | example | EvaluationProcedure ![]() https://healthterminologies.gov.au/fhir/ValueSet/evaluation-procedure-1 | ||||
ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodeshttp://hl7.org/fhir/ValueSet/servicerequest-orderdetail from the FHIR Standard | ||||
ServiceRequest.encounter.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reason from the FHIR Standard | ||||
ServiceRequest.performerType | preferred | PractitionerRole ![]() https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 | ||||
ServiceRequest.locationCode | example | ServiceDeliveryLocationRoleTypehttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType | ||||
ServiceRequest.reasonCode | preferred | ReasonForRequest ![]() https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 | ||||
ServiceRequest.bodySite | preferred | BodySite ![]() https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 |
Id | Grade | Path(s) | Details | Requirements |
au-ereq-srr-01 | error | ServiceRequest.authoredOn | Date must include at least year, month, and day : $this.toString().length() >= 10 | |
au-ereq-srr-02 | error | ServiceRequest.supportingInfo:pregnancyStatus | Pregnancy status must only be Pregnant : $this.resolve().value.coding.where(system='http://snomed.info/sct').code = '77386006' |
This structure is derived from AUBaseDiagnosticRequest
Summary
Mandatory: 11 elements
Must-Support: 22 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron
Below is an overview of the mandatory and optional search parameters and combined search parameters. See the AU eRequesting CapabilityStatements for a complete list of supported RESTful interactions for this IG.
FHIR search operations are described here and the syntax used to describe AU eRequesting interactions is defined here.
Any search parameter defined in FHIR may be ‘allowed’ by the system unless explicitly marked as “SHALL NOT”.
Parameter(s) | Server Conformance | Placer Conformance | Filler Conformance | Patient Conformance | Type(s) | Requirements (when used alone or in combination) |
---|---|---|---|---|---|---|
_id | SHALL | MAY | MAY | MAY | token |
|
requisition | SHALL | MAY | MAY | MAY | token |
|
_include=ServiceRequest:patient | SHALL | SHOULD | SHOULD | SHOULD | reference |
Modifies search results from a query using other search parameters by including the referenced focus resource |
_include=ServiceRequest:requester | SHALL | SHOULD | SHOULD | SHOULD | reference |
Modifies search results from a query using other search parameters by including the referenced focus resource |
_include=ServiceRequest:encounter | SHOULD | SHOULD | SHOULD | SHOULD | reference |
Modifies search results from a query using other search parameters by including the referenced focus resource |
The following search parameters and search parameter combinations are supported. Conformance obligations are detailed in the table above.
_id
search parameter
_include
parameters: ServiceRequest:patient
,ServiceRequest:requester
,ServiceRequest:encounter
GET [base]/ServiceRequest?_id=[id]
Example:
Implementation Notes: Fetches a bundle with the requested ServiceRequest, instead of just the resource itself, and allows for the inclusion of additional search parameters such as _include, _revinclude, or _lastUpdated (how to search by id of the resource)
requisition
search parameter
_include
parameters: ServiceRequest:patient
,ServiceRequest:requester
,ServiceRequest:encounter
GET [base]/ServiceRequest?requisition={system|}{code}
Example:
Implementation Notes: Fetches a bundle of all ServiceRequest resources for the specified requisition identifier (how to search by token)
IG © 2024 HL7 Australia. Package hl7.fhir.au.ereq#0.3.0-ci-build based on FHIR 4.0.1. Generated 2025-04-03
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change