AU Core Implementation Guide
0.2.0-preview - QA Preview Australia flag

This page is part of the Australian Core IG (v0.2.0-preview: AU Core) based on FHIR R4. For a full list of available versions, see the Directory of published versions

Resource Profile: AU Core ServiceRequest

Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-servicerequest Version: 0.2.0-preview
Standards status: Draft Maturity Level: 0 Computable Name: AUCoreServiceRequest

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

This profile sets minimum expectations for a ServiceRequest resource to record, search, and fetch information about requests, plans, or orders for a service for a patient. It is based on the core ServiceRequest resource and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the ServiceRequest when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.

Usage scenarios

The following are supported usage scenarios for this profile:

  • Query for a specific procedure or test request such as an electrocardiogram (ECG) order or a referral to a support program
  • Query for a specific service offered to a patient such as a referral to a support program
  • Query for category of service request (e.g. all cardiology requests)
  • Record or update a request for a service for a patient

Comparison with other national and international specifications

A resource conforming to this profile is conformant to:

No equivalent International Patient Access or International Patient Summary profile.

Conformance in reverse is not guaranteed, i.e. a resource conforming to US Core MAY NOT conform to AU Core.

Profile specific implementation guidance

  • ServiceRequest.category provides an efficient way of supporting system interactions, e.g. restricting searches. Implementers need to understand that data categorisation is somewhat subjective. The categorisation applied by the source may not align with a receiver’s expectations.
  • The use of coding can vary significantly across systems, client applications need to understand that they may encounter codes they do not recognise and be prepared to handle those resources appropriately. Servers SHOULD populate ServiceRequest.code.text and/or ServiceRequest.code.coding.display so that client applications can at least display the condition even if the client application does not recognise the code supplied.
  • The ServiceRequest resource can represent a reason as a code with ServiceRequest.reasonCode, or a reference with ServiceRequest.reasonReference to a Condition or other resource.
    • Although both are marked as must support, servers are not required to support both a code and a reference, but they SHALL support at least one of these elements
    • A client application SHALL support both elements
  • The ServiceRequest resource can represent the desired performer as a code with ServiceRequest.performerType, or a reference with ServiceRequest.performer to a HealthcareService or other resource.
    • Although both are marked as must support, servers are not required to support both a code and a reference, but they SHALL support at least one of these elements
    • A client application SHALL support both elements
  • ServiceRequest.supportingInfo is broad to accommodate a wide variety of use cases by allowing a reference to any resource.
    • servers SHALL ensure references to external resources are only to resources that conform to at least an AU Core profile and the resource type is supported by the Conformance/Capability statement for that endpoint and conform
    • See guidance on the construction of identifiers in each Identifier profile and the section on Business Identifiers in AU Base.
    • Source system identifiers that identify the business process (order ids) SHOULD be included as AU Local Order Identifier to support workflow and deduplication of ServiceRequest resources.
      • See guidance on the construction of an identifier on the relevant Identifier profile page and the section on Business Identifiers in AU Base.

Usage:

Formal Views of Profile Content

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

This structure is derived from ServiceRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest 0..*ServiceRequestA request for a service to be performed
... identifier S0..*IdentifierIdentifiers assigned to this order
... basedOn S0..*Reference(AU Core MedicationRequest | AU Core ServiceRequest)What request fulfills
... status S1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
... category S0..*CodeableConceptClassification of service
Binding: https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 (example)
... code S1..1CodeableConceptWhat is being requested/ordered
Binding: https://healthterminologies.gov.au/fhir/ValueSet/procedure-1 (preferred)
... subject S1..1Reference(AU Core Patient)Individual or Entity the service is ordered for
... encounter S0..1Reference(AU Core Encounter)Encounter in which the request was created
... authoredOn S0..1dateTimeDate request signed
... requester S1..1Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core Patient | AU Core RelatedPerson | AU Core System Device)Who/what is requesting service
... performerType S0..1CodeableConceptPerformer role
Binding: https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 (preferred)
... performer S0..*Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core CareTeam | AU Core HealthcareService | AU Core Patient | AU Core RelatedPerson)Requested performer
... reasonCode S0..*CodeableConceptExplanation/Justification for procedure or service
Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 (preferred)
... reasonReference S0..*Reference(AU Core Condition | AU Core Observation | AU Core DiagnosticReport | AU Core DocumentReference)Explanation/Justification for service or service
... supportingInfo S0..*Reference(Resource)Additional clinical information

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
ServiceRequest.categoryexamplehttps://healthterminologies.gov.au/fhir/ValueSet/service-type-1
ServiceRequest.codepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/procedure-1
ServiceRequest.performerTypepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1
ServiceRequest.reasonCodepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1
NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C0..*ServiceRequestA request for a service to be performed
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierIdentifiers assigned to this order
... status ?!SΣ1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.

