alternate-name
type: StructureDefinition
node role: treeRoot
id:
  v: alternate-name
text:
  status:
    v: extensions
  div:
    v: Generated Narrative: StructureDefinition alternate-name Name Flags Card. Type Description & Constraints Extension 0..* Extension(4.0.1) Alternate name for practitioner in role context #xD; extension 0..0 Extension #xD; url 1..1 uri "http://digitalhealth.gov.au/fhir/cc/StructureDefinition/alternate-name" #xD; value[x] 1..1 HumanName Alternate name #xD; use S 0..1 code Alternate name use #xD; family S 0..1 string Alternate family name #xD; given S 0..* string Alternate given name(s) #xD; prefix S 0..* string Alternate name prefix (title) #xD; Documentation for this format
url:
  v: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/alternate-name
  l: alternate-name
version:
  v: 26.0.0
name:
  v: Alternate_Name
title:
  v: Alternate Name
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 extension applies to PractitionerRole, and represents a name by which a practitioner chooses to be known in the context of the delivery of a specific healthcare service.
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/](https://creativecommons.org/licenses/by/4.0/)
fhir version:
  v: 4.0.1
mapping:
  identity:
    v: rim
  uri:
    v: http://hl7.org/v3
    l: v3
  name:
    v: RIM Mapping
kind:
  v: complex-type
abstract:
  v: false
context:
  type:
    v: element
  expression:
    v: PractitionerRole
type:
  v: Extension
  l: Extension
base definition:
  v: http://hl7.org/fhir/StructureDefinition/Extension|4.0.1
  l: http://hl7.org/fhir/StructureDefinition/Extension
derivation:
  v: constraint
snapshot:
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version
      l: snapshot-base-version
    value: String
      v: 4.0.1
  element:
    id:
      v: Extension
    path:
      v: Extension
    short:
      v: Alternate name for practitioner in role context
    definition:
      v: A name by which a practitioner chooses to be known in the context of the delivery of a specific healthcare service. This may differ from their registered legal name.
    min:
      v: 0
    max:
      v: *
    base:
      path:
        v: Extension
      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: 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
  element:
    id:
      v: Extension.id
    path:
      v: Extension.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:
        value: Url
      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
  element:
    id:
      v: Extension.extension
    path:
      v: Extension.extension
    slicing:
      description:
        v: Extensions are always sliced by (at least) url
      rules:
        v: open
    short:
      v: Extension
    definition:
      v: An Extension

Url
v: string
l: string

v: value

v: url

v: 0

v: 0

path:
  v: Element.extension
min:
  v: 0
max:
  v: *

code:
  v: Extension
  l: Extension

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

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

v: false

v: false

id:
  v: Extension.url
path:
  v: Extension.url
representation:
  v: xmlAttr
short:
  v: identifies the meaning of the extension
definition:
  v: Source of the definition for the extension code - a logical name or a URL.
comment:
  v: The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Extension.url
  min:
    v: 1
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
      l: structuredefinition-fhir-type
    value: Url
      v: uri
      l: uri
  code:
    v: http://hl7.org/fhirpath/System.String
    l: System.String
fixed: Uri
  v: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/alternate-name
  l: alternate-name
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Extension.value[x]
path:
  v: Extension.value[x]
short:
  v: Alternate name
definition:
  v: The alternate name by which the practitioner wishes to be known in this role context.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Extension.value[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: HumanName
    l: HumanName
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: false
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Extension.value[x].id
path:
  v: Extension.value[x].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: Extension.value[x].extension
path:
  v: Extension.value[x].extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
short:
  v: Additional content defined by implementations
definition:
  v: May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
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
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Extension.value[x].use
path:
  v: Extension.value[x].use
short:
  v: Alternate name use
definition:
  v: The use of this alternate name (usual, temp, etc.)
comment:
  v: Applications can assume that a name is current unless it explicitly says that it is temporary or old.
requirements:
  v: Allows the appropriate name for a particular context of use to be selected from among a set of names.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: HumanName.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
must support:
  v: true
is modifier:
  v: true
is modifier reason:
  v: This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: NameUse
  strength:
    v: required
  description:
    v: The use of a human name.
  value set:
    v: http://hl7.org/fhir/ValueSet/name-use|4.0.1
    l: http://hl7.org/fhir/ValueSet/name-use
mapping:
  identity:
    v: v2
  map:
    v: XPN.7, but often indicated by which field contains the name
mapping:
  identity:
    v: rim
  map:
    v: unique(./use)
mapping:
  identity:
    v: servd
  map:
    v: ./NamePurpose

id:
  v: Extension.value[x].text
path:
  v: Extension.value[x].text
short:
  v: Text representation of the full name
definition:
  v: Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.
comment:
  v: Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.
requirements:
  v: A renderable, unencoded form.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: HumanName.text
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
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: implied by XPN.11
mapping:
  identity:
    v: rim
  map:
    v: ./formatted

id:
  v: Extension.value[x].family
path:
  v: Extension.value[x].family
short:
  v: Alternate family name
definition:
  v: The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.
comment:
  v: Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).
alias:
  v: surname
min:
  v: 0
max:
  v: 1
base:
  path:
    v: HumanName.family
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
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
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: XPN.1/FN.1
mapping:
  identity:
    v: rim
  map:
    v: ./part[partType = FAM]
mapping:
  identity:
    v: servd
  map:
    v: ./FamilyName

id:
  v: Extension.value[x].given
path:
  v: Extension.value[x].given
short:
  v: Alternate given name(s)
definition:
  v: Given name.
comment:
  v: If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.
alias:
  v: first name
alias:
  v: middle name
min:
  v: 0
max:
  v: *
base:
  path:
    v: HumanName.given
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: string
    l: string
order meaning:
  v: Given Names appear in the correct order for presenting the name
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
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: XPN.2 + XPN.3
mapping:
  identity:
    v: rim
  map:
    v: ./part[partType = GIV]
mapping:
  identity:
    v: servd
  map:
    v: ./GivenNames

id:
  v: Extension.value[x].prefix
path:
  v: Extension.value[x].prefix
short:
  v: Alternate name prefix (title)
definition:
  v: Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.
min:
  v: 0
max:
  v: *
base:
  path:
    v: HumanName.prefix
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: string
    l: string
order meaning:
  v: Prefixes appear in the correct order for presenting the name
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
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: XPN.5
mapping:
  identity:
    v: rim
  map:
    v: ./part[partType = PFX]
mapping:
  identity:
    v: servd
  map:
    v: ./TitleCode

id:
  v: Extension.value[x].suffix
path:
  v: Extension.value[x].suffix
short:
  v: Parts that come after the name
definition:
  v: Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.
min:
  v: 0
max:
  v: *
base:
  path:
    v: HumanName.suffix
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: string
    l: string
order meaning:
  v: Suffixes appear in the correct order for presenting the name
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: XPN/4
mapping:
  identity:
    v: rim
  map:
    v: ./part[partType = SFX]

id:
  v: Extension.value[x].period
path:
  v: Extension.value[x].period
short:
  v: Time period when name was/is in use
definition:
  v: Indicates the period of time when this name was valid for the named person.
requirements:
  v: Allows names to be placed in historical context.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: HumanName.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: XPN.13 + XPN.14
mapping:
  identity:
    v: rim
  map:
    v: ./usablePeriod[type="IVL<TS>"]
mapping:
  identity:
    v: servd
  map:
    v: ./StartDate and ./EndDate

element:
  id:
    v: Extension
  path:
    v: Extension
  short:
    v: Alternate name for practitioner in role context
  definition:
    v: A name by which a practitioner chooses to be known in the context of the delivery of a specific healthcare service. This may differ from their registered legal name.
element:
  id:
    v: Extension.extension
  path:
    v: Extension.extension
  max:
    v: 0
element:
  id:
    v: Extension.url
  path:
    v: Extension.url
  fixed: Uri
    v: http://digitalhealth.gov.au/fhir/cc/StructureDefinition/alternate-name
    l: alternate-name
element:
  id:
    v: Extension.value[x]
  path:
    v: Extension.value[x]
  short:
    v: Alternate name
  definition:
    v: The alternate name by which the practitioner wishes to be known in this role context.
  min:
    v: 1
  type:
    code:
      v: HumanName
      l: HumanName
element:
  id:
    v: Extension.value[x].use
  path:
    v: Extension.value[x].use
  short:
    v: Alternate name use
  definition:
    v: The use of this alternate name (usual, temp, etc.)
  must support:
    v: true
element:
  id:
    v: Extension.value[x].family
  path:
    v: Extension.value[x].family
  short:
    v: Alternate family name
  must support:
    v: true
element:
  id:
    v: Extension.value[x].given
  path:
    v: Extension.value[x].given
  short:
    v: Alternate given name(s)
  must support:
    v: true
element:
  id:
    v: Extension.value[x].prefix
  path:
    v: Extension.value[x].prefix
  short:
    v: Alternate name prefix (title)
  must support:
    v: true