AU Care Agency Employee Identifier - AU Base Implementation Guide v4.2.2-preview

AU Base Implementation Guide
4.2.2-preview - Preview Australia flag

This page is part of the Australian Base IG (v4.2.2-preview: QA Preview) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 4.1.0. For a full list of available versions, see the Directory of published versions

Data Type Profile: AU Care Agency Employee Identifier

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

This identifier profile defines a care agency employee (CAE) identifier in an Australian context. A CAE identifier may be issued to an employee of, or person under contracted arrangement with, a care agency who wishes to participate in the My Health Record.

Usage Notes

Usage:

Use this DataType Constraint: AU Base Practitioner

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	Flags	Card.	Type	Description & Constraints
Identifier	C	0..*	Identifier	Care Agency Employee (CAE) Identifier inv-caei-0: CAE identifier shall be 16 digits inv-caei-1: CAE identifier prefix shall be 900360 inv-caei-2: CAE identifier shall pass the Luhn algorithm check
type		1..1	CodeableConcept	Description of 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: CAEI
system		1..1	uri	The namespace for the identifier value Fixed Value: http://ns.electronichealth.net.au/id/pcehr/caei/1.0
value		1..1	string	CAE identifier Example CAE identifier: 9003600003999997 Max Length:16
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
inv-caei-0	error	Identifier	CAE identifier shall be 16 digits : value.matches('^([0-9]{16})$')
inv-caei-1	error	Identifier	CAE identifier prefix shall be 900360 : value.startsWith('900360')
inv-caei-2	error	Identifier	CAE identifier shall pass the Luhn algorithm check : (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(15,1).toInteger()))mod 10=0)

Name	Flags	Card.	Type	Description & Constraints
Identifier	C	0..*	Identifier	Care Agency Employee (CAE) Identifier inv-caei-0: CAE identifier shall be 16 digits inv-caei-1: CAE identifier prefix shall be 900360 inv-caei-2: CAE identifier shall pass the Luhn algorithm check
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	Description of 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
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: CAEI
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: http://ns.electronichealth.net.au/id/pcehr/caei/1.0
value	Σ	1..1	string	CAE identifier Example General: 123456 Example CAE identifier: 9003600003999997 Max Length:16
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: CAEI `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())
inv-caei-0	error	Identifier	CAE identifier shall be 16 digits : value.matches('^([0-9]{16})$')
inv-caei-1	error	Identifier	CAE identifier prefix shall be 900360 : value.startsWith('900360')
inv-caei-2	error	Identifier	CAE identifier shall pass the Luhn algorithm check : (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(15,1).toInteger()))mod 10=0)

Name	Flags	Card.	Type	Description & Constraints
Identifier	C	0..*	Identifier	Care Agency Employee (CAE) Identifier inv-caei-0: CAE identifier shall be 16 digits inv-caei-1: CAE identifier prefix shall be 900360 inv-caei-2: CAE identifier shall pass the Luhn algorithm check
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	Description of 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: CAEI
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	The namespace for the identifier value Fixed Value: http://ns.electronichealth.net.au/id/pcehr/caei/1.0
value	Σ	1..1	string	CAE identifier Example General: 123456 Example CAE identifier: 9003600003999997 Max Length:16
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
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: CAEI `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())
ext-1	error	ALL extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
inv-caei-0	error	Identifier	CAE identifier shall be 16 digits : value.matches('^([0-9]{16})$')
inv-caei-1	error	Identifier	CAE identifier prefix shall be 900360 : value.startsWith('900360')
inv-caei-2	error	Identifier	CAE identifier shall pass the Luhn algorithm check : (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(15,1).toInteger()))mod 10=0)

This structure is derived from Identifier

Summary

Mandatory: 3 elements
Fixed: 1 element

Maturity: 1

Differential View

This structure is derived from Identifier

Name	Flags	Card.	Type	Description & Constraints
Identifier	C	0..*	Identifier	Care Agency Employee (CAE) Identifier inv-caei-0: CAE identifier shall be 16 digits inv-caei-1: CAE identifier prefix shall be 900360 inv-caei-2: CAE identifier shall pass the Luhn algorithm check
type		1..1	CodeableConcept	Description of 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: CAEI
system		1..1	uri	The namespace for the identifier value Fixed Value: http://ns.electronichealth.net.au/id/pcehr/caei/1.0
value		1..1	string	CAE identifier Example CAE identifier: 9003600003999997 Max Length:16
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
inv-caei-0	error	Identifier	CAE identifier shall be 16 digits : value.matches('^([0-9]{16})$')
inv-caei-1	error	Identifier	CAE identifier prefix shall be 900360 : value.startsWith('900360')
inv-caei-2	error	Identifier	CAE identifier shall pass the Luhn algorithm check : (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(15,1).toInteger()))mod 10=0)

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Identifier	C	0..*	Identifier	Care Agency Employee (CAE) Identifier inv-caei-0: CAE identifier shall be 16 digits inv-caei-1: CAE identifier prefix shall be 900360 inv-caei-2: CAE identifier shall pass the Luhn algorithm check
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	Description of 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
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: CAEI
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: http://ns.electronichealth.net.au/id/pcehr/caei/1.0
value	Σ	1..1	string	CAE identifier Example General: 123456 Example CAE identifier: 9003600003999997 Max Length:16
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: CAEI `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())
inv-caei-0	error	Identifier	CAE identifier shall be 16 digits : value.matches('^([0-9]{16})$')
inv-caei-1	error	Identifier	CAE identifier prefix shall be 900360 : value.startsWith('900360')
inv-caei-2	error	Identifier	CAE identifier shall pass the Luhn algorithm check : (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(15,1).toInteger()))mod 10=0)

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Identifier	C	0..*	Identifier	Care Agency Employee (CAE) Identifier inv-caei-0: CAE identifier shall be 16 digits inv-caei-1: CAE identifier prefix shall be 900360 inv-caei-2: CAE identifier shall pass the Luhn algorithm check
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	Description of 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: CAEI
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	The namespace for the identifier value Fixed Value: http://ns.electronichealth.net.au/id/pcehr/caei/1.0
value	Σ	1..1	string	CAE identifier Example General: 123456 Example CAE identifier: 9003600003999997 Max Length:16
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
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: CAEI `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())
ext-1	error	ALL extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
inv-caei-0	error	Identifier	CAE identifier shall be 16 digits : value.matches('^([0-9]{16})$')
inv-caei-1	error	Identifier	CAE identifier prefix shall be 900360 : value.startsWith('900360')
inv-caei-2	error	Identifier	CAE identifier shall pass the Luhn algorithm check : (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this2, (($this2)-9))))+(value.substring(15,1).toInteger()))mod 10=0)

This structure is derived from Identifier

Summary

Mandatory: 3 elements
Fixed: 1 element

Maturity: 1

Other representations of profile: CSV, Excel, Schematron

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