... intent ?!SΣ1..1codeproposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of service request.

... category SΣ0..*CodeableConceptClassification of service
Binding: https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 (example)
... doNotPerform ?!Σ0..1booleanTrue if service/procedure should not be performed
... code SΣ1..1CodeableConceptWhat is being requested/ordered
Binding: https://healthterminologies.gov.au/fhir/ValueSet/procedure-1 (preferred)
... subject SΣ1..1Reference(AU Core Patient)Individual or Entity the service is ordered for
... encounter SΣ0..1Reference(AU Core Encounter)Encounter in which the request was created
... authoredOn SΣ0..1dateTimeDate request signed
... requester SΣ1..1Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core Patient | AU Core RelatedPerson | AU Core System Device)Who/what is requesting service
... performerType SΣ0..1CodeableConceptPerformer role
Binding: https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 (preferred)
... performer SΣ0..*Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core CareTeam | AU Core HealthcareService | AU Core Patient | AU Core RelatedPerson)Requested performer
... reasonCode SΣ0..*CodeableConceptExplanation/Justification for procedure or service
Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 (preferred)
... reasonReference SΣ0..*Reference(AU Core Condition | AU Core Observation | AU Core DiagnosticReport | AU Core DocumentReference)Explanation/Justification for service or service
... supportingInfo S0..*Reference(Resource)Additional clinical information

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
ServiceRequest.statusrequiredRequestStatus
ServiceRequest.intentrequiredRequestIntent
ServiceRequest.categoryexamplehttps://healthterminologies.gov.au/fhir/ValueSet/service-type-1
ServiceRequest.codepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/procedure-1
ServiceRequest.performerTypepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1
ServiceRequest.reasonCodepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1
NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C0..*ServiceRequestA request for a service to be performed
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierIdentifiers assigned to this order
... instantiatesCanonical Σ0..*canonical(ActivityDefinition | PlanDefinition)Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uriInstantiates external protocol or definition
... basedOn SΣ0..*Reference(AU Core MedicationRequest | AU Core ServiceRequest)What request fulfills
... replaces Σ0..*Reference(ServiceRequest)What request replaces
... requisition Σ0..1IdentifierComposite Request ID
... status ?!SΣ1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.

... intent ?!SΣ1..1codeproposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of service request.

... category SΣ0..*CodeableConceptClassification of service
Binding: https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 (example)
... priority Σ0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

... doNotPerform ?!Σ0..1booleanTrue if service/procedure should not be performed
... code SΣ1..1CodeableConceptWhat is being requested/ordered
Binding: https://healthterminologies.gov.au/fhir/ValueSet/procedure-1 (preferred)
... orderDetail ΣC0..*CodeableConceptAdditional order information
Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context.


... quantity[x] Σ0..1Service amount
.... quantityQuantityQuantity
.... quantityRatioRatio
.... quantityRangeRange
... subject SΣ1..1Reference(AU Core Patient)Individual or Entity the service is ordered for
... encounter SΣ0..1Reference(AU Core Encounter)Encounter in which the request was created
... occurrence[x] Σ0..1When service should occur
.... occurrenceDateTimedateTime
.... occurrencePeriodPeriod
.... occurrenceTimingTiming
... asNeeded[x] Σ0..1Preconditions 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.

.... asNeededBooleanboolean
.... asNeededCodeableConceptCodeableConcept
... authoredOn SΣ0..1dateTimeDate request signed
... requester SΣ1..1Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core Patient | AU Core RelatedPerson | AU Core System Device)Who/what is requesting service
... performerType SΣ0..1CodeableConceptPerformer role
Binding: https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 (preferred)
... performer SΣ0..*Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core CareTeam | AU Core HealthcareService | AU Core Patient | AU Core RelatedPerson)Requested performer
... locationCode Σ0..*CodeableConceptRequested location
Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered.


