AU eRequesting Implementation Guide
0.2.0-ci-build - CI Build
AU eRequesting Implementation Guide
0.2.0-ci-build - CI Build
AU eRequesting Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 0.2.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7au/au-fhir-erequesting/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-diagnosticrequest | Version: 0.2.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 | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
  ServiceRequest |
0..* | AUBaseDiagnosticRequest | This is an abstractprofile. Childprofiles: AUeRequestingImagingRequest, AUeRequestingPathologyRequest A diagnostic service request in an Australian healthcare context | |||||||||||||
  identifier |
SO | 0..* | Identifier, AULocalOrderIdentifier | Identifiers assigned to this order
| ||||||||||||
 requisition |
SO | 1..1 | AULocalOrderIdentifier | Local Order Identifier
| ||||||||||||
  type |
||||||||||||||||
 coding |
1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following | |||||||||||||
 system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||||||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PGN | |||||||||||||
| status |
SO | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown
| ||||||||||||
| 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 | |||||||||||||
 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 | |||||||||||||
| authoredOn |
SOC | 1..1 | dateTime | Date request signed au-ereq-srr-01: Date must include at least year, month, and day
| ||||||||||||
| requester |
SO | 1..1 | Reference(AU Core PractitionerRole) | Authorising individual, organisation or program (e.g. National Bowel Cancer Screening Program)
| ||||||||||||
| reasonCode |
SO | 0..* | CodeableConcept | Explanation/Justification for procedure or service
| ||||||||||||
| insurance |
SO | 0..* | Reference(AU Base Coverage) | Associated insurance coverage
| ||||||||||||
| bodySite |
SO | 0..* | CodeableConcept | Location on Body
| ||||||||||||
| note |
SO | 0..* | Annotation | Comments
| ||||||||||||
| Documentation for this format | ||||||||||||||||
| 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 |
| Name | Flags | Card. | Type | Description & Constraints | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ServiceRequest |
C | 0..* | AUBaseDiagnosticRequest | This is an abstractprofile. Childprofiles: AUeRequestingImagingRequest, AUeRequestingPathologyRequest A diagnostic service request in an Australian healthcare context prr-1: orderDetail SHALL only be present if code is present | ||||||||||||
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||||||
 Slices for extension |
Content/Rules for all slices | |||||||||||||||
  targetBodyStructure |
0..* | Reference(BodyStructure) | The target point for this procedure URL: http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure | |||||||||||||
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||
| identifier |
SO | 0..* | Identifier, AULocalOrderIdentifier | Identifiers assigned to this order
| ||||||||||||
| requisition |
SO | 1..1 | AULocalOrderIdentifier | Local Order Identifier
| ||||||||||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||||||||||
| type |
Σ | 1..1 | CodeableConcept | Coded identifier type for local order identifier Binding: Order Identifier Type (required) | ||||||||||||
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following | ||||||||||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||||||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PGN | |||||||||||||
| system |
Σ | 1..1 | uri | System identifier namespace for the organisation that assigned the order identifier Example General: http://www.acme.com/identifiers/patient | ||||||||||||
| value |
Σ | 1..1 | string | Order identifier Example General: 123456 | ||||||||||||
| assigner |
Σ | 1..1 | Reference(Organization) | Organisation that assigned the order identifier | ||||||||||||
| display |
Σ | 1..1 | string | Name of the assigning organisation | ||||||||||||
| status |
?!SOΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order.
| ||||||||||||
| 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: Evaluation Procedure  (example)
| ||||||||||||
| text |
Σ | 1..1 | string | Plain text representation of the concept | ||||||||||||
| subject |
SOΣ | 1..1 | Reference(AU Core Patient) | Individual or Entity the service is ordered for
| ||||||||||||
| 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 | ||||||||||||
| authoredOn |
SOΣC | 1..1 | dateTime | Date request signed au-ereq-srr-01: Date must include at least year, month, and day
| ||||||||||||
| requester |
SOΣ | 1..1 | Reference(AU Core PractitionerRole) | Authorising individual, organisation or program (e.g. National Bowel Cancer Screening Program)
| ||||||||||||
| reasonCode |
SOΣ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: Reason for Request (preferred)
| ||||||||||||
| insurance |
SO | 0..* | Reference(AU Base Coverage) | Associated insurance coverage
| ||||||||||||
| 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 | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1from the FHIR Standard | |
| ServiceRequest.intent | required | Pattern: 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 | 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 |
| Name | Flags | Card. | Type | Description & Constraints | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ServiceRequest |
C | 0..* | AUBaseDiagnosticRequest | This is an abstractprofile. Childprofiles: AUeRequestingImagingRequest, AUeRequestingPathologyRequest A diagnostic service request in an Australian healthcare context prr-1: orderDetail SHALL only be present if code is present | ||||||||||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||||||||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||||||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||||||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||||||||||
| contained |
0..* | Resource | Contained, inline Resources | |||||||||||||
 Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||||
