AU eRequesting Implementation Guide
1.0.0-ballot - Ballot
AU eRequesting Implementation Guide
1.0.0-ballot - Ballot
AU eRequesting Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot 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: 1.0.0-ballot | |||
| Standards status: Draft | Maturity Level: 1 | Computable Name: AUeRequestingDiagnosticRequest | ||
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2024+; Licensed Under Creative Commons No Rights Reserved. |
||||
This profile sets minimum expectations for a ServiceRequest resource that is used to record, search, and fetch information about diagnostic requests for a patient. It is based on the AU Base ServiceRequest and identifies the additional constraints, extensions, vocabularies and value sets that SHALL be present in the ServiceRequest when conforming to this profile.
ServiceRequest.supportingInfo can be referenced by all ServiceRequests in a group when the information applies across the group, or by individual ServiceRequests when the information is specific to particular requests. ServiceRequest.supportingInfo is used to represent the following additional clinical information accompanying the request:
ServiceRequest.supportingInfo:pregnancyStatus referencing an Observation Pregnancy - Status (IPS).ServiceRequest.supportingInfo:clinicalContext referencing an AU eRequesting Clinical Context DocumentReference.text/plain) embedded inline using DocumentReference.content.attachment.data (base64-encoded).ServiceRequest.note can be used for clinical notes, it is limited to notes bound to a single ServiceRequest. ServiceRequest.supportingInfo:clinicalContext allows the same clinical context to be referenced across multiple related ServiceRequests.
ServiceRequest.note.ServiceRequest.supportingInfo and ServiceRequest.note SHALL be unique and not overlap.Usages:
You can also check for usages in the FHIR IG Statistics
Changes since version 0.1.0-ballot:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AUBaseServiceRequest
| Path | Conformance | ValueSet | URI |
| ServiceRequest.status | required | AUeRequestingRequestStatushttp://terminology.hl7.org.au/ValueSet/au-erequesting-request-statusFrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| au-ereq-srr-01 | error | ServiceRequest.authoredOn | Date shall include at least year, month, and day : $this.toString().length() >= 10 | |
| au-ereq-srr-02 | error | ServiceRequest.supportingInfo:pregnancyStatus | Pregnancy status shall be pregnant (SNOMED CT code 77386006) : $this.resolve().value.coding.where(system = 'http://snomed.info/sct' and code = '77386006').exists() |
| Name | Flags | Card. | Type | Description & Constraints Filter:   | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
  ServiceRequest |
C | 0..* | AUBaseServiceRequest | This is an abstract profile. Child profiles: AUeRequestingImagingRequest, AUeRequestingPathologyRequest A service request in an Australian healthcare context Constraints: prr-1 | ||||||||||||
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||||||
 Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||||
   extension:sexParameterForClinicalUse |
SO | 0..1 | (Complex) | A context-specific sex parameter for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
| ||||||||||||
| extension:targetBodyStructure |
0..* | Reference(BodyStructure) | The target point for this procedure URL: http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure | |||||||||||||
| extension:statusReason |
SO | 0..1 | CodeableConcept | Reason for current status URL: http://hl7.org/fhir/StructureDefinition/request-statusReason Binding Description: (example): Codes identifying the reason for the current state of an event.
| ||||||||||||
| extension:displaySequence |
SO | 1..1 | integer | Display sequence URL: http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-displaysequence
| ||||||||||||
 extension:fastingPrecondition |
SO | 0..1 | CodeableConcept | Fasting precondition URL: http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-fastingprecondition Binding: Pathology Fasting Status  (required)
| ||||||||||||
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||
 identifier |
SOΣ | 0..* | Identifier, AULocalOrderIdentifier | Identifiers assigned to this order
| ||||||||||||
| requisition |
SOΣ | 1..1 | AULocalOrderIdentifier | Composite Request ID
| ||||||||||||
| 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 | ||||||||||||
 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 | |||||||||||||
| system |
Σ | 1..1 | uri | System identifier namespace for the organisation that assigned the order identifier Example General: http://www.acme.com/identifiers/patient | ||||||||||||
| value |
Σ | 1..1 | string | Order identifier Example General: 123456 | ||||||||||||
| status |
?!SOΣ | 1..1 | code | The status of the request Binding: AU eRequesting RequestStatus (required)
| ||||||||||||
| 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
| ||||||||||||
| category |
SOΣ | 1..* | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.
| ||||||||||||
| priority |
SOΣ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
| ||||||||||||
| doNotPerform |
?!Σ | 0..1 | boolean | True if service/procedure should not be performed | ||||||||||||
| code |
SOΣ | 1..1 | CodeableConcept | What is being requested/ordered Binding: Procedure (example)
| ||||||||||||
| text |
Σ | 1..1 | string | Plain text representation of the concept | ||||||||||||
 quantity[x] |
