Australian Base Implementation Guide (AU Base 2)

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

1.0 StructureDefinition-au-hpiinumber

AU HPI-I Number [FMM Level 0]

This identifier profile defines a Healthcare Provider Identifier - Individual - HPI-I[1] in an Australian context.

Examples

Practitioner with HPI-I, Prescriber Number and AHPRA Registration Number

AHPRA qualified General Practitioner

1.0.1 Formal Views of Profile Content

The official URL for this profile is: 

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

This identifier profile defines a Healthcare Provider Identifier - Individual - HPI-I in an Australian context.

This profile builds on Identifier.

This profile was published on Tue Mar 31 00:00:00 AEDT 2020 as a draft 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..*IdentifierHealthcare Provider Identifier – Individual (HPI-I)
inv-hpii-0: HPI-I shall be 16 digits
inv-hpii-1: HPI-I prefix shall be 800361
inv-hpii-2: HPI-I shall pass the Luhn algorithm check
... type 0..1CodeableConceptCoded identifier type for HPI-I
Binding: V2 Identifier Type - AU Extended (required)
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/CodeSystem/v2-0203
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: NPI
.... text 0..1stringPlain text representation of the concept
Fixed Value: HPI-I
... system 1..1uriNamespace for HPI-I
Fixed Value: http://ns.electronichealth.net.au/id/hi/hpii/1.0
... value 1..1stringHPI-I number
Example HPI-I number: 8003619900015717
Max Length: 16

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier I0..*IdentifierHealthcare Provider Identifier – Individual (HPI-I)
inv-hpii-0: HPI-I shall be 16 digits
inv-hpii-1: HPI-I prefix shall be 800361
inv-hpii-2: HPI-I shall pass the Luhn algorithm check
... id 0..1stringUnique id for inter-element referencing
... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
... type ΣI0..1CodeableConceptCoded identifier type for HPI-I
Binding: V2 Identifier Type - AU Extended (required)
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/CodeSystem/v2-0203
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: NPI
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding ΣI0..*CodingCode defined by a terminology system
.... text ΣI0..1stringPlain text representation of the concept
Fixed Value: HPI-I
... system ΣI1..1uriNamespace for HPI-I
Fixed Value: http://ns.electronichealth.net.au/id/hi/hpii/1.0
... value ΣI1..1stringHPI-I number
Example General: 123456
Example HPI-I number: 8003619900015717
Max Length: 16
... period ΣI0..1PeriodTime period when id is/was valid for use
... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)

doco Documentation for this format

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier I0..*IdentifierHealthcare Provider Identifier – Individual (HPI-I)
inv-hpii-0: HPI-I shall be 16 digits
inv-hpii-1: HPI-I prefix shall be 800361
inv-hpii-2: HPI-I shall pass the Luhn algorithm check
... type 0..1CodeableConceptCoded identifier type for HPI-I
Binding: V2 Identifier Type - AU Extended (required)
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/CodeSystem/v2-0203
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: NPI
.... text 0..1stringPlain text representation of the concept
Fixed Value: HPI-I
... system 1..1uriNamespace for HPI-I
Fixed Value: http://ns.electronichealth.net.au/id/hi/hpii/1.0
... value 1..1stringHPI-I number
Example HPI-I number: 8003619900015717
Max Length: 16

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier I0..*IdentifierHealthcare Provider Identifier – Individual (HPI-I)
inv-hpii-0: HPI-I shall be 16 digits
inv-hpii-1: HPI-I prefix shall be 800361
inv-hpii-2: HPI-I shall pass the Luhn algorithm check
... id 0..1stringUnique id for inter-element referencing
... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
... type ΣI0..1CodeableConceptCoded identifier type for HPI-I
Binding: V2 Identifier Type - AU Extended (required)
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/CodeSystem/v2-0203
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: NPI
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding ΣI0..*CodingCode defined by a terminology system
.... text ΣI0..1stringPlain text representation of the concept
Fixed Value: HPI-I
... system ΣI1..1uriNamespace for HPI-I
Fixed Value: http://ns.electronichealth.net.au/id/hi/hpii/1.0
... value ΣI1..1stringHPI-I number
Example General: 123456
Example HPI-I number: 8003619900015717
Max Length: 16
... period ΣI0..1PeriodTime period when id is/was valid for use
... assigner ΣI0..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-hpiinumber

none defined