hcpd-hpio
type: StructureDefinition
node role: treeRoot
id:
  v: hcpd-hpio
text:
  status:
    v: extensions
  div:
    v: Generated Narrative: StructureDefinition hcpd-hpio Name Flags Card. Type Description & Constraints Identifier 0..* AUHPIO(6.0.0) Healthcare Provider Identifier – Organisation (HPI-O) #xD; extension 1..* Extension Extension #xD; Slices for extension Content/Rules for all slices #xD; extension:hi-org-classification S 1..1 CodeableConcept Organization classification URL: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hi-org-classification Binding: HI_Org_Classification_VS (26.0.0) (required) #xD; Documentation for this format
url:
  v: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-hpio
  l: hcpd-hpio
version:
  v: 26.0.0
name:
  v: HCPD_HPIO_Identifier
title:
  v: HCPD Healthcare Provider Identifier - Organisation (HCPD HPI-O)
status:
  v: active
experimental:
  v: false
date:
  v: 2026-04-30T11:47:54+10:00
publisher:
  v: Australian Digital Health Agency
contact:
  name:
    v: Australian Digital Health Agency
  telecom:
    system:
      v: url
    value:
      v: https://www.digitalhealth.gov.au/
  telecom:
    system:
      v: email
contact:
  name:
    v: Australian Digital Health Agency
  telecom:
    system:
      v: email
    use:
      v: work
description:
  v: This identifier profile extends the AU HPI-O profile to include an organization classification extension to indicate whether the organization is a 'seed' or 'network' type.
use context:
  code:
    system:
      v: http://terminology.hl7.org/CodeSystem/usage-context-type
      l: usage-context-type
    code:
      v: jurisdiction
  value: CodeableConcept
    coding:
      system:
        v: urn:iso:std:iso:3166
        l: 3166
      code:
        v: AU
      display:
        v: Australia
copyright:
  v: Copyright © 2026 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/.
fhir version:
  v: 4.0.1
mapping:
  identity:
    v: v2
  uri:
    v: http://hl7.org/v2
    l: v2
  name:
    v: HL7 v2 Mapping
mapping:
  identity:
    v: rim
  uri:
    v: http://hl7.org/v3
    l: v3
  name:
    v: RIM Mapping
mapping:
  identity:
    v: servd
  uri:
    v: http://www.omg.org/spec/ServD/1.0/
    l: http://www.omg.org/spec/ServD/1.0/
  name:
    v: ServD
kind:
  v: complex-type
abstract:
  v: false
type:
  v: Identifier
  l: Identifier
base definition:
  v: http://hl7.org.au/fhir/StructureDefinition/au-hpio|6.0.0
  l: http://hl7.org.au/fhir/StructureDefinition/au-hpio
derivation:
  v: constraint
snapshot:
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version
      l: snapshot-base-version
    value: String
      v: 6.0.0
  element:
    id:
      v: Identifier
    path:
      v: Identifier
    short:
      v: Healthcare Provider Identifier – Organisation (HPI-O)
    definition:
      v: Healthcare Provider Identifier – Organisation (HPI-O) assigned under the HI Service to an organisation (such as a hospital or medical clinic) where healthcare is provided.
    min:
      v: 0
    max:
      v: *
    base:
      path:
        v: Identifier
      min:
        v: 0
      max:
        v: *
    condition:
      v: ele-1
    constraint:
      key:
        v: ele-1
      severity:
        v: error
      human:
        v: All FHIR elements must have a @value or children
      expression:
        v: hasValue() or (children().count() > id.count())
      xpath:
        v: @value|f:*|h:div
      source:
        v: http://hl7.org/fhir/StructureDefinition/Element|4.0.1
        l: http://hl7.org/fhir/StructureDefinition/Element
    constraint:
      key:
        v: inv-hpio-0
      severity:
        v: error
      human:
        v: HPI-O shall be 16 digits
      expression:
        v: value.matches('^([0-9]{16})$')
      source:
        v: http://hl7.org.au/fhir/StructureDefinition/au-hpio|6.0.0
        l: http://hl7.org.au/fhir/StructureDefinition/au-hpio
    constraint:
      key:
        v: inv-hpio-1
      severity:
        v: error
      human:
        v: HPI-O prefix shall be 800362
      expression:
        v: value.startsWith('800362')
      source:
        v: http://hl7.org.au/fhir/StructureDefinition/au-hpio|6.0.0
        l: http://hl7.org.au/fhir/StructureDefinition/au-hpio
    constraint:
      key:
        v: inv-hpio-2
      severity:
        v: error
      human:
        v: HPI-O shall pass the Luhn algorithm check
      expression:
        v: (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(15,1).toInteger()))mod 10=0)
      source:
        v: http://hl7.org.au/fhir/StructureDefinition/au-hpio|6.0.0
        l: http://hl7.org.au/fhir/StructureDefinition/au-hpio
    is modifier:
      v: false
    mapping:
      identity:
        v: rim
      map:
        v: n/a
    mapping:
      identity:
        v: v2
      map:
        v: CX / EI (occasionally, more often EI maps to a resource id or a URL)
    mapping:
      identity:
        v: rim
      map:
        v: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
    mapping:
      identity:
        v: servd
      map:
        v: Identifier

id:
  v: Identifier.id
path:
  v: Identifier.id
representation:
  v: xmlAttr
short:
  v: Unique id for inter-element referencing
definition:
  v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
      l: structuredefinition-fhir-type
    value: Url
      v: string
      l: string
  code:
    v: http://hl7.org/fhirpath/System.String
    l: System.String
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Identifier.extension
path:
  v: Identifier.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
short:
  v: Extension
definition:
  v: An Extension
min:
  v: 1
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element|4.0.1
    l: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension|4.0.1
    l: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false

id:
  v: Identifier.extension:hi-org-classification
path:
  v: Identifier.extension
slice name:
  v: hi-org-classification
short:
  v: Organization classification
definition:
  v: Organization classification for HPI-O identifiers - can be 'seed' or 'network'.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hi-org-classification|26.0.0
    l: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hi-org-classification
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element|4.0.1
    l: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension|4.0.1
    l: http://hl7.org/fhir/StructureDefinition/Extension
must support:
  v: true
is modifier:
  v: false
is summary:
  v: false

id:
  v: Identifier.use
path:
  v: Identifier.use
short:
  v: usual | official | temp | secondary | old (If known)
definition:
  v: The purpose of this identifier.
comment:
  v: Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
requirements:
  v: Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Identifier.use
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
    l: code
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element|4.0.1
    l: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: true
is modifier reason:
  v: This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: IdentifierUse
  strength:
    v: required
  description:
    v: Identifies the purpose for this identifier, if known .
  value set:
    v: http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
    l: http://hl7.org/fhir/ValueSet/identifier-use
mapping:
  identity:
    v: v2
  map:
    v: N/A
mapping:
  identity:
    v: rim
  map:
    v: Role.code or implied by context

id:
  v: Identifier.type
path:
  v: Identifier.type
short:
  v: Description of identifier
definition:
  v: A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
comment:
  v: This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
requirements:
  v: Allows users to make use of identifiers when the identifier system is not known.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Identifier.type
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
pattern: CodeableConcept
  coding:
    system:
      v: http://terminology.hl7.org.au/CodeSystem/v2-0203
      l: v2-0203
    code:
      v: NOI
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element|4.0.1
    l: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: IdentifierType
  strength:
    v: extensible
  description:
    v: A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
  value set:
    v: http://hl7.org/fhir/ValueSet/identifier-type|4.0.1
    l: http://hl7.org/fhir/ValueSet/identifier-type
mapping:
  identity:
    v: v2
  map:
    v: CX.5
mapping:
  identity:
    v: rim
  map:
    v: Role.code or implied by context

id:
  v: Identifier.system
path:
  v: Identifier.system
short:
  v: The namespace for the identifier value
definition:
  v: Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
comment:
  v: Identifier.system is always case sensitive.
requirements:
  v: There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Identifier.system
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: uri
    l: uri
fixed: Uri
  v: http://ns.electronichealth.net.au/id/hi/hpio/1.0
  l: http://ns.electronichealth.net.au/id/hi/hpio/1.0
example:
  label:
    v: General
  value: Uri
    v: http://www.acme.com/identifiers/patient
    l: patient
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element|4.0.1
    l: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: CX.4 / EI-2-4
mapping:
  identity:
    v: rim
  map:
    v: II.root or Role.id.root
mapping:
  identity:
    v: servd
  map:
    v: ./IdentifierType

id:
  v: Identifier.value
path:
  v: Identifier.value
short:
  v: HPI-O
definition:
  v: The portion of the identifier typically relevant to the user and which is unique within the context of the system.
comment:
  v: This concept is equivalent to Australian Institute of Health and Welfare data element 426830 [Healthcare provider—organisation identifier, N(16)](https://meteor.aihw.gov.au/content/index.phtml/itemId/426830).
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Identifier.value
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
example:
  label:
    v: General
  value: String
    v: 123456
example:
  label:
    v: HPI-O
  value: String
    v: 8003621566684455
max length:
  v: 16
condition:
  v: inv-hpio-0
condition:
  v: inv-hpio-1
condition:
  v: inv-hpio-2
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element|4.0.1
    l: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: CX.1 / EI.1
mapping:
  identity:
    v: rim
  map:
    v: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
mapping:
  identity:
    v: servd
  map:
    v: ./Value

id:
  v: Identifier.period
path:
  v: Identifier.period
short:
  v: Time period when id is/was valid for use
definition:
  v: Time period during which identifier is/was valid for use.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Identifier.period
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Period
    l: Period
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element|4.0.1
    l: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: CX.7 + CX.8
mapping:
  identity:
    v: rim
  map:
    v: Role.effectiveTime or implied by context
mapping:
  identity:
    v: servd
  map:
    v: ./StartDate and ./EndDate

id:
  v: Identifier.assigner
path:
  v: Identifier.assigner
short:
  v: Organization that issued id (may be just text)
definition:
  v: Organization that issued/manages the identifier.
comment:
  v: The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Identifier.assigner
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Organization|4.0.1
    l: http://hl7.org/fhir/StructureDefinition/Organization
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element|4.0.1
    l: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: CX.4 / (CX.4,CX.9,CX.10)
mapping:
  identity:
    v: rim
  map:
    v: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
mapping:
  identity:
    v: servd
  map:
    v: ./IdentifierIssuingAuthority

element:
  id:
    v: Identifier
  path:
    v: Identifier
element:
  id:
    v: Identifier.extension
  path:
    v: Identifier.extension
  min:
    v: 1
element:
  id:
    v: Identifier.extension:hi-org-classification
  path:
    v: Identifier.extension
  slice name:
    v: hi-org-classification
  short:
    v: Organization classification
  definition:
    v: Organization classification for HPI-O identifiers - can be 'seed' or 'network'.
  min:
    v: 1
  max:
    v: 1
  type:
    code:
      v: Extension
      l: Extension
    profile:
      v: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hi-org-classification|26.0.0
      l: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hi-org-classification
  must support:
    v: true