... locationReference Σ0..*Reference(Location)Requested location
... reasonCode SΣ0..*CodeableConceptExplanation/Justification for procedure or service
Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 (preferred)
... reasonReference SΣ0..*Reference(AU Core Condition | AU Core Observation | AU Core DiagnosticReport | AU Core DocumentReference)Explanation/Justification for service or service
... insurance 0..*Reference(Coverage | ClaimResponse)Associated insurance coverage
... supportingInfo S0..*Reference(Resource)Additional clinical information
... specimen Σ0..*Reference(Specimen)Procedure Samples
... bodySite Σ0..*CodeableConceptLocation on Body
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.


... note 0..*AnnotationComments
... patientInstruction Σ0..1stringPatient or consumer-oriented instructions
... relevantHistory 0..*Reference(Provenance)Request provenance

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
ServiceRequest.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
ServiceRequest.statusrequiredRequestStatus
ServiceRequest.intentrequiredRequestIntent
ServiceRequest.categoryexamplehttps://healthterminologies.gov.au/fhir/ValueSet/service-type-1
ServiceRequest.priorityrequiredRequestPriority
ServiceRequest.codepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/procedure-1
ServiceRequest.orderDetailexampleServiceRequestOrderDetailsCodes
ServiceRequest.asNeeded[x]exampleSNOMEDCTMedicationAsNeededReasonCodes
ServiceRequest.performerTypepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1
ServiceRequest.locationCodeexampleServiceDeliveryLocationRoleType
ServiceRequest.reasonCodepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1
ServiceRequest.bodySiteexampleSNOMEDCTBodyStructures

This structure is derived from ServiceRequest

Summary

Mandatory: 3 elements
Must-Support: 15 elements

Structures

This structure refers to these other structures:

Maturity: 0

Differential View

This structure is derived from ServiceRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest 0..*ServiceRequestA request for a service to be performed
... identifier S0..*IdentifierIdentifiers assigned to this order
... basedOn S0..*Reference(AU Core MedicationRequest | AU Core ServiceRequest)What request fulfills
... status S1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
... category S0..*CodeableConceptClassification of service
Binding: https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 (example)
... code S1..1CodeableConceptWhat is being requested/ordered
Binding: https://healthterminologies.gov.au/fhir/ValueSet/procedure-1 (preferred)
... subject S1..1Reference(AU Core Patient)Individual or Entity the service is ordered for
... encounter S0..1Reference(AU Core Encounter)Encounter in which the request was created
... authoredOn S0..1dateTimeDate request signed
... requester S1..1Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core Patient | AU Core RelatedPerson | AU Core System Device)Who/what is requesting service
... performerType S0..1CodeableConceptPerformer role
Binding: https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 (preferred)
... performer S0..*Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core CareTeam | AU Core HealthcareService | AU Core Patient | AU Core RelatedPerson)Requested performer
... reasonCode S0..*CodeableConceptExplanation/Justification for procedure or service
Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 (preferred)
... reasonReference S0..*Reference(AU Core Condition | AU Core Observation | AU Core DiagnosticReport | AU Core DocumentReference)Explanation/Justification for service or service
... supportingInfo S0..*Reference(Resource)Additional clinical information

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
ServiceRequest.categoryexamplehttps://healthterminologies.gov.au/fhir/ValueSet/service-type-1
ServiceRequest.codepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/procedure-1
ServiceRequest.performerTypepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1
ServiceRequest.reasonCodepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C0..*ServiceRequestA request for a service to be performed
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierIdentifiers assigned to this order
... status ?!SΣ1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.

... intent ?!SΣ1..1codeproposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of service request.

