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

• Content
• Detailed Descriptions
• XML
• JSON
• TTL

Data Type Profile: AU National Provider Identifier At Organisation

This identifier profile defines a National Provider Identifier at Organisation (NPIO) in an Australian context. An NPIO identifies an individual practitioner at an organisation using the practitioner’s HPI-I and organisation’s HPI-O to form the NPIO.

Usage:

• Use this DataType Constraint: AU Base Practitioner Role

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	National Provider Identifier at Organisation (NPIO) inv-npio-0: NPIO shall be 33 characters inv-npio-1: NPIO shall start with '800361', then 10 digits, then '@', then '800362', then 10 digits
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: NPIO
system		1..1	uri	The namespace for the identifier value Fixed Value: http://hl7.org.au/id/npio
value	C	1..1	string	NPIO Example NPIO: 8003619900015717@8003621566684455
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
inv-npio-0	error	Identifier	NPIO shall be 33 characters : value.length() = 33
inv-npio-1	error	Identifier	NPIO shall start with '800361', then 10 digits, then '@', then '800362', then 10 digits : value.matches('^(800361)([0-9]{10})(@)(800362)([0-9]{10})$')

Name	Flags	Card.	Type	Description & Constraints
Identifier	C	0..*	Identifier	National Provider Identifier at Organisation (NPIO) ele-1: All FHIR elements must have a @value or children inv-npio-0: NPIO shall be 33 characters inv-npio-1: NPIO shall start with '800361', then 10 digits, then '@', then '800362', then 10 digits
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	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. 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: NPIO
system	Σ	1..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Fixed Value: http://hl7.org.au/id/npio
value	ΣC	1..1	string	NPIO ele-1: All FHIR elements must have a @value or children Example General: 123456 Example NPIO: 8003619900015717@8003621566684455
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: NPIO 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-npio-0	error	Identifier	NPIO shall be 33 characters : value.length() = 33
inv-npio-1	error	Identifier	NPIO shall start with '800361', then 10 digits, then '@', then '800362', then 10 digits : value.matches('^(800361)([0-9]{10})(@)(800362)([0-9]{10})$')

Name	Flags	Card.	Type	Description & Constraints
Identifier	C	0..*	Identifier	National Provider Identifier at Organisation (NPIO) inv-npio-0: NPIO shall be 33 characters inv-npio-1: NPIO shall start with '800361', then 10 digits, then '@', then '800362', then 10 digits
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: NPIO
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://hl7.org.au/id/npio
value	ΣC	1..1	string	NPIO Example General: 123456 Example NPIO: 8003619900015717@8003621566684455
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: NPIO 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-npio-0	error	Identifier	NPIO shall be 33 characters : value.length() = 33
inv-npio-1	error	Identifier	NPIO shall start with '800361', then 10 digits, then '@', then '800362', then 10 digits : value.matches('^(800361)([0-9]{10})(@)(800362)([0-9]{10})$')

This structure is derived from Identifier

Summary

Mandatory: 3 elements
Fixed: 1 element

Maturity: 2

Differential View

This structure is derived from Identifier

Name	Flags	Card.	Type	Description & Constraints
Identifier	C	0..*	Identifier	National Provider Identifier at Organisation (NPIO) inv-npio-0: NPIO shall be 33 characters inv-npio-1: NPIO shall start with '800361', then 10 digits, then '@', then '800362', then 10 digits
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: NPIO
system		1..1	uri	The namespace for the identifier value Fixed Value: http://hl7.org.au/id/npio
value	C	1..1	string	NPIO Example NPIO: 8003619900015717@8003621566684455
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
inv-npio-0	error	Identifier	NPIO shall be 33 characters : value.length() = 33
inv-npio-1	error	Identifier	NPIO shall start with '800361', then 10 digits, then '@', then '800362', then 10 digits : value.matches('^(800361)([0-9]{10})(@)(800362)([0-9]{10})$')

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Identifier	C	0..*	Identifier	National Provider Identifier at Organisation (NPIO) ele-1: All FHIR elements must have a @value or children inv-npio-0: NPIO shall be 33 characters inv-npio-1: NPIO shall start with '800361', then 10 digits, then '@', then '800362', then 10 digits
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	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. 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: NPIO
system	Σ	1..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Fixed Value: http://hl7.org.au/id/npio
value	ΣC	1..1	string	NPIO ele-1: All FHIR elements must have a @value or children Example General: 123456 Example NPIO: 8003619900015717@8003621566684455
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: NPIO 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-npio-0	error	Identifier	NPIO shall be 33 characters : value.length() = 33
inv-npio-1	error	Identifier	NPIO shall start with '800361', then 10 digits, then '@', then '800362', then 10 digits : value.matches('^(800361)([0-9]{10})(@)(800362)([0-9]{10})$')

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Identifier	C	0..*	Identifier	National Provider Identifier at Organisation (NPIO) inv-npio-0: NPIO shall be 33 characters inv-npio-1: NPIO shall start with '800361', then 10 digits, then '@', then '800362', then 10 digits
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: NPIO
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://hl7.org.au/id/npio
value	ΣC	1..1	string	NPIO Example General: 123456 Example NPIO: 8003619900015717@8003621566684455
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: NPIO 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-npio-0	error	Identifier	NPIO shall be 33 characters : value.length() = 33
inv-npio-1	error	Identifier	NPIO shall start with '800361', then 10 digits, then '@', then '800362', then 10 digits : value.matches('^(800361)([0-9]{10})(@)(800362)([0-9]{10})$')

This structure is derived from Identifier

Summary

Mandatory: 3 elements
Fixed: 1 element

Maturity: 2

Other representations of profile: CSV, Excel, Schematron