AU Base Implementation Guide
4.1.0-ballot - CI Build
AU
AU Base Implementation Guide
4.1.0-ballot - CI Build
AU
This page is part of AU Base v4.1.0 based on FHIR R4. For a full list of available versions, see the Directory of published versions 
| Official URL: http://hl7.org.au/fhir/StructureDefinition/au-diagnosticrequest | Version: 4.1.0-ballot | |||
| Draft as of 2022-11-10 | Maturity Level: 1 | Computable Name: AUBaseDiagnosticRequest | ||
Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved. |
||||
This profile defines a service request structure that includes core localisation concepts for use as a request for a diagnostic investigation in an Australian context.
This profile is intended to support ordering for pathology, radiology, and specialist diagnostic investigations.
Potentially useful extensions:
The procedure-targetBodyStructure extension should only be used if not implicit in the code found in ServiceRequest.code. If the use case requires bodySite to be handled as a separate resource instead of an inline coded element (e.g. to identify and track separately) then use the standard extension procedure-targetBodyStructure.
A pathology order is preferred to be a member of the RCPA - SPIA Requesting Pathology Terminology Reference Set [1].
An imaging order is preferred to be a member of the Imaging Procedure value set.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ServiceRequest
| Path | Conformance | ValueSet |
| ServiceRequest.code | example | https://healthterminologies.gov.au/fhir/ValueSet/evaluation-procedure-1 |
| ServiceRequest.performerType | preferred | https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 |
| ServiceRequest.reasonCode | preferred | https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 |
| ServiceRequest.bodySite | preferred | https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  ServiceRequest | C | 0..* | ServiceRequest | A diagnostic service request in an Australian healthcare context |
  implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 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 | 0..* | Identifier, AULocalOrderIdentifier | Identifiers assigned to this order | |
| status | ?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. |
| intent | ?!Σ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. |
| doNotPerform | ?!Σ | 0..1 | boolean | True if service/procedure should not be performed |
| code | Σ | 0..1 | CodeableConcept | What is being requested/ordered Binding: https://healthterminologies.gov.au/fhir/ValueSet/evaluation-procedure-1 (example) |
 subject | Σ | 1..1 | Reference(Patient | Group | Location | Device) | Individual or Entity the service is ordered for |
| requester | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson) | Authorising individual, organisation or program (e.g. National Bowel Cancer Screening Program) |
| performerType | Σ | 0..1 | CodeableConcept | Performer role Binding: https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 (preferred) |
| reasonCode | Σ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 (preferred) |
| specimen | Σ | 0..* | Reference(AU Base Specimen) | Procedure Samples |
 bodySite | Σ | 0..* | CodeableConcept | Location on Body Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (preferred) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| ServiceRequest.status | required | RequestStatus |
