Australian Base Implementation Guide

This page is part of AU Base v4.0.0 based on FHIR R4. For a full list of available versions, see the Directory of published versions

1.0 StructureDefinition-au-nationalprovideridentifieratorganisation

AU National Provider Identifier At Organisation [FMM 2]

This identifier profile defines a National Provider Identifier at Organisation (NPIO) [1] 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.

Extensions

No extensions are used in this profile.

Examples

Radiologist with National Provider Identifier at Organisation

1.0.1 Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org.au/fhir/StructureDefinition/au-nationalprovideridentifieratorganisation

This identifier profile defines a National Provider Identifier at Organisation (NPIO) in an Australian context.

This profile builds on Identifier.

This profile was published on 2022-04-04 as a active by Health Level Seven Australia (Patient Administration WG).

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier I0..*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 1..1stringNPIO
Example NPIO: 8003619900015717@8003621566684455

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier I0..*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 .

... 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
.... 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 Σ1..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

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier I0..*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 1..1stringNPIO
Example NPIO: 8003619900015717@8003621566684455

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier I0..*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 .

... 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
.... 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 Σ1..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

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron

 

1.0.2 Quick Start

Below is an overview of the required search and read operations.

Summary of Search Criteria for StructureDefinition-au-nationalprovideridentifieratorganisation

none defined

Issues & Feedback