| targetBodyStructure |
0..* | Reference(BodyStructure) | The target point for this procedure URL: http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure | |||||||||||||
| 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 | Local 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 | |||||||||||||
| 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 |
Σ | 1..1 | Reference(Organization) | Organisation that assigned the order identifier | ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||||||||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||||||||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||||||||||
| display |
Σ | 1..1 | string | Name of the assigning organisation | ||||||||||||
| status |
?!SOΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order.
| ||||||||||||
| 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: Evaluation 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] |
Σ | 0..1 | Service amount | |||||||||||||
| quantityQuantity |
Quantity | |||||||||||||||
| quantityRatio |
Ratio | |||||||||||||||
| quantityRange |
Range | |||||||||||||||
| subject |
SOΣ | 1..1 | Reference(AU Core Patient) | Individual or Entity the service is ordered for
| ||||||||||||
| 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] |
Σ | 0..1 | When service should occur | |||||||||||||
| occurrenceDateTime |
dateTime | |||||||||||||||
| occurrencePeriod |
Period | |||||||||||||||
| occurrenceTiming |
Timing | |||||||||||||||
| asNeeded[x] |
Σ | 0..1 | Preconditions for service Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc. | |||||||||||||
| asNeededBoolean |
boolean | |||||||||||||||
| asNeededCodeableConcept |
CodeableConcept | |||||||||||||||
| authoredOn |
SOΣC | 1..1 | dateTime | Date request signed au-ereq-srr-01: Date must include at least year, month, and day
| ||||||||||||
| requester |
SOΣ | 1..1 | Reference(AU Core PractitionerRole) | Authorising individual, organisation or program (e.g. National Bowel Cancer Screening Program)
| ||||||||||||
| performerType |
Σ | 0..1 | CodeableConcept | Performer role Binding: Practitioner Role (preferred) | ||||||||||||
| performer |
Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested performer | ||||||||||||
| locationCode |
Σ | 0..* | CodeableConcept | Requested location Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered. | ||||||||||||
| locationReference |
Σ | 0..* | Reference(Location) | Requested location | ||||||||||||
| reasonCode |
SOΣ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: Reason for Request (preferred)
| ||||||||||||
| reasonReference |
Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service | ||||||||||||
| insurance |
SO | 0..* | Reference(AU Base Coverage) | Associated insurance coverage
| ||||||||||||
| supportingInfo |
0..* | Reference(Resource) | Additional clinical information | |||||||||||||
| specimen |
Σ | 0..* | Reference(AU Base Specimen) | Procedure Samples | ||||||||||||
| bodySite |
SOΣ | 0..* | CodeableConcept | Location on Body Binding: Body Site (preferred)
| ||||||||||||
| 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 | CommonLanguages
http://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 | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1from the FHIR Standard | ||||
| ServiceRequest.intent | required | Pattern: 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 | EvaluationProcedure https://healthterminologies.gov.au/fhir/ValueSet/evaluation-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 | 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 |
This structure is derived from AUBaseDiagnosticRequest
Summary
Mandatory: 9 elements
Must-Support: 15 elements
Structures
This structure refers to these other structures:
Maturity: 0
Differential View
This structure is derived from AUBaseDiagnosticRequest
| Name | Flags | Card. | Type | Description & Constraints | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ServiceRequest |
0..* | AUBaseDiagnosticRequest | This is an abstractprofile. Childprofiles: AUeRequestingImagingRequest, AUeRequestingPathologyRequest A diagnostic service request in an Australian healthcare context | |||||||||||||
| identifier |
SO | 0..* | Identifier, AULocalOrderIdentifier | Identifiers assigned to this order
| ||||||||||||
| requisition |
SO | 1..1 | AULocalOrderIdentifier | Local Order Identifier
| ||||||||||||
| type |
||||||||||||||||
| coding |
1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following | |||||||||||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||||||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PGN | |||||||||||||
| status |
SO | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown
| ||||||||||||
| 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 | |||||||||||||
| 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 | |||||||||||||
| authoredOn |
SOC | 1..1 | dateTime | Date request signed au-ereq-srr-01: Date must include at least year, month, and day
| ||||||||||||
| requester |
SO | 1..1 | Reference(AU Core PractitionerRole) | Authorising individual, organisation or program (e.g. National Bowel Cancer Screening Program)
| ||||||||||||
| reasonCode |
SO | 0..* | CodeableConcept | Explanation/Justification for procedure or service
| ||||||||||||
| insurance |
SO | 0..* | Reference(AU Base Coverage) | Associated insurance coverage
| ||||||||||||
| bodySite |
SO | 0..* | CodeableConcept | Location on Body
| ||||||||||||
| note |
SO | 0..* | Annotation | Comments
| ||||||||||||
| Documentation for this format | ||||||||||||||||
| 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 |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ServiceRequest |
C | 0..* | AUBaseDiagnosticRequest | This is an abstractprofile. Childprofiles: AUeRequestingImagingRequest, AUeRequestingPathologyRequest A diagnostic service request in an Australian healthcare context prr-1: orderDetail SHALL only be present if code is present | ||||||||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||||||
| targetBodyStructure |
0..* | Reference(BodyStructure) | The target point for this procedure URL: http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure | |||||||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||||||||||
| identifier |
SO | 0..* | Identifier, AULocalOrderIdentifier | Identifiers assigned to this order
| ||||||||||||
| requisition |
SO | 1..1 | AULocalOrderIdentifier | Local Order Identifier
| ||||||||||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||||||||||
| type |
Σ | 1..1 | CodeableConcept | Coded identifier type for local order identifier Binding: Order Identifier Type (required) | ||||||||||||
| coding |
Σ | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following | ||||||||||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |||||||||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: PGN | |||||||||||||
| system |
Σ | 1..1 | uri | System identifier namespace for the organisation that assigned the order identifier Example General: http://www.acme.com/identifiers/patient | ||||||||||||
| value |
Σ | 1..1 | string | Order identifier Example General: 123456 | ||||||||||||
| assigner |
Σ | 1..1 | Reference(Organization) | Organisation that assigned the order identifier | ||||||||||||
| display |
Σ | 1..1 | string | Name of the assigning organisation | ||||||||||||
| status |
?!SOΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order.
| ||||||||||||
| 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: Evaluation Procedure (example)
| ||||||||||||
| text |
Σ | 1..1 | string | Plain text representation of the concept | ||||||||||||
| subject |
SOΣ | 1..1 | Reference(AU Core Patient) | Individual or Entity the service is ordered for
| ||||||||||||
| 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 | ||||||||||||
| authoredOn |
SOΣC | 1..1 | dateTime | Date request signed au-ereq-srr-01: Date must include at least year, month, and day
| ||||||||||||
| requester |
SOΣ | 1..1 | Reference(AU Core PractitionerRole) | Authorising individual, organisation or program (e.g. National Bowel Cancer Screening Program)
| ||||||||||||
| reasonCode |
SOΣ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: Reason for Request (preferred)
| ||||||||||||
| insurance |
SO | 0..* | Reference(AU Base Coverage) | Associated insurance coverage
| ||||||||||||
| 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 | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1from the FHIR Standard | |
| ServiceRequest.intent | required | Pattern: 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 | 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 |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ServiceRequest |
C | 0..* | AUBaseDiagnosticRequest | This is an abstractprofile. Childprofiles: AUeRequestingImagingRequest, AUeRequestingPathologyRequest A diagnostic service request in an Australian healthcare context prr-1: orderDetail SHALL only be present if code is present | ||||||||||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||||||||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||||||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||||||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||||||||||
| contained |
0..* | Resource | Contained, inline Resources | |||||||||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||||
| targetBodyStructure |
0..* | Reference(BodyStructure) | The target point for this procedure URL: http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure | |||||||||||||
| 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 | Local 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 | |||||||||||||
| 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 |
Σ | 1..1 | Reference(Organization) | Organisation that assigned the order identifier | ||||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||||||||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||||||||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||||||||||
| display |
Σ | 1..1 | string | Name of the assigning organisation | ||||||||||||
| status |
?!SOΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order.
| ||||||||||||
| 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: Evaluation 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] |
Σ | 0..1 | Service amount | |||||||||||||
| quantityQuantity |
Quantity | |||||||||||||||
| quantityRatio |
Ratio | |||||||||||||||
| quantityRange |
Range | |||||||||||||||
| subject |
SOΣ | 1..1 | Reference(AU Core Patient) | Individual or Entity the service is ordered for
| ||||||||||||
| 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] |
Σ | 0..1 | When service should occur | |||||||||||||
| occurrenceDateTime |
dateTime | |||||||||||||||
| occurrencePeriod |
Period | |||||||||||||||
| occurrenceTiming |
Timing | |||||||||||||||
| asNeeded[x] |
Σ | 0..1 | Preconditions for service Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc. | |||||||||||||
| asNeededBoolean |
boolean | |||||||||||||||
| asNeededCodeableConcept |
CodeableConcept | |||||||||||||||
| authoredOn |
SOΣC | 1..1 | dateTime | Date request signed au-ereq-srr-01: Date must include at least year, month, and day
| ||||||||||||
| requester |
SOΣ | 1..1 | Reference(AU Core PractitionerRole) | Authorising individual, organisation or program (e.g. National Bowel Cancer Screening Program)
| ||||||||||||
| performerType |
Σ | 0..1 | CodeableConcept | Performer role Binding: Practitioner Role (preferred) | ||||||||||||
| performer |
Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested performer | ||||||||||||
| locationCode |
Σ | 0..* | CodeableConcept | Requested location Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered. | ||||||||||||
| locationReference |
Σ | 0..* | Reference(Location) | Requested location | ||||||||||||
| reasonCode |
SOΣ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: Reason for Request (preferred)
| ||||||||||||
| reasonReference |
Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service | ||||||||||||
| insurance |
SO | 0..* | Reference(AU Base Coverage) | Associated insurance coverage
| ||||||||||||
| supportingInfo |
0..* | Reference(Resource) | Additional clinical information | |||||||||||||
| specimen |
Σ | 0..* | Reference(AU Base Specimen) | Procedure Samples | ||||||||||||
| bodySite |
SOΣ | 0..* | CodeableConcept | Location on Body Binding: Body Site (preferred)
| ||||||||||||
| 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 | CommonLanguages
http://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 | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1from the FHIR Standard | ||||
| ServiceRequest.intent | required | Pattern: 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 | EvaluationProcedure https://healthterminologies.gov.au/fhir/ValueSet/evaluation-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 | 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 |
This structure is derived from AUBaseDiagnosticRequest
Summary
Mandatory: 9 elements
Must-Support: 15 elements
Structures
This structure refers to these other structures:
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) | Conformance | Type(s) | Requirements (when used alone or in combination) |
|---|---|---|---|
| _id | SHALL | token |
|
| requisition | SHALL | token |
The following search parameters and search parameter combinations SHALL be supported:
SHALL support searching using the _id search parameter:
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)
SHALL support searching using the requisition search parameter:
GET [base]/ServiceRequest?requisition={system|}{code}
Example:
Implementation Notes: Fetches a bundle containing ServiceRequest resources matching the requisition (how to search by token)
IG © 2024 HL7 Australia. Package hl7.fhir.au.ereq#0.2.0-ci-build based on FHIR 4.0.1. Generated 2024-11-22
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change