... category SΣ0..*CodeableConceptClassification of service
Binding: https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 (example)
... doNotPerform ?!Σ0..1booleanTrue if service/procedure should not be performed
... code SΣ1..1CodeableConceptWhat is being requested/ordered
Binding: https://healthterminologies.gov.au/fhir/ValueSet/procedure-1 (preferred)
... subject SΣ1..1Reference(AU Core Patient)Individual or Entity the service is ordered for
... encounter SΣ0..1Reference(AU Core Encounter)Encounter in which the request was created
... authoredOn SΣ0..1dateTimeDate request signed
... requester SΣ1..1Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core Patient | AU Core RelatedPerson | AU Core System Device)Who/what is requesting service
... performerType SΣ0..1CodeableConceptPerformer role
Binding: https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 (preferred)
... performer SΣ0..*Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core CareTeam | AU Core HealthcareService | AU Core Patient | AU Core RelatedPerson)Requested performer
... reasonCode SΣ0..*CodeableConceptExplanation/Justification for procedure or service
Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 (preferred)
... reasonReference SΣ0..*Reference(AU Core Condition | AU Core Observation | AU Core DiagnosticReport | AU Core DocumentReference)Explanation/Justification for service or service
... supportingInfo S0..*Reference(Resource)Additional clinical information

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
ServiceRequest.statusrequiredRequestStatus
ServiceRequest.intentrequiredRequestIntent
ServiceRequest.categoryexamplehttps://healthterminologies.gov.au/fhir/ValueSet/service-type-1
ServiceRequest.codepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/procedure-1
ServiceRequest.performerTypepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1
ServiceRequest.reasonCodepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C0..*ServiceRequestA request for a service to be performed
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierIdentifiers assigned to this order
... instantiatesCanonical Σ0..*canonical(ActivityDefinition | PlanDefinition)Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uriInstantiates external protocol or definition
... basedOn SΣ0..*Reference(AU Core MedicationRequest | AU Core ServiceRequest)What request fulfills
... replaces Σ0..*Reference(ServiceRequest)What request replaces
... requisition Σ0..1IdentifierComposite Request ID
... status ?!SΣ1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.

... intent ?!SΣ1..1codeproposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of service request.

... category SΣ0..*CodeableConceptClassification of service
Binding: https://healthterminologies.gov.au/fhir/ValueSet/service-type-1 (example)
... priority Σ0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

... doNotPerform ?!Σ0..1booleanTrue if service/procedure should not be performed
... code SΣ1..1CodeableConceptWhat is being requested/ordered
Binding: https://healthterminologies.gov.au/fhir/ValueSet/procedure-1 (preferred)
... orderDetail ΣC0..*CodeableConceptAdditional order information
Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context.


... quantity[x] Σ0..1Service amount
.... quantityQuantityQuantity
.... quantityRatioRatio
.... quantityRangeRange
... subject SΣ1..1Reference(AU Core Patient)Individual or Entity the service is ordered for
... encounter SΣ0..1Reference(AU Core Encounter)Encounter in which the request was created
... occurrence[x] Σ0..1When service should occur
.... occurrenceDateTimedateTime
.... occurrencePeriodPeriod
.... occurrenceTimingTiming
... asNeeded[x] Σ0..1Preconditions 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.

.... asNeededBooleanboolean
.... asNeededCodeableConceptCodeableConcept
... authoredOn SΣ0..1dateTimeDate request signed
... requester SΣ1..1Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core Patient | AU Core RelatedPerson | AU Core System Device)Who/what is requesting service
... performerType SΣ0..1CodeableConceptPerformer role
Binding: https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 (preferred)
... performer SΣ0..*Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core Organization | AU Core CareTeam | AU Core HealthcareService | AU Core Patient | AU Core RelatedPerson)Requested performer
... locationCode Σ0..*CodeableConceptRequested location
Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered.


... locationReference Σ0..*Reference(Location)Requested location
... reasonCode SΣ0..*CodeableConceptExplanation/Justification for procedure or service
Binding: https://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1 (preferred)
... reasonReference SΣ0..*Reference(AU Core Condition | AU Core Observation | AU Core DiagnosticReport | AU Core DocumentReference)Explanation/Justification for service or service
... insurance 0..*Reference(Coverage | ClaimResponse)Associated insurance coverage
... supportingInfo S0..*Reference(Resource)Additional clinical information
... specimen Σ0..*Reference(Specimen)Procedure Samples
... bodySite Σ0..*CodeableConceptLocation on Body
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.