SOΣ | 0..1 | An informative value indicating the number of fulfilments requested. If not provided the quantity is 1. For Rule 3 Exemption, this value may be greater than 1; however, the server does not currently support tracking multiple fulfilments from a single order.
| |||||||||||||
| quantityQuantity |
Quantity | |||||||||||||||
| quantityRange |
Range | |||||||||||||||
 subject |
SOΣ | 1..1 | Reference(AU Core Patient) | Individual or Entity the service is ordered for
| ||||||||||||
| encounter |
SOΣ | 1..1 | Reference(AU Core Encounter) | Encounter in which the request was created
| ||||||||||||
| reference |
ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||||||||||
| occurrence[x] |
SOΣ | 0..1 | This may be used to cover three needs: 1. A target date for the test to be performed. 2. A date range for the test to be performed (possible Rule 3 Exemption use). 3. A frequency for the test to be performed (more complex Rule 3 Exemption use). The server will not process this information which is informative only and there is no alignment to diagnostic service regulations or policy.
| |||||||||||||
| occurrenceDateTime |
dateTime | |||||||||||||||
| occurrencePeriod |
Period | |||||||||||||||
| occurrenceTiming |
Timing | |||||||||||||||
| authoredOn |
SOΣC | 1..1 | dateTime | Date request signed Constraints: au-ereq-srr-01
| ||||||||||||
| requester |
SOΣ | 1..1 | Reference(AU Core PractitionerRole) | Who/what is requesting service
| ||||||||||||
| reasonCode |
SOΣ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: Reason for Request (preferred)
| ||||||||||||
| insurance |
SO | 0..* | Reference(AU eRequesting Coverage) | Associated insurance coverage
| ||||||||||||
 Slices for supportingInfo |
