AU Local Dispense Identifier - AU Base Implementation Guide v5.0.1-ci-build

AU Base Implementation Guide
5.0.1-ci-build - CI Build Australia flag

AU Base Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 5.0.1-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-base/ and changes regularly. See the Directory of published versions

Data Type Profile: AU Local Dispense Identifier

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

This identifier profile defines a local dispense identifier in an Australian context. A local dispense identifier is an organisation’s identifier for a dispense record in that organisation’s local system set of dispense records. A dispense record identifier is typically assigned by the dispensing system and allows linking of a dispensing record to the dispensing system’s local identifier.

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 Medication Dispense

Changes since version 5.0.0:

No changes

Formal Views of Profile Content

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

Differential Table
Key Elements Table
Snapshot Table
Statistics/References
All

This structure is derived from Identifier

Name	Card.	Type	Description & Constraints
Identifier	0..*	Identifier	Local Dispense Identifier
type	1..1	CodeableConcept	Coded identifier type for local dispense identifier Required Pattern: At least the following
coding	1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system	1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203
code	1..1	code	Symbol in syntax defined by the system Fixed Value: LDI
system	1..1	uri	System identifier namespace for the organisation that assigned the dispense identifier
value	1..1	string	Dispense identifier
assigner	1..1	Reference(Organization)	Organisation that assigned the dispense identifier
display	1..1	string	Name of the assigning organisation
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Identifier		0..*	Identifier	Local Dispense 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 dispense identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203
code		1..1	code	Symbol in syntax defined by the system Fixed Value: LDI
system	Σ	1..1	uri	System identifier namespace for the organisation that assigned the dispense identifier ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	Dispense identifier ele-1: All FHIR elements must have a @value or children Example General: 123456
assigner	Σ	1..1	Reference(Organization)	Organisation that assigned the dispense 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 / Code	URI
Identifier.use	required	IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use\|4.0.1` from the FHIR Standard
Identifier.type	extensible	Pattern: LDI `http://hl7.org/fhir/ValueSet/identifier-type` 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())

Name	Flags	Card.	Type	Description & Constraints
Identifier		0..*	Identifier	Local Dispense 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 dispense identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
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.au/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: LDI
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 dispense identifier Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	Dispense 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 dispense 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 / Code	URI
Identifier.use	required	IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use\|4.0.1` from the FHIR Standard
Identifier.type	extensible	Pattern: LDI `http://hl7.org/fhir/ValueSet/identifier-type` from the FHIR Standard
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: 5 elements

Maturity: 1

Differential View

This structure is derived from Identifier

Name	Card.	Type	Description & Constraints
Identifier	0..*	Identifier	Local Dispense Identifier
type	1..1	CodeableConcept	Coded identifier type for local dispense identifier Required Pattern: At least the following
coding	1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system	1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203
code	1..1	code	Symbol in syntax defined by the system Fixed Value: LDI
system	1..1	uri	System identifier namespace for the organisation that assigned the dispense identifier
value	1..1	string	Dispense identifier
assigner	1..1	Reference(Organization)	Organisation that assigned the dispense identifier
display	1..1	string	Name of the assigning organisation
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Identifier		0..*	Identifier	Local Dispense 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 dispense identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203
code		1..1	code	Symbol in syntax defined by the system Fixed Value: LDI
system	Σ	1..1	uri	System identifier namespace for the organisation that assigned the dispense identifier ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	Dispense identifier ele-1: All FHIR elements must have a @value or children Example General: 123456
assigner	Σ	1..1	Reference(Organization)	Organisation that assigned the dispense 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 / Code	URI
Identifier.use	required	IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use\|4.0.1` from the FHIR Standard
Identifier.type	extensible	Pattern: LDI `http://hl7.org/fhir/ValueSet/identifier-type` 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())

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Identifier		0..*	Identifier	Local Dispense 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 dispense identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
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.au/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: LDI
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 dispense identifier Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	Dispense 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 dispense 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 / Code	URI
Identifier.use	required	IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use\|4.0.1` from the FHIR Standard
Identifier.type	extensible	Pattern: LDI `http://hl7.org/fhir/ValueSet/identifier-type` from the FHIR Standard
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: 5 elements

Maturity: 1

Other representations of profile: CSV, Excel, Schematron

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