... note 0..*AnnotationComments
... patientInstruction Σ0..1stringPatient or consumer-oriented instructions
... relevantHistory 0..*Reference(Provenance)Request provenance

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
ServiceRequest.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
ServiceRequest.statusrequiredRequestStatus
ServiceRequest.intentrequiredRequestIntent
ServiceRequest.categoryexamplehttps://healthterminologies.gov.au/fhir/ValueSet/service-type-1
ServiceRequest.priorityrequiredRequestPriority
ServiceRequest.codepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/procedure-1
ServiceRequest.orderDetailexampleServiceRequestOrderDetailsCodes
ServiceRequest.asNeeded[x]exampleSNOMEDCTMedicationAsNeededReasonCodes
ServiceRequest.performerTypepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1
ServiceRequest.locationCodeexampleServiceDeliveryLocationRoleType
ServiceRequest.reasonCodepreferredhttps://healthterminologies.gov.au/fhir/ValueSet/reason-for-request-1
ServiceRequest.bodySiteexampleSNOMEDCTBodyStructures

This structure is derived from ServiceRequest

Summary

Mandatory: 3 elements
Must-Support: 15 elements

Structures

This structure refers to these other structures:

Maturity: 0

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Below is an overview of the mandatory and optional search parameters and combined search parameters. FHIR search operations and the syntax used to describe the interactions is described here.

Any search parameter defined in FHIR may be ‘allowed’ by the system unless explicitly marked as “SHALL NOT”. A few items are marked as MAY in this implementation guide to highlight their potential relevance.

Parameter(s) Conformance Type(s) Requirements (when used alone or in combination)
patient SHALL reference The client SHALL provide at least an id value and MAY provide both the Type and id values. The server SHALL support both.
patient+category SHALL reference+token
patient+category+authored SHALL reference+token+date
patient+code SHALL reference+token
_id SHOULD token
identifier SHOULD token The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both.
patient+category+status SHOULD reference+token+token
patient.identifier SHOULD reference.token The client SHALL provide both the system and code values. The server SHALL support both.

The client SHOULD support search using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. The server SHOULD support search using the using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile.
patient+code+authored SHOULD reference+token+date
patient+status SHOULD reference+token
category MAY token The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both.
code MAY token The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both.
authored MAY date A client SHALL provide a value precise to the second + time offset. A server SHALL support a value precise to the second + time offset.
status MAY token The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both.