0..* | Reference(Resource) | Additional clinical information Slice: Unordered, Open by profile:$this.resolve() | |||||||||||||
| supportingInfo:pregnancyStatus |
SOC | 0..1 | Reference(Observation - Pregnancy: status) | The patient's pregnancy status Constraints: au-ereq-srr-02
| ||||||||||||
| supportingInfo:clinicalContext |
SO | 0..* | Reference(AU eRequesting Clinical Context DocumentReference) | Clinical context narrative information providing an overview of the patient's current clinical situation
| ||||||||||||
| bodySite |
SOΣ | 0..* | CodeableConcept | Location on Body Binding: Body Site (preferred)
| ||||||||||||
| note |
SO | 0..* | Annotation | Comments
| ||||||||||||
| Documentation for this format | ||||||||||||||||
| Path | Conformance | ValueSet / Code | URI |
| ServiceRequest.requisition.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From 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-statusFrom this IG | |
| ServiceRequest.intent | required | Pattern Value: orderhttp://hl7.org/fhir/ValueSet/request-intent|4.0.1From the FHIR Standard | |
| ServiceRequest.category | example | ServiceRequestCategoryCodeshttp://hl7.org/fhir/ValueSet/servicerequest-categoryFrom the FHIR Standard | |
| ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1From the FHIR Standard | |
| ServiceRequest.code | example | Procedure https://healthterminologies.gov.au/fhir/ValueSet/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 shall include at least year, month, and day : $this.toString().length() >= 10 | |
| au-ereq-srr-02 | error | ServiceRequest.supportingInfo:pregnancyStatus | Pregnancy status shall be pregnant (SNOMED CT code 77386006) : $this.resolve().value.coding.where(system = 'http://snomed.info/sct' and code = '77386006').exists() | |
| dom-2 | error | ServiceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | ServiceRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ServiceRequest | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present : orderDetail.empty() or code.exists() |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ServiceRequest |
C | 0..* | AUBaseServiceRequest | This is an abstract profile. Child profiles: AUeRequestingImagingRequest, AUeRequestingPathologyRequest A service request in an Australian healthcare context Constraints: prr-1 | ||||||||||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||||||||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||||||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||||||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||||||||||
| contained |
0..* | Resource | Contained, inline Resources | |||||||||||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||||
| extension:sexParameterForClinicalUse |
SO | 0..1 | (Complex) | A context-specific sex parameter for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
| ||||||||||||
| extension:targetBodyStructure |
0..* | Reference(BodyStructure) | The target point for this procedure URL: http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure | |||||||||||||
| extension:statusReason |
SO | 0..1 | CodeableConcept | Reason for current status URL: http://hl7.org/fhir/StructureDefinition/request-statusReason Binding Description: (example): Codes identifying the reason for the current state of an event.
| ||||||||||||
| extension:displaySequence |
SO | 1..1 | integer | Display sequence URL: http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-displaysequence
| ||||||||||||
| extension:fastingPrecondition |
SO | 0..1 | CodeableConcept | Fasting precondition URL: http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-fastingprecondition Binding: Pathology Fasting Status (required)
| ||||||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||
| identifier |
SOΣ | 0..* | Identifier, AULocalOrderIdentifier | Identifiers assigned to this order
| ||||||||||||
| instantiatesCanonical |
Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition | ||||||||||||
| instantiatesUri |
Σ | 0..* | uri | Instantiates external protocol or definition | ||||||||||||
| basedOn |
Σ | 0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) | What request fulfills | ||||||||||||
| replaces |
Σ | 0..* | Reference(ServiceRequest) | What request replaces | ||||||||||||
| requisition |
SOΣ | 1..1 | AULocalOrderIdentifier | Composite Request ID
| ||||||||||||
| 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 | The status of the request Binding: AU eRequesting RequestStatus (required)
| ||||||||||||
| 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
| ||||||||||||
| category |
SOΣ | 1..* | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.
| ||||||||||||
| priority |
SOΣ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
| ||||||||||||
| doNotPerform |
?!Σ | 0..1 | boolean | True if service/procedure should not be performed | ||||||||||||
| code |
SOΣ | 1..1 | CodeableConcept | What is being requested/ordered Binding: Procedure (example)
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||||||||||
| text |
Σ | 1..1 | string | Plain text representation of the concept | ||||||||||||
| orderDetail |
ΣC | 0..* | CodeableConcept | Additional order information Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context. | ||||||||||||
| quantity[x] |
SOΣ | 0..1 | An informative value indicating the number of fulfilments requested. If not provided the quantity is 1. For Rule 3 Exemption, this value may be greater than 1; however, the server does not currently support tracking multiple fulfilments from a single order.
| |||||||||||||
| quantityQuantity |
Quantity | |||||||||||||||
| quantityRange |
Range | |||||||||||||||
| subject |
SOΣ | 1..1 | Reference(AU Core Patient) | Individual or Entity the service is ordered for
| ||||||||||||
| encounter |
SOΣ | 1..1 | Reference(AU Core Encounter) | Encounter in which the request was created
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| reference |
ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||||||||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||||||||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||||||||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||||||||||
| occurrence[x] |
SOΣ | 0..1 | This may be used to cover three needs: 1. A target date for the test to be performed. 2. A date range for the test to be performed (possible Rule 3 Exemption use). 3. A frequency for the test to be performed (more complex Rule 3 Exemption use). The server will not process this information which is informative only and there is no alignment to diagnostic service regulations or policy.
| |||||||||||||
| occurrenceDateTime |
dateTime | |||||||||||||||
| occurrencePeriod |
Period | |||||||||||||||
| occurrenceTiming |
Timing | |||||||||||||||
| asNeeded[x] |
Σ | 0..1 | Preconditions for service Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc. | |||||||||||||
| asNeededBoolean |
boolean | |||||||||||||||
| asNeededCodeableConcept |
CodeableConcept | |||||||||||||||
| authoredOn |
SOΣC | 1..1 | dateTime | Date request signed Constraints: au-ereq-srr-01
| ||||||||||||
| requester |
SOΣ | 1..1 | Reference(AU Core PractitionerRole) | Who/what is requesting service
| ||||||||||||
| performerType |
Σ | 0..1 | CodeableConcept | Performer role Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. | ||||||||||||
| performer |
Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested performer | ||||||||||||
| locationCode |
Σ | 0..* | CodeableConcept | Requested location Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered. | ||||||||||||
| locationReference |
Σ | 0..* | Reference(Location) | Requested location | ||||||||||||
| reasonCode |
SOΣ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: Reason for Request (preferred)
| ||||||||||||
| reasonReference |
Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service | ||||||||||||
| insurance |
SO | 0..* | Reference(AU eRequesting Coverage) | Associated insurance coverage
| ||||||||||||
| Slices for supportingInfo |
0..* | Reference(Resource) | Additional clinical information Slice: Unordered, Open by profile:$this.resolve() | |||||||||||||
| supportingInfo:pregnancyStatus |
SOC | 0..1 | Reference(Observation - Pregnancy: status) | The patient's pregnancy status Constraints: au-ereq-srr-02
| ||||||||||||
| supportingInfo:clinicalContext |
SO | 0..* | Reference(AU eRequesting Clinical Context DocumentReference) | Clinical context narrative information providing an overview of the patient's current clinical situation
| ||||||||||||
| specimen |
Σ | 0..* | Reference(Specimen) | Procedure Samples | ||||||||||||
| bodySite |
SOΣ | 0..* | CodeableConcept | Location on Body Binding: Body Site (preferred)
| ||||||||||||
| note |
SO | 0..* | Annotation | Comments
| ||||||||||||
| patientInstruction |
Σ | 0..1 | string | Patient or consumer-oriented instructions | ||||||||||||
| relevantHistory |
0..* | Reference(Provenance) | Request provenance | |||||||||||||
| Documentation for this format | ||||||||||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| ServiceRequest.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| ServiceRequest.requisition.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From 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-typesFrom the FHIR Standard | ||||
| ServiceRequest.status | required | AUeRequestingRequestStatushttp://terminology.hl7.org.au/ValueSet/au-erequesting-request-statusFrom this IG | ||||
| ServiceRequest.intent | required | Pattern Value: orderhttp://hl7.org/fhir/ValueSet/request-intent|4.0.1From the FHIR Standard | ||||
| ServiceRequest.category | example | ServiceRequestCategoryCodeshttp://hl7.org/fhir/ValueSet/servicerequest-categoryFrom the FHIR Standard | ||||
| ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1From the FHIR Standard | ||||
| ServiceRequest.code | example | Procedure https://healthterminologies.gov.au/fhir/ValueSet/procedure-1 | ||||
| ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodeshttp://hl7.org/fhir/ValueSet/servicerequest-orderdetailFrom the FHIR Standard | ||||
| ServiceRequest.encounter.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard | ||||
| ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reasonFrom the FHIR Standard | ||||
| ServiceRequest.performerType | example | ParticipantRoleshttp://hl7.org/fhir/ValueSet/participant-roleFrom the FHIR Standard | ||||
| 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 shall include at least year, month, and day : $this.toString().length() >= 10 | |
| au-ereq-srr-02 | error | ServiceRequest.supportingInfo:pregnancyStatus | Pregnancy status shall be pregnant (SNOMED CT code 77386006) : $this.resolve().value.coding.where(system = 'http://snomed.info/sct' and code = '77386006').exists() | |
| dom-2 | error | ServiceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | ServiceRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ServiceRequest | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present : orderDetail.empty() or code.exists() |
This structure is derived from AUBaseServiceRequest
Summary
Mandatory: 11 elements
Must-Support: 23 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 1
Differential View
This structure is derived from AUBaseServiceRequest
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ServiceRequest |
AUBaseServiceRequest | This is an abstract profile. Child profiles: AUeRequestingImagingRequest, AUeRequestingPathologyRequest | ||||||||||||||
| extension |
1..* | Extension | Extension | |||||||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||||||
| extension:sexParameterForClinicalUse |
SO | 0..1 | PatSexParameterForClinicalUse(5.2.0) | A context-specific sex parameter for clinical use
| ||||||||||||
| extension:statusReason |
SO | 0..1 | CodeableConcept | Reason for current status URL: http://hl7.org/fhir/StructureDefinition/request-statusReason Binding Description: (example): Codes identifying the reason for the current state of an event.
| ||||||||||||
| extension:displaySequence |
SO | 1..1 | integer | Display sequence URL: http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-displaysequence
| ||||||||||||
| extension:fastingPrecondition |
SO | 0..1 | CodeableConcept | Fasting precondition URL: http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-fastingprecondition Binding: Pathology Fasting Status (required)
| ||||||||||||
 identifier |
