AU Base Implementation Guide
4.1.2-preview - Preview Australia flag

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

Data Type Profile: AU National Provider Identifier At Organisation

Official URL: http://hl7.org.au/fhir/StructureDefinition/au-nationalprovideridentifieratorganisation Version: 4.1.2-preview
Standards status: Trial-use Maturity Level: 2 Computable Name: AUNationalProviderIdentifierAtOrganisation

Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.

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 Notes

Usage:

Formal Views of Profile Content

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

This structure is derived from Identifier

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier C0..*IdentifierNational 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..1CodeableConceptDescription of identifier
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: NPIO
... system 1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org.au/id/npio
... value C1..1stringNPIO
Example NPIO: 8003619900015717@8003621566684455

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
inv-npio-0errorIdentifierNPIO shall be 33 characters
: value.length() = 33
inv-npio-1errorIdentifierNPIO shall start with '800361', then 10 digits, then '@', then '800362', then 10 digits
: value.matches('^(800361)([0-9]{10})(@)(800362)([0-9]{10})$')
NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier C0..*IdentifierNational 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
... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

... type Σ1..1CodeableConceptDescription 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
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: NPIO
... system Σ1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org.au/id/npio

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Identifier.userequiredIdentifierUse
Identifier.typeextensiblePattern: NPIO

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
inv-npio-0errorIdentifierNPIO shall be 33 characters
: value.length() = 33
inv-npio-1errorIdentifierNPIO shall start with '800361', then 10 digits, then '@', then '800362', then 10 digits
: value.matches('^(800361)([0-9]{10})(@)(800362)([0-9]{10})$')
NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier C0..*IdentifierNational 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..1stringUnique id for inter-element referencing
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... 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.au/CodeSystem/v2-0203
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: NPIO
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... system Σ1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org.au/id/npio
... value ΣC1..1stringNPIO
Example General: 123456
Example NPIO: 8003619900015717@8003621566684455
... period Σ0..1PeriodTime period when id is/was valid for use
... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Identifier.userequiredIdentifierUse
Identifier.typeextensiblePattern: NPIO

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-npio-0errorIdentifierNPIO shall be 33 characters
: value.length() = 33
inv-npio-1errorIdentifierNPIO 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 Value: 1 element

Maturity: 2

Differential View

This structure is derived from Identifier

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier C0..*IdentifierNational 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..1CodeableConceptDescription of identifier
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: NPIO
... system 1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org.au/id/npio
... value C1..1stringNPIO
Example NPIO: 8003619900015717@8003621566684455

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
inv-npio-0errorIdentifierNPIO shall be 33 characters
: value.length() = 33
inv-npio-1errorIdentifierNPIO 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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier C0..*IdentifierNational 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
... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

... type Σ1..1CodeableConceptDescription 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
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: NPIO
... system Σ1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org.au/id/npio

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Identifier.userequiredIdentifierUse
Identifier.typeextensiblePattern: NPIO

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
inv-npio-0errorIdentifierNPIO shall be 33 characters
: value.length() = 33
inv-npio-1errorIdentifierNPIO 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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier C0..*IdentifierNational 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..1stringUnique id for inter-element referencing
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... 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.au/CodeSystem/v2-0203
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: NPIO
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... system Σ1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org.au/id/npio
... value ΣC1..1stringNPIO
Example General: 123456
Example NPIO: 8003619900015717@8003621566684455
... period Σ0..1PeriodTime period when id is/was valid for use
... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Identifier.userequiredIdentifierUse
Identifier.typeextensiblePattern: NPIO

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-npio-0errorIdentifierNPIO shall be 33 characters
: value.length() = 33
inv-npio-1errorIdentifierNPIO 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 Value: 1 element

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron