AU Local Order Identifier - AU Base Implementation Guide v5.0.0

AU Base Implementation Guide
5.0.0 - Working Standard Australia flag

This page is part of the Australian Base IG (v5.0.0: R4) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Data Type Profile: AU Local Order Identifier

Official URL: http://hl7.org.au/fhir/StructureDefinition/au-localorderidentifier		Version: 5.0.0
Standards status: Trial-use	Maturity Level: 1	Computable Name: AULocalOrderIdentifier
Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.

This identifier profile defines a local order identifier in an Australian context. A local order identifier is an organisation’s identifier for an order in that organisation’s local system set of orders.

Typically a local order identifier will be either a placer identifier or a filler identifier (sometimes known as filler order number). A placer identifier is an identifier for a request or group of requests where the identifier is issued by the entity making the request. A filler identifier is an identifier for a request or group of requests where the identifier is issued by the entity that produces the observations or fulfills the request.

Usage Notes

Profile specific implementation guidance:

An organisation should use their own local system identifier namespace but if that is not available then see the guidance on Business Identifiers on using an HPI-O to construct a legal globally unique identifier system for local identifiers.

Usage:

Use this DataType Constraint: AU Base Diagnostic Report, AU Base Diagnostic Request, AU Base Diagnostic Imaging Report and AU Base Pathology Report

Formal Views of Profile Content

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

This structure is derived from Identifier

Name	Card.	Type	Description & Constraints
Identifier	0..*	Identifier	Local Order Identifier
type	1..1	CodeableConcept	Coded identifier type for local order identifier Binding: Order Identifier Type (required)
system	1..1	uri	System identifier namespace for the organisation that assigned the order identifier
value	1..1	string	Order identifier
assigner	0..1	Reference(Organization)	Organisation that assigned the order identifier
display	1..1	string	Name of the assigning organisation
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Identifier.type	required	OrderIdentifierType `http://terminology.hl7.org.au/ValueSet/order-identifier-type` from this IG

Name	Flags	Card.	Type	Description & Constraints
Identifier		0..*	Identifier	Local Order Identifier ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	usual \| official \| temp \| secondary \| old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
type	Σ	1..1	CodeableConcept	Coded identifier type for local order identifier Binding: Order Identifier Type (required) ele-1: All FHIR elements must have a @value or children
system	Σ	1..1	uri	System identifier namespace for the organisation that assigned the order identifier ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	Order identifier ele-1: All FHIR elements must have a @value or children Example General: 123456
assigner	Σ	0..1	Reference(Organization)	Organisation that assigned the order identifier ele-1: All FHIR elements must have a @value or children
display	Σ	1..1	string	Name of the assigning organisation ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Identifier.use	required	IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use\|4.0.1` from the FHIR Standard
Identifier.type	required	OrderIdentifierType `http://terminology.hl7.org.au/ValueSet/order-identifier-type` from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	ALL elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())

Name	Flags	Card.	Type	Description & Constraints
Identifier		0..*	Identifier	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)
system	Σ	1..1	uri	System identifier namespace for the organisation that assigned the order identifier Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	Order identifier Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organisation that assigned the order identifier
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	1..1	string	Name of the assigning organisation
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Identifier.use	required	IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use\|4.0.1` from the FHIR Standard
Identifier.type	required	OrderIdentifierType `http://terminology.hl7.org.au/ValueSet/order-identifier-type` from this IG
Identifier.assigner.type	extensible	ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	ALL elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	ALL extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Differential View

This structure is derived from Identifier

Name	Card.	Type	Description & Constraints
Identifier	0..*	Identifier	Local Order Identifier
type	1..1	CodeableConcept	Coded identifier type for local order identifier Binding: Order Identifier Type (required)
system	1..1	uri	System identifier namespace for the organisation that assigned the order identifier
value	1..1	string	Order identifier
assigner	0..1	Reference(Organization)	Organisation that assigned the order identifier
display	1..1	string	Name of the assigning organisation
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Identifier.type	required	OrderIdentifierType `http://terminology.hl7.org.au/ValueSet/order-identifier-type` from this IG

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Identifier		0..*	Identifier	Local Order Identifier ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	usual \| official \| temp \| secondary \| old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
type	Σ	1..1	CodeableConcept	Coded identifier type for local order identifier Binding: Order Identifier Type (required) ele-1: All FHIR elements must have a @value or children
system	Σ	1..1	uri	System identifier namespace for the organisation that assigned the order identifier ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	Order identifier ele-1: All FHIR elements must have a @value or children Example General: 123456
assigner	Σ	0..1	Reference(Organization)	Organisation that assigned the order identifier ele-1: All FHIR elements must have a @value or children
display	Σ	1..1	string	Name of the assigning organisation ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Identifier.use	required	IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use\|4.0.1` from the FHIR Standard
Identifier.type	required	OrderIdentifierType `http://terminology.hl7.org.au/ValueSet/order-identifier-type` from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	ALL elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Identifier		0..*	Identifier	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)
system	Σ	1..1	uri	System identifier namespace for the organisation that assigned the order identifier Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	Order identifier Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organisation that assigned the order identifier
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	1..1	string	Name of the assigning organisation
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Identifier.use	required	IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use\|4.0.1` from the FHIR Standard
Identifier.type	required	OrderIdentifierType `http://terminology.hl7.org.au/ValueSet/order-identifier-type` from this IG
Identifier.assigner.type	extensible	ResourceType `http://hl7.org/fhir/ValueSet/resource-types` from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	ALL elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	ALL extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from Identifier

Summary

Mandatory: 3 elements(1 nested mandatory element)

Maturity: 1

Other representations of profile: CSV, Excel, Schematron

IG © 2017+ HL7 Australia. Package hl7.fhir.au.base#5.0.0 based on FHIR 4.0.1. Generated 2025-01-15
Links: Table of Contents | QA Report | Version History | | Propose a change