Mandatory Search Parameters:

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

  1. SHALL support searching using the patient search parameter:
    • SHALL support these _revinclude parameters: Provenance:target
    • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code]

    GET [base]/ServiceRequest?patient={Type/}[id] or optionallyGET [base]/ServiceRequest?patient.identifier=[system|][code]

    Example:

    1. GET [base]/ServiceRequest?patient=5678
    2. GET [base]/ServiceRequest?patient.identifier=http://ns.electronichealth.net.au/id/medicare-number|32788511952
    3. GET [base]/ServiceRequest?patient.identifier=http://ns.electronichealth.net.au/id/hi/ihi/1.0|8003608833357361

    Implementation Notes: Fetches a bundle of all ServiceRequest resources for the specified patient (how to search by reference and how to search by token)

  2. SHALL support searching using the combination of the patient and category search parameters:
    • SHALL support these _revinclude parameters: Provenance:target
    • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code])

    GET [base]/ServiceRequest?patient={Type/}[id]&category={system|}[code]

    Example:

    1. GET [base]/ServiceRequest?patient=5678&category=http://snomed.info/sct|708175003

    Implementation Notes: Fetches a bundle of all ServiceRequest resources for the specified patient and a category code = 708175003 (how to search by reference and how to search by token)

  3. SHALL support searching using the combination of the patient and category and authored search parameters:
    • SHALL support these _revinclude parameters: Provenance:target
    • SHALL support these date comparators: gt,lt,ge,le
    • SHOULD support multipleAnd search on authored (e.g.authored=[date]&authored=[date]]&...)

    GET [base]/ServiceRequest?patient={Type/}[id]&category={system|}[code]&authored={gt|lt|ge|le}[date]{&authored={gt|lt|ge|le}[date]&...}

    Example:

    1. GET [base]/ServiceRequest?patient=5678&category=http://snomed.info/sct|708175003&authored=ge2020-01-01T00:00:00Z

    Implementation Notes: Fetches a bundle of all ServiceRequest resources for the specified patient and date and a category code = 708175003 (how to search by reference and how to search by token and how to search by date)

  4. SHALL support searching using the combination of the patient and code search parameters:
    • SHALL support these _revinclude parameters: Provenance:target
    • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code])
    • SHOULD support multipleOr search on code (e.g.code={system|}[code],{system|}[code],...)

    GET [base]/ServiceRequest?patient={Type/}[id]&code={system|}[code]{,{system|}[code],...}

    Example:

    1. GET [base]/ServiceRequest?patient=5678&code=http://snomed.info/sct|169069000,http://snomed.info/sct|399208008

    Implementation Notes: Fetches a bundle of all ServiceRequest resources for the specified patient and diagnostic request code(s). The ServiceRequest code parameter searches `ServiceRequest.code only. (how to search by reference and how to search by token)

Optional Search Parameters:

The following search parameter combinations SHOULD be supported:

  1. SHOULD support fetching a ServiceRequest using the _id search parameter:
    • SHALL support these _revinclude parameters: Provenance:target GET [base]/ServiceRequest/[id] or GET [base]/ServiceRequest?_id=[id]

    Example:

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

    Implementation Notes: Fetches a single ServiceRequest. (how to search by the logical id of the resource)

  2. SHOULD support searching using the identifier search parameter:
    • SHALL support these _revinclude parameters: Provenance:target GET [base]/ServiceRequest?identifier={system|}[code]

    Example:

    1. GET [base]/ServiceRequest?identifier=http://gp.example.org|1032333

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

  3. SHOULD support searching using the combination of the patient and category and status search parameters:
    • SHALL support these _revinclude parameters: Provenance:target
    • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code])
    • SHOULD support multipleOr search on code (e.g.code={system|}[code],{system|}[code],...)
    • SHALL support multipleOr search on status (e.g.status={system|}[code],{system|}[code],...)

    GET [base]/ServiceRequest?patient={Type/}[id]&category={system|}[code]&status={system|}[code]{,{system|}[code],...}

    Example:

    1. GET [base]/ServiceRequest?patient=5678&category=http://snomed.info/sct|708175003&status=active

    Implementation Notes: Fetches a bundle of all ServiceRequest resources for the specified patient and category and status (how to search by reference and how to search by token)

  4. SHOULD support searching using the combination of the patient and code and authored search parameters:
    • SHALL support these _revinclude parameters: Provenance:target
    • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code]
    • SHOULD support multipleOr search on code (e.g.code={system|}[code],{system|}[code],...)
    • SHALL support these date comparators: gt,lt,ge,le
    • SHOULD support multipleAnd search on authored (e.g.authored=[date]&authored=[date]]&...)

    GET [base]/ServiceRequest?patient={Type/}[id]&code={system|}[code]{,{system|}[code],...}&authored={gt|lt|ge|le}[date]{&authored={gt|lt|ge|le}[date]&...}

    Example:

    1. GET [base]/ServiceRequest?patient=5678&code=http://snomed.info/sct|169069000,http://snomed.info/sct|399208008&authored=ge2020-01-01T00:00:00Z
    2. GET [base]/ServiceRequest?patient.identifier=http://example.org/fhir/mrn|12345&code=http://snomed.info/sct|169069000,http://snomed.info/sct|399208008&authored=ge2020-01-01T00:00:00Z

    Implementation Notes: Fetches a bundle of all ServiceRequest resources for the specified patient and date and request code(s). (how to search by reference and how to search by token and how to search by date)

  5. SHOULD support searching using the combination of the patient and status search parameters:
    • SHALL support these _revinclude parameters: Provenance:target
    • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code])
    • SHOULD support multipleOr search on code (e.g.code={system|}[code],{system|}[code],...)
    • SHALL support multipleOr search on status (e.g.status={system|}[code],{system|}[code],...)

    GET [base]/ServiceRequest?patient={Type/}[id]&status={system|}[code]{,{system|}[code],...}

    Example:

    1. GET [base]/ServiceRequest?patient=5678&status=active
    2. GET [base]/ServiceRequest?patient=5678&status=active&_revinclude=Provenance:target

    Implementation Notes: Fetches a bundle of all ServiceRequest resources for the specified patient and status (how to search by reference and how to search by token)