| ServiceRequest.intent | required | RequestIntent |
| ServiceRequest.code | example | https://healthterminologies.gov.au/fhir/ValueSet/evaluation-procedure-1 |
| ServiceRequest.performerType | preferred | https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 |
| ServiceRequest.reasonCode | preferred | https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 |
| ServiceRequest.bodySite | preferred | https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| ServiceRequest | C | 0..* | ServiceRequest | A diagnostic service request in an Australian healthcare context | ||||
| 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 | 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 | Σ | 0..1 | Identifier | Composite Request ID | ||||
| status | ?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. | ||||
| intent | ?!Σ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. | ||||
| category | Σ | 0..* | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. | ||||
| priority | Σ | 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 | Σ | 0..1 | CodeableConcept | What is being requested/ordered Binding: https://healthterminologies.gov.au/fhir/ValueSet/evaluation-procedure-1 (example) | ||||
| 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 | Σ | 1..1 | Reference(Patient | Group | Location | Device) | Individual or Entity the service is ordered for | ||||
| encounter | Σ | 0..1 | Reference(Encounter) | Encounter in which the request was created | ||||
| 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 | Σ | 0..1 | dateTime | Date request signed | ||||
| requester | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson) | Authorising individual, organisation or program (e.g. National Bowel Cancer Screening Program) | ||||
| performerType | Σ | 0..1 | CodeableConcept | Performer role Binding: https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 (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 | Σ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 (preferred) | ||||
| reasonReference | Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service | ||||
| insurance | 0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||
| supportingInfo | 0..* | Reference(Resource) | Additional clinical information | |||||
| specimen | Σ | 0..* | Reference(AU Base Specimen) | Procedure Samples | ||||
| bodySite | Σ | 0..* | CodeableConcept | Location on Body Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (preferred) | ||||
| note | 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 | ||||
| ServiceRequest.language | preferred | CommonLanguages
| ||||
| ServiceRequest.status | required | RequestStatus | ||||
| ServiceRequest.intent | required | RequestIntent | ||||
| ServiceRequest.category | example | ServiceRequestCategoryCodes | ||||
| ServiceRequest.priority | required | RequestPriority | ||||
| ServiceRequest.code | example | https://healthterminologies.gov.au/fhir/ValueSet/evaluation-procedure-1 | ||||
| ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodes | ||||
| ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodes | ||||
| ServiceRequest.performerType | preferred | https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 | ||||
| ServiceRequest.locationCode | example | ServiceDeliveryLocationRoleType | ||||
| ServiceRequest.reasonCode | preferred | https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 | ||||
| ServiceRequest.bodySite | preferred | https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 |
This structure is derived from ServiceRequest
Summary
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Maturity: 1
Differential View
This structure is derived from ServiceRequest
| Path | Conformance | ValueSet |
| ServiceRequest.code | example | https://healthterminologies.gov.au/fhir/ValueSet/evaluation-procedure-1 |
| ServiceRequest.performerType | preferred | https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 |
| ServiceRequest.reasonCode | preferred | https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 |
| ServiceRequest.bodySite | preferred | https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ServiceRequest | C | 0..* | ServiceRequest | A diagnostic service request in an Australian healthcare context |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| 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 | 0..* | Identifier, AULocalOrderIdentifier | Identifiers assigned to this order | |
| status | ?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. |
| intent | ?!Σ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. |
| doNotPerform | ?!Σ | 0..1 | boolean | True if service/procedure should not be performed |
| code | Σ | 0..1 | CodeableConcept | What is being requested/ordered Binding: https://healthterminologies.gov.au/fhir/ValueSet/evaluation-procedure-1 (example) |
| subject | Σ | 1..1 | Reference(Patient | Group | Location | Device) | Individual or Entity the service is ordered for |
| requester | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson) | Authorising individual, organisation or program (e.g. National Bowel Cancer Screening Program) |
| performerType | Σ | 0..1 | CodeableConcept | Performer role Binding: https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 (preferred) |
| reasonCode | Σ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 (preferred) |
| specimen | Σ | 0..* | Reference(AU Base Specimen) | Procedure Samples |
| bodySite | Σ | 0..* | CodeableConcept | Location on Body Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (preferred) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| ServiceRequest.status | required | RequestStatus |
| ServiceRequest.intent | required | RequestIntent |
| ServiceRequest.code | example | https://healthterminologies.gov.au/fhir/ValueSet/evaluation-procedure-1 |
| ServiceRequest.performerType | preferred | https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 |
| ServiceRequest.reasonCode | preferred | https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 |
| ServiceRequest.bodySite | preferred | https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| ServiceRequest | C | 0..* | ServiceRequest | A diagnostic service request in an Australian healthcare context | ||||
| 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 | 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 | Σ | 0..1 | Identifier | Composite Request ID | ||||
| status | ?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. | ||||
| intent | ?!Σ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. | ||||
| category | Σ | 0..* | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. | ||||
| priority | Σ | 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 | Σ | 0..1 | CodeableConcept | What is being requested/ordered Binding: https://healthterminologies.gov.au/fhir/ValueSet/evaluation-procedure-1 (example) | ||||
| 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 | Σ | 1..1 | Reference(Patient | Group | Location | Device) | Individual or Entity the service is ordered for | ||||
| encounter | Σ | 0..1 | Reference(Encounter) | Encounter in which the request was created | ||||
| 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 | Σ | 0..1 | dateTime | Date request signed | ||||
| requester | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson) | Authorising individual, organisation or program (e.g. National Bowel Cancer Screening Program) | ||||
| performerType | Σ | 0..1 | CodeableConcept | Performer role Binding: https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 (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 | Σ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 (preferred) | ||||
| reasonReference | Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Explanation/Justification for service or service | ||||
| insurance | 0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||
| supportingInfo | 0..* | Reference(Resource) | Additional clinical information | |||||
| specimen | Σ | 0..* | Reference(AU Base Specimen) | Procedure Samples | ||||
| bodySite | Σ | 0..* | CodeableConcept | Location on Body Binding: https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 (preferred) | ||||
| note | 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 | ||||
| ServiceRequest.language | preferred | CommonLanguages
| ||||
| ServiceRequest.status | required | RequestStatus | ||||
| ServiceRequest.intent | required | RequestIntent | ||||
| ServiceRequest.category | example | ServiceRequestCategoryCodes | ||||
| ServiceRequest.priority | required | RequestPriority | ||||
| ServiceRequest.code | example | https://healthterminologies.gov.au/fhir/ValueSet/evaluation-procedure-1 | ||||
| ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodes | ||||
| ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodes | ||||
| ServiceRequest.performerType | preferred | https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 | ||||
| ServiceRequest.locationCode | example | ServiceDeliveryLocationRoleType | ||||
| ServiceRequest.reasonCode | preferred | https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 | ||||
| ServiceRequest.bodySite | preferred | https://healthterminologies.gov.au/fhir/ValueSet/body-site-1 |
This structure is derived from ServiceRequest
Summary
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Maturity: 1
Other representations of profile: CSV, Excel, Schematron
none defined
IG © 2017+ HL7 Australia. Package hl7.fhir.au.base#4.1.0-ballot based on FHIR 4.0.1. Generated 2022-11-10
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change