SO | 0..* | Identifier, AULocalOrderIdentifier | Identifiers assigned to this order
| ||||||||||||
| requisition |
SO | 1..1 | AULocalOrderIdentifier | Composite Request ID
| ||||||||||||
| type |
||||||||||||||||
| coding |
1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following | |||||||||||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||||||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PGN | |||||||||||||
| status |
SO | 1..1 | code | The status of the request Binding: AU eRequesting RequestStatus (required)
| ||||||||||||
| intent |
SO | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Required Pattern: order
| ||||||||||||
| category |
SO | 1..* | CodeableConcept | Classification of service
| ||||||||||||
| priority |
SO | 0..1 | code | routine | urgent | asap | stat
| ||||||||||||
| code |
SO | 1..1 | CodeableConcept | What is being requested/ordered
| ||||||||||||
| text |
1..1 | string | Plain text representation of the concept | |||||||||||||
| quantity[x] |
SO | 0..1 | An informative value indicating the number of fulfilments requested. If not provided the quantity is 1. For Rule 3 Exemption, this value may be greater than 1; however, the server does not currently support tracking multiple fulfilments from a single order.
| |||||||||||||
| quantityQuantity |
Quantity | |||||||||||||||
| quantityRange |
Range | |||||||||||||||
| subject |
SO | 1..1 | Reference(AU Core Patient) | Individual or Entity the service is ordered for
| ||||||||||||
| encounter |
SO | 1..1 | Reference(AU Core Encounter) | Encounter in which the request was created
| ||||||||||||
| reference |
1..1 | string | Literal reference, Relative, internal or absolute URL | |||||||||||||
| occurrence[x] |
SO | 0..1 | dateTime, Period, Timing | This may be used to cover three needs: 1. A target date for the test to be performed. 2. A date range for the test to be performed (possible Rule 3 Exemption use). 3. A frequency for the test to be performed (more complex Rule 3 Exemption use). The server will not process this information which is informative only and there is no alignment to diagnostic service regulations or policy.
| ||||||||||||
| authoredOn |
SOC | 1..1 | dateTime | Date request signed Constraints: au-ereq-srr-01
| ||||||||||||
| requester |
SO | 1..1 | Reference(AU Core PractitionerRole) | Who/what is requesting service
| ||||||||||||
| reasonCode |
SO | 0..* | CodeableConcept | Explanation/Justification for procedure or service
| ||||||||||||
| insurance |
SO | 0..* | Reference(AU eRequesting Coverage) | Associated insurance coverage
| ||||||||||||
| Slices for supportingInfo |
0..* | Reference(Resource) | Additional clinical information Slice: Unordered, Open by profile:$this.resolve() | |||||||||||||
| supportingInfo:pregnancyStatus |
SOC | 0..1 | Reference(Observation - Pregnancy: status) | The patient's pregnancy status Constraints: au-ereq-srr-02
| ||||||||||||
| supportingInfo:clinicalContext |
SO | 0..* | Reference(AU eRequesting Clinical Context DocumentReference) | Clinical context narrative information providing an overview of the patient's current clinical situation
| ||||||||||||
| bodySite |
SO | 0..* | CodeableConcept | Location on Body
| ||||||||||||
| note |
SO | 0..* | Annotation | Comments
| ||||||||||||
| Documentation for this format | ||||||||||||||||
| Path | Conformance | ValueSet | URI |
| ServiceRequest.status | required | AUeRequestingRequestStatushttp://terminology.hl7.org.au/ValueSet/au-erequesting-request-statusFrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| au-ereq-srr-01 | error | ServiceRequest.authoredOn | Date shall include at least year, month, and day : $this.toString().length() >= 10 | |
| au-ereq-srr-02 | error | ServiceRequest.supportingInfo:pregnancyStatus | Pregnancy status shall be pregnant (SNOMED CT code 77386006) : $this.resolve().value.coding.where(system = 'http://snomed.info/sct' and code = '77386006').exists() |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ServiceRequest |
C | 0..* | AUBaseServiceRequest | This is an abstract profile. Child profiles: AUeRequestingImagingRequest, AUeRequestingPathologyRequest A service request in an Australian healthcare context Constraints: prr-1 | ||||||||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||||
| extension:sexParameterForClinicalUse |
SO | 0..1 | (Complex) | A context-specific sex parameter for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
| ||||||||||||
| extension:targetBodyStructure |
0..* | Reference(BodyStructure) | The target point for this procedure URL: http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure | |||||||||||||
| extension:statusReason |
SO | 0..1 | CodeableConcept | Reason for current status URL: http://hl7.org/fhir/StructureDefinition/request-statusReason Binding Description: (example): Codes identifying the reason for the current state of an event.
| ||||||||||||
| extension:displaySequence |
SO | 1..1 | integer | Display sequence URL: http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-displaysequence
| ||||||||||||
| extension:fastingPrecondition |
SO | 0..1 | CodeableConcept | Fasting precondition URL: http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-fastingprecondition Binding: Pathology Fasting Status (required)
| ||||||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||
| identifier |
SOΣ | 0..* | Identifier, AULocalOrderIdentifier | Identifiers assigned to this order
| ||||||||||||
| requisition |
SOΣ | 1..1 | AULocalOrderIdentifier | Composite Request ID
| ||||||||||||
| 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 | ||||||||||||
| 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 | |||||||||||||
| system |
Σ | 1..1 | uri | System identifier namespace for the organisation that assigned the order identifier Example General: http://www.acme.com/identifiers/patient | ||||||||||||
| value |
Σ | 1..1 | string | Order identifier Example General: 123456 | ||||||||||||
| status |
?!SOΣ | 1..1 | code | The status of the request Binding: AU eRequesting RequestStatus (required)
| ||||||||||||
| 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
| ||||||||||||
| category |
SOΣ | 1..* | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.
| ||||||||||||
| priority |
SOΣ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
| ||||||||||||
| doNotPerform |
?!Σ | 0..1 | boolean | True if service/procedure should not be performed | ||||||||||||
| code |
SOΣ | 1..1 | CodeableConcept | What is being requested/ordered Binding: Procedure (example)
| ||||||||||||
| text |
Σ | 1..1 | string | Plain text representation of the concept | ||||||||||||
| quantity[x] |
SOΣ | 0..1 | An informative value indicating the number of fulfilments requested. If not provided the quantity is 1. For Rule 3 Exemption, this value may be greater than 1; however, the server does not currently support tracking multiple fulfilments from a single order.
| |||||||||||||
| quantityQuantity |
Quantity | |||||||||||||||
| quantityRange |
Range | |||||||||||||||
| subject |
SOΣ | 1..1 | Reference(AU Core Patient) | Individual or Entity the service is ordered for
| ||||||||||||
| encounter |
SOΣ | 1..1 | Reference(AU Core Encounter) | Encounter in which the request was created
| ||||||||||||
| reference |
ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||||||||||
| occurrence[x] |
SOΣ | 0..1 | This may be used to cover three needs: 1. A target date for the test to be performed. 2. A date range for the test to be performed (possible Rule 3 Exemption use). 3. A frequency for the test to be performed (more complex Rule 3 Exemption use). The server will not process this information which is informative only and there is no alignment to diagnostic service regulations or policy.
| |||||||||||||
| occurrenceDateTime |
dateTime | |||||||||||||||
| occurrencePeriod |
Period | |||||||||||||||
| occurrenceTiming |
Timing | |||||||||||||||
| authoredOn |
SOΣC | 1..1 | dateTime | Date request signed Constraints: au-ereq-srr-01
| ||||||||||||
| requester |
SOΣ | 1..1 | Reference(AU Core PractitionerRole) | Who/what is requesting service
| ||||||||||||
| reasonCode |
SOΣ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: Reason for Request (preferred)
| ||||||||||||
| insurance |
SO | 0..* | Reference(AU eRequesting Coverage) | Associated insurance coverage
| ||||||||||||
| Slices for supportingInfo |
0..* | Reference(Resource) | Additional clinical information Slice: Unordered, Open by profile:$this.resolve() | |||||||||||||
| supportingInfo:pregnancyStatus |
SOC | 0..1 | Reference(Observation - Pregnancy: status) | The patient's pregnancy status Constraints: au-ereq-srr-02
| ||||||||||||
| supportingInfo:clinicalContext |
SO | 0..* | Reference(AU eRequesting Clinical Context DocumentReference) | Clinical context narrative information providing an overview of the patient's current clinical situation
| ||||||||||||
| bodySite |
SOΣ | 0..* | CodeableConcept | Location on Body Binding: Body Site (preferred)
| ||||||||||||
| note |
SO | 0..* | Annotation | Comments
| ||||||||||||
| Documentation for this format | ||||||||||||||||
| Path | Conformance | ValueSet / Code | URI |
| ServiceRequest.requisition.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From 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-statusFrom this IG | |
| ServiceRequest.intent | required | Pattern Value: orderhttp://hl7.org/fhir/ValueSet/request-intent|4.0.1From the FHIR Standard | |
| ServiceRequest.category | example | ServiceRequestCategoryCodeshttp://hl7.org/fhir/ValueSet/servicerequest-categoryFrom the FHIR Standard | |
| ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1From the FHIR Standard | |
| ServiceRequest.code | example | Procedure https://healthterminologies.gov.au/fhir/ValueSet/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 shall include at least year, month, and day : $this.toString().length() >= 10 | |
| au-ereq-srr-02 | error | ServiceRequest.supportingInfo:pregnancyStatus | Pregnancy status shall be pregnant (SNOMED CT code 77386006) : $this.resolve().value.coding.where(system = 'http://snomed.info/sct' and code = '77386006').exists() | |
| dom-2 | error | ServiceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | ServiceRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ServiceRequest | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present : orderDetail.empty() or code.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ServiceRequest |
C | 0..* | AUBaseServiceRequest | This is an abstract profile. Child profiles: AUeRequestingImagingRequest, AUeRequestingPathologyRequest A service request in an Australian healthcare context Constraints: prr-1 | ||||||||||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||||||||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||||||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||||||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||||||||||
| contained |
0..* | Resource | Contained, inline Resources | |||||||||||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||||
| extension:sexParameterForClinicalUse |
SO | 0..1 | (Complex) | A context-specific sex parameter for clinical use URL: http://hl7.org/fhir/StructureDefinition/patient-sexParameterForClinicalUse
| ||||||||||||
| extension:targetBodyStructure |
0..* | Reference(BodyStructure) | The target point for this procedure URL: http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure | |||||||||||||
| extension:statusReason |
SO | 0..1 | CodeableConcept | Reason for current status URL: http://hl7.org/fhir/StructureDefinition/request-statusReason Binding Description: (example): Codes identifying the reason for the current state of an event.
| ||||||||||||
| extension:displaySequence |
SO | 1..1 | integer | Display sequence URL: http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-displaysequence
| ||||||||||||
| extension:fastingPrecondition |
SO | 0..1 | CodeableConcept | Fasting precondition URL: http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-fastingprecondition Binding: Pathology Fasting Status (required)
| ||||||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||
| identifier |
SOΣ | 0..* | Identifier, AULocalOrderIdentifier | Identifiers assigned to this order
| ||||||||||||
| instantiatesCanonical |
Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition | ||||||||||||
| instantiatesUri |
Σ | 0..* | uri | Instantiates external protocol or definition | ||||||||||||
| basedOn |
Σ | 0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) | What request fulfills | ||||||||||||
| replaces |
Σ | 0..* | Reference(ServiceRequest) | What request replaces | ||||||||||||
| requisition |
SOΣ | 1..1 | AULocalOrderIdentifier | Composite Request ID
| ||||||||||||
| 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 | The status of the request Binding: AU eRequesting RequestStatus (required)
| ||||||||||||
| 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
| ||||||||||||
| category |
SOΣ | 1..* | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.
| ||||||||||||
| priority |
SOΣ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.
| ||||||||||||
| doNotPerform |
?!Σ | 0..1 | boolean | True if service/procedure should not be performed | ||||||||||||
| code |
SOΣ | 1..1 | CodeableConcept | What is being requested/ordered Binding: Procedure (example)
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| coding |
Σ | 0..* | Coding | Code defined by a terminology system | ||||||||||||
| text |
Σ | 1..1 | string | Plain text representation of the concept | ||||||||||||
| orderDetail |
ΣC | 0..* | CodeableConcept | Additional order information Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context. | ||||||||||||
| quantity[x] |
SOΣ | 0..1 | An informative value indicating the number of fulfilments requested. If not provided the quantity is 1. For Rule 3 Exemption, this value may be greater than 1; however, the server does not currently support tracking multiple fulfilments from a single order.
| |||||||||||||
| quantityQuantity |
Quantity | |||||||||||||||
| quantityRange |
Range | |||||||||||||||
| subject |
SOΣ | 1..1 | Reference(AU Core Patient) | Individual or Entity the service is ordered for
| ||||||||||||
| encounter |
SOΣ | 1..1 | Reference(AU Core Encounter) | Encounter in which the request was created
| ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| reference |
ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||||||||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||||||||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||||||||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||||||||||
| occurrence[x] |
SOΣ | 0..1 | This may be used to cover three needs: 1. A target date for the test to be performed. 2. A date range for the test to be performed (possible Rule 3 Exemption use). 3. A frequency for the test to be performed (more complex Rule 3 Exemption use). The server will not process this information which is informative only and there is no alignment to diagnostic service regulations or policy.
| |||||||||||||
| occurrenceDateTime |
dateTime | |||||||||||||||
| occurrencePeriod |
Period | |||||||||||||||
| occurrenceTiming |
Timing | |||||||||||||||
| asNeeded[x] |
Σ | 0..1 | Preconditions for service Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc. | |||||||||||||
| asNeededBoolean |
boolean | |||||||||||||||
| asNeededCodeableConcept |
CodeableConcept | |||||||||||||||
| authoredOn |
SOΣC | 1..1 | dateTime | Date request signed Constraints: au-ereq-srr-01
| ||||||||||||
| requester |
SOΣ | 1..1 | Reference(AU Core PractitionerRole) | Who/what is requesting service
| ||||||||||||
| performerType |
Σ | 0..1 | CodeableConcept | Performer role Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. | ||||||||||||
| performer |
Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested performer | ||||||||||||
| locationCode |
Σ | 0..* | CodeableConcept | Requested location Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered. | ||||||||||||
| locationReference |
Σ | 0..* | Reference(Location) | Requested location | ||||||||||||
| reasonCode |
SOΣ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: Reason for Request (preferred)
| ||||||||||||
| reasonReference |
Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service | ||||||||||||
| insurance |
SO | 0..* | Reference(AU eRequesting Coverage) | Associated insurance coverage
| ||||||||||||
| Slices for supportingInfo |
0..* | Reference(Resource) | Additional clinical information Slice: Unordered, Open by profile:$this.resolve() | |||||||||||||
| supportingInfo:pregnancyStatus |
SOC | 0..1 | Reference(Observation - Pregnancy: status) | The patient's pregnancy status Constraints: au-ereq-srr-02
| ||||||||||||
| supportingInfo:clinicalContext |
SO | 0..* | Reference(AU eRequesting Clinical Context DocumentReference) | Clinical context narrative information providing an overview of the patient's current clinical situation
| ||||||||||||
| specimen |
Σ | 0..* | Reference(Specimen) | Procedure Samples | ||||||||||||
| bodySite |
SOΣ | 0..* | CodeableConcept | Location on Body Binding: Body Site (preferred)
| ||||||||||||
| note |
SO | 0..* | Annotation | Comments
| ||||||||||||
| patientInstruction |
Σ | 0..1 | string | Patient or consumer-oriented instructions | ||||||||||||
| relevantHistory |
0..* | Reference(Provenance) | Request provenance | |||||||||||||
| Documentation for this format | ||||||||||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| ServiceRequest.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| ServiceRequest.requisition.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From 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-typesFrom the FHIR Standard | ||||
| ServiceRequest.status | required | AUeRequestingRequestStatushttp://terminology.hl7.org.au/ValueSet/au-erequesting-request-statusFrom this IG | ||||
| ServiceRequest.intent | required | Pattern Value: orderhttp://hl7.org/fhir/ValueSet/request-intent|4.0.1From the FHIR Standard | ||||
| ServiceRequest.category | example | ServiceRequestCategoryCodeshttp://hl7.org/fhir/ValueSet/servicerequest-categoryFrom the FHIR Standard | ||||
| ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1From the FHIR Standard | ||||
| ServiceRequest.code | example | Procedure https://healthterminologies.gov.au/fhir/ValueSet/procedure-1 | ||||
| ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodeshttp://hl7.org/fhir/ValueSet/servicerequest-orderdetailFrom the FHIR Standard | ||||
| ServiceRequest.encounter.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard | ||||
| ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reasonFrom the FHIR Standard | ||||
| ServiceRequest.performerType | example | ParticipantRoleshttp://hl7.org/fhir/ValueSet/participant-roleFrom the FHIR Standard | ||||
| 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 shall include at least year, month, and day : $this.toString().length() >= 10 | |
| au-ereq-srr-02 | error | ServiceRequest.supportingInfo:pregnancyStatus | Pregnancy status shall be pregnant (SNOMED CT code 77386006) : $this.resolve().value.coding.where(system = 'http://snomed.info/sct' and code = '77386006').exists() | |
| dom-2 | error | ServiceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | ServiceRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ServiceRequest | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present : orderDetail.empty() or code.exists() |
This structure is derived from AUBaseServiceRequest
Summary
Mandatory: 11 elements
Must-Support: 23 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 1
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 |
|
| supporting-info | SHALL | MAY | MAY | MAY | reference |
|
| _include=ServiceRequest:patient | SHALL | MAY | MAY | MAY | reference |
|
| _include=ServiceRequest:requester | SHALL | MAY | MAY | MAY | reference |
|
| _include=ServiceRequest:supporting-info | SHALL | MAY | MAY | MAY | reference |
|
| _include=ServiceRequest:encounter | SHOULD | MAY | MAY | MAY | reference |
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, ServiceRequest:supporting-infoGET [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,ServiceRequest:supporting-infoGET [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)
supporting-info search parameter
_include parameters: ServiceRequest:patient,ServiceRequest:requester,ServiceRequest:encounterGET [base]/ServiceRequest?supporting-info={Type/}[id]
Example:
Implementation Notes: Fetches a bundle of all ServiceRequest resources matching the supporting-info (how to search by reference)
IG © 2024 HL7 Australia. Package hl7.fhir.au.ereq#1.0.0-ballot based on FHIR 4.0.1. Generated 2025-08-04
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change