Australian Base Implementation Guide (AU Base 2)

This page is part of the Australian Base IG (v2.1.0: AU Base 2 on R4) based on FHIR R4. For a full list of available versions, see the Directory of published versions

DRAFT
ONLY

1.0 StructureDefinition-au-diagnostic-servicerequest

AU Diagnostic Service Request [FMM Level 0]

This profile defines a service request structure that includes core localisation concepts for use as a diagnostic service request in an Australian context.

Note: The procedure-targetBodyStructure extension should only 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.

There are three preferred value sets when coding ServiceRequest.code:

Identifiers

These definitions represent common data held in the ServiceRequest.identifier element:

  • Placer order number [1]

Extensions

Extensions used in this profile:

  • ServiceRequest: procedure-targetBodyStructure (core extension) [1]

1.0.1 Formal Views of Profile Content

The official URL for this profile is:

http://hl7.org.au/fhir/StructureDefinition/au-diagnostic-servicerequest

This profile defines a service request structure that includes core localisation concepts for use as a diagnostic service request in an Australian context.

This profile builds on ServiceRequest.

This profile was published on Thu Feb 13 00:00:00 AEDT 2020 as a draft by Health Level Seven Australia (Orders and Observations WG).

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest 0..*ServiceRequestA diagnostic service request in an Australian healthcare context
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... procedure-targetBodyStructure 0..*Reference(BodyStructure)The target point for this procedure
URL: http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure
... identifier 0..*(Slice Definition)Identifiers assigned to this order
Slice: Unordered, Open by pattern:type
.... identifier:placerIdentifier 0..*IdentifierPlacer identifier
..... type 1..1CodeableConceptDescription of identifier
Binding: V2 Identifier Type - AU Extended (required)
...... coding 1..1CodingCode defined by a terminology system
Required Pattern: At least the following
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PLAC
..... system 1..1uriPlacer identifier system namespace
..... value 1..1stringPlacer identifier
... performerType
.... coding 0..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:anzscoPerformerType 0..1CodingAustralian and New Zealand Standard Classification of Occupations
Binding: https://healthterminologies.gov.au/fhir/ValueSet/anzsco-1 (required)
...... system 1..1uriIdentity of the terminology system
Fixed Value: http://www.abs.gov.au/ausstats/abs@.nsf/mf/1220.0
..... coding:snomedPerformerType 0..1CodingPractitioner Role (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 (required)
...... system 1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
... specimen 0..*Reference(AU Base Specimen)Procedure Samples

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest I0..*ServiceRequestA diagnostic service request in an Australian healthcare context
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
... procedure-targetBodyStructure I0..*Reference(BodyStructure)The target point for this procedure
URL: http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*(Slice Definition)Identifiers assigned to this order
Slice: Unordered, Open by pattern:type
.... identifier:placerIdentifier ΣI0..*IdentifierPlacer identifier
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI1..1CodeableConceptDescription of identifier
Binding: V2 Identifier Type - AU Extended (required)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding ΣI1..1CodingCode defined by a terminology system

Required Pattern: At least the following
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PLAC
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text ΣI0..1stringPlain text representation of the concept
..... system ΣI1..1uriPlacer identifier system namespace
Example General: http://www.acme.com/identifiers/patient
..... value ΣI1..1stringPlacer identifier
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
... instantiatesCanonical ΣI0..*canonical(ActivityDefinition | PlanDefinition)Instantiates FHIR protocol or definition
... instantiatesUri ΣI0..*uriInstantiates external protocol or definition
... basedOn ΣI0..*Reference(CarePlan | ServiceRequest | MedicationRequest)What request fulfills
... replaces ΣI0..*Reference(ServiceRequest)What request replaces
... requisition ΣI0..1IdentifierComposite Request ID
... status ?!ΣI1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required)
... intent ?!ΣI1..1codeproposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required)
... category ΣI0..*CodeableConceptClassification of service
Binding: ServiceRequestCategoryCodes (example)
... priority ΣI0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required)
... doNotPerform ?!ΣI0..1booleanTrue if service/procedure should not be performed
... code ΣI0..1CodeableConceptWhat is being requested/ordered
Binding: ProcedureCodes(SNOMEDCT) (example)
... orderDetail ΣI0..*CodeableConceptAdditional order information
Binding: ServiceRequestOrderDetailsCodes (example)
... quantity[x] ΣI0..1Service amount
.... quantityQuantityQuantity
.... quantityRatioRatio
.... quantityRangeRange
... subject ΣI1..1Reference(Patient | Group | Location | Device)Individual or Entity the service is ordered for
... encounter ΣI0..1Reference(Encounter)Encounter in which the request was created
... occurrence[x] ΣI0..1When service should occur
.... occurrenceDateTimedateTime
.... occurrencePeriodPeriod
.... occurrenceTimingTiming
... asNeeded[x] ΣI0..1Preconditions for service
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example)
.... asNeededBooleanboolean
.... asNeededCodeableConceptCodeableConcept
... authoredOn ΣI0..1dateTimeDate request signed
... requester ΣI0..1Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device)Who/what is requesting service
... performerType ΣI0..1CodeableConceptPerformer role
Binding: ParticipantRoles (example)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding ΣI0..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:anzscoPerformerType ΣI0..1CodingAustralian and New Zealand Standard Classification of Occupations
Binding: https://healthterminologies.gov.au/fhir/ValueSet/anzsco-1 (required)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system ΣI1..1uriIdentity of the terminology system
Fixed Value: http://www.abs.gov.au/ausstats/abs@.nsf/mf/1220.0
...... version ΣI0..1stringVersion of the system - if relevant
...... code ΣI0..1codeSymbol in syntax defined by the system
...... display ΣI0..1stringRepresentation defined by the system
...... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
..... coding:snomedPerformerType ΣI0..1CodingPractitioner Role (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 (required)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system ΣI1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... version ΣI0..1stringVersion of the system - if relevant
...... code ΣI0..1codeSymbol in syntax defined by the system
...... display ΣI0..1stringRepresentation defined by the system
...... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
.... text ΣI0..1stringPlain text representation of the concept
... performer ΣI0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson)Requested performer
... locationCode ΣI0..*CodeableConceptRequested location
Binding: V3 Value SetServiceDeliveryLocationRoleType (example)
... locationReference ΣI0..*Reference(Location)Requested location
... reasonCode ΣI0..*CodeableConceptExplanation/Justification for procedure or service
Binding: ProcedureReasonCodes (example)
... reasonReference ΣI0..*Reference(Condition | Observation | DiagnosticReport | DocumentReference)Explanation/Justification for service or service
... insurance I0..*Reference(Coverage | ClaimResponse)Associated insurance coverage
... supportingInfo I0..*Reference(Resource)Additional clinical information
... specimen ΣI0..*Reference(AU Base Specimen)Procedure Samples
... bodySite ΣI0..*CodeableConceptLocation on Body
Binding: SNOMEDCTBodyStructures (example)
... note I0..*AnnotationComments
... patientInstruction ΣI0..1stringPatient or consumer-oriented instructions
... relevantHistory I0..*Reference(Provenance)Request provenance

