Australian Base Implementation Guide (AU Base 2)

AU Base Implementation Guide, published by HL7 Australia. This is not an authorized publication; it is the continuous build for version 2.1.0). 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

1.0 StructureDefinition-au-ihinumber

AU Individual Healthcare Identifier [FMM Level 0]

This identifier profile defines an Individual Healthcare Identifier - IHI [1] [2] in an Australian context.

Extensions

Extensions used in this profile:

  • Identifier: IHI Status [1]
  • Identifier: IHI Record Status [1]

Usage Notes

Mutiple Individual Healthcare Identifiers are supported particularly to support the recording of IHI values where the status and/or record status varies (e.g. deceased, provisional). Individual Healthcare Identifier is defined as a 16 digit number.

Examples

Patient with IHI, Medicare Number, and Health Care Card

Patient with IHI and DVA Number

Benedicte du Marche as a next of kin

Mary Smith as a carer

1.0.1 Formal Views of Profile Content

The official URL for this profile is:

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

This identifier profile defines Individual Healthcare Identifier - IHI in an Australian context.

This profile builds on Identifier.

This profile was published on Mon Mar 16 00:00:00 UTC 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..*IdentifierNational Individual Healthcare Identifier (IHI)
inv-ihi-value-0: IHI shall be an exactly 16 digit number
inv-ihi-value-1: IHI prefix is 800360
inv-ihi-value-2: IHI shall pass the Luhn algorithm check
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ihi-status 0..1CodingIndividual Healthcare Identifier (IHI) Number Status
URL: http://hl7.org.au/fhir/StructureDefinition/ihi-status
Binding: https://healthterminologies.gov.au/fhir/ValueSet/ihi-status-1 (required)
... ihi-record-status 0..1CodingIndividual Healthcare Identifier (IHI) Number Record Status
URL: http://hl7.org.au/fhir/StructureDefinition/ihi-record-status
Binding: https://healthterminologies.gov.au/fhir/ValueSet/ihi-record-status-1 (required)
... type 0..1CodeableConceptCoded identifier type for IHI
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: NI
.... text 0..1stringPlain text representation of the concept
Fixed Value: IHI
... system 1..1uriNamespace for IHI
Fixed Value: http://ns.electronichealth.net.au/id/hi/ihi/1.0
... value 1..1stringIHI number
Example IHI Number: 8003608833357361
Max Length: 16

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier I0..*IdentifierNational Individual Healthcare Identifier (IHI)
inv-ihi-value-0: IHI shall be an exactly 16 digit number
inv-ihi-value-1: IHI prefix is 800360
inv-ihi-value-2: IHI shall pass the Luhn algorithm check
... id 0..1stringUnique id for inter-element referencing
... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ihi-status I0..1CodingIndividual Healthcare Identifier (IHI) Number Status
URL: http://hl7.org.au/fhir/StructureDefinition/ihi-status
Binding: https://healthterminologies.gov.au/fhir/ValueSet/ihi-status-1 (required)
... ihi-record-status I0..1CodingIndividual Healthcare Identifier (IHI) Number Record Status
URL: http://hl7.org.au/fhir/StructureDefinition/ihi-record-status
Binding: https://healthterminologies.gov.au/fhir/ValueSet/ihi-record-status-1 (required)
... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
... type ΣI0..1CodeableConceptCoded identifier type for IHI
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: NI
..... 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: IHI
... system ΣI1..1uriNamespace for IHI
Fixed Value: http://ns.electronichealth.net.au/id/hi/ihi/1.0
... value ΣI1..1stringIHI number
Example General: 123456
Example IHI Number: 8003608833357361
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..*IdentifierNational Individual Healthcare Identifier (IHI)
inv-ihi-value-0: IHI shall be an exactly 16 digit number
inv-ihi-value-1: IHI prefix is 800360
inv-ihi-value-2: IHI shall pass the Luhn algorithm check
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ihi-status 0..1CodingIndividual Healthcare Identifier (IHI) Number Status
URL: http://hl7.org.au/fhir/StructureDefinition/ihi-status
Binding: https://healthterminologies.gov.au/fhir/ValueSet/ihi-status-1 (required)
... ihi-record-status 0..1CodingIndividual Healthcare Identifier (IHI) Number Record Status
URL: http://hl7.org.au/fhir/StructureDefinition/ihi-record-status
Binding: https://healthterminologies.gov.au/fhir/ValueSet/ihi-record-status-1 (required)
... type 0..1CodeableConceptCoded identifier type for IHI
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: NI
.... text 0..1stringPlain text representation of the concept
Fixed Value: IHI
... system 1..1uriNamespace for IHI
Fixed Value: http://ns.electronichealth.net.au/id/hi/ihi/1.0
... value 1..1stringIHI number
Example IHI Number: 8003608833357361
Max Length: 16

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier I0..*IdentifierNational Individual Healthcare Identifier (IHI)
inv-ihi-value-0: IHI shall be an exactly 16 digit number
inv-ihi-value-1: IHI prefix is 800360
inv-ihi-value-2: IHI shall pass the Luhn algorithm check
... id 0..1stringUnique id for inter-element referencing
... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ihi-status I0..1CodingIndividual Healthcare Identifier (IHI) Number Status
URL: http://hl7.org.au/fhir/StructureDefinition/ihi-status
Binding: https://healthterminologies.gov.au/fhir/ValueSet/ihi-status-1 (required)
... ihi-record-status I0..1CodingIndividual Healthcare Identifier (IHI) Number Record Status
URL: http://hl7.org.au/fhir/StructureDefinition/ihi-record-status
Binding: https://healthterminologies.gov.au/fhir/ValueSet/ihi-record-status-1 (required)
... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
... type ΣI0..1CodeableConceptCoded identifier type for IHI
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: NI
..... 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: IHI
... system ΣI1..1uriNamespace for IHI
Fixed Value: http://ns.electronichealth.net.au/id/hi/ihi/1.0
... value ΣI1..1stringIHI number
Example General: 123456
Example IHI Number: 8003608833357361
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-ihinumber

none defined