doco Documentation for this format

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest 0..*ServiceRequestA diagnostic service request in an Australian healthcare context
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... procedure-targetBodyStructure 0..*Reference(BodyStructure)The target point for this procedure
URL: http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure
... identifier 0..*(Slice Definition)Identifiers assigned to this order
Slice: Unordered, Open by pattern:type
.... identifier:placerIdentifier 0..*IdentifierPlacer identifier
..... type 1..1CodeableConceptDescription of identifier
Binding: V2 Identifier Type - AU Extended (required)
...... coding 1..1CodingCode defined by a terminology system
Required Pattern: At least the following
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PLAC
..... system 1..1uriPlacer identifier system namespace
..... value 1..1stringPlacer identifier
... performerType
.... coding 0..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:anzscoPerformerType 0..1CodingAustralian and New Zealand Standard Classification of Occupations
Binding: https://healthterminologies.gov.au/fhir/ValueSet/anzsco-1 (required)
...... system 1..1uriIdentity of the terminology system
Fixed Value: http://www.abs.gov.au/ausstats/abs@.nsf/mf/1220.0
..... coding:snomedPerformerType 0..1CodingPractitioner Role (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 (required)
...... system 1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
... specimen 0..*Reference(AU Base Specimen)Procedure Samples

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest I0..*ServiceRequestA diagnostic service request in an Australian healthcare context
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
... procedure-targetBodyStructure I0..*Reference(BodyStructure)The target point for this procedure
URL: http://hl7.org/fhir/StructureDefinition/procedure-targetBodyStructure
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*(Slice Definition)Identifiers assigned to this order
Slice: Unordered, Open by pattern:type
.... identifier:placerIdentifier ΣI0..*IdentifierPlacer identifier
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI1..1CodeableConceptDescription of identifier
Binding: V2 Identifier Type - AU Extended (required)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding ΣI1..1CodingCode defined by a terminology system

Required Pattern: At least the following
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: PLAC
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text ΣI0..1stringPlain text representation of the concept
..... system ΣI1..1uriPlacer identifier system namespace
Example General: http://www.acme.com/identifiers/patient
..... value ΣI1..1stringPlacer identifier
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
... instantiatesCanonical ΣI0..*canonical(ActivityDefinition | PlanDefinition)Instantiates FHIR protocol or definition
... instantiatesUri ΣI0..*uriInstantiates external protocol or definition
... basedOn ΣI0..*Reference(CarePlan | ServiceRequest | MedicationRequest)What request fulfills
... replaces ΣI0..*Reference(ServiceRequest)What request replaces
... requisition ΣI0..1IdentifierComposite Request ID
... status ?!ΣI1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required)
... intent ?!ΣI1..1codeproposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required)
... category ΣI0..*CodeableConceptClassification of service
Binding: ServiceRequestCategoryCodes (example)
... priority ΣI0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required)
... doNotPerform ?!ΣI0..1booleanTrue if service/procedure should not be performed
... code ΣI0..1CodeableConceptWhat is being requested/ordered
Binding: ProcedureCodes(SNOMEDCT) (example)
... orderDetail ΣI0..*CodeableConceptAdditional order information
Binding: ServiceRequestOrderDetailsCodes (example)
... quantity[x] ΣI0..1Service amount
.... quantityQuantityQuantity
.... quantityRatioRatio
.... quantityRangeRange
... subject ΣI1..1Reference(Patient | Group | Location | Device)Individual or Entity the service is ordered for
... encounter ΣI0..1Reference(Encounter)Encounter in which the request was created
... occurrence[x] ΣI0..1When service should occur
.... occurrenceDateTimedateTime
.... occurrencePeriodPeriod
.... occurrenceTimingTiming
... asNeeded[x] ΣI0..1Preconditions for service
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example)
.... asNeededBooleanboolean
.... asNeededCodeableConceptCodeableConcept
... authoredOn ΣI0..1dateTimeDate request signed
... requester ΣI0..1Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device)Who/what is requesting service
... performerType ΣI0..1CodeableConceptPerformer role
Binding: ParticipantRoles (example)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding ΣI0..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:anzscoPerformerType ΣI0..1CodingAustralian and New Zealand Standard Classification of Occupations
Binding: https://healthterminologies.gov.au/fhir/ValueSet/anzsco-1 (required)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system ΣI1..1uriIdentity of the terminology system
Fixed Value: http://www.abs.gov.au/ausstats/abs@.nsf/mf/1220.0
...... version ΣI0..1stringVersion of the system - if relevant
...... code ΣI0..1codeSymbol in syntax defined by the system
...... display ΣI0..1stringRepresentation defined by the system
...... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
..... coding:snomedPerformerType ΣI0..1CodingPractitioner Role (SNOMED CT)
Binding: https://healthterminologies.gov.au/fhir/ValueSet/practitioner-role-1 (required)
...... id 0..1stringUnique id for inter-element referencing
...... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system ΣI1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... version ΣI0..1stringVersion of the system - if relevant
...... code ΣI0..1codeSymbol in syntax defined by the system
...... display ΣI0..1stringRepresentation defined by the system
...... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
.... text ΣI0..1stringPlain text representation of the concept
... performer ΣI0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson)Requested performer
... locationCode ΣI0..*CodeableConceptRequested location
Binding: V3 Value SetServiceDeliveryLocationRoleType (example)
... locationReference ΣI0..*Reference(Location)Requested location
... reasonCode ΣI0..*CodeableConceptExplanation/Justification for procedure or service
Binding: ProcedureReasonCodes (example)
... reasonReference ΣI0..*Reference(Condition | Observation | DiagnosticReport | DocumentReference)Explanation/Justification for service or service
... insurance I0..*Reference(Coverage | ClaimResponse)Associated insurance coverage
... supportingInfo I0..*Reference(Resource)Additional clinical information
... specimen ΣI0..*Reference(AU Base Specimen)Procedure Samples
... bodySite ΣI0..*CodeableConceptLocation on Body
Binding: SNOMEDCTBodyStructures (example)
... note I0..*AnnotationComments
... patientInstruction ΣI0..1stringPatient or consumer-oriented instructions
... relevantHistory I0..*Reference(Provenance)Request provenance

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron

 

1.0.2 Quick Start

Below is an overview of the required search and read operations.

Summary of Search Criteria for StructureDefinition-au-diagnostic-servicerequest

none defined