au-EntityName
type: StructureDefinition
node role: treeRoot
id:
  v: au-EntityName
text:
  status:
    v: generated
  div: A name for a person, organization, place or thing. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for entity name values are "Jim Bob Walton, Jr.", "Health Level Seven, Inc.", "Lake Tahoe", etc. An entity name may be as simple as a character string or may consist of several entity name parts, such as, "Jim", "Bob", "Walton", and "Jr.", "Health Level Seven" and "Inc.", "Lake" and "Tahoe".
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm
  value: integer
    v: 1
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/logical-target
  value: boolean
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/data-absent-reason
      value: code
        v: not-applicable
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-namespace
  value: uri
    v: urn:hl7-org:v3
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/logical-container
  value: uri
    v: http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument
url:
  v: http://ns.electronichealth.net.au/cda/StructureDefinition/au-EntityName
version:
  v: 1.0.1
name:
  v: au-EntityName
title:
  v: ADHA EN: EntityName (V3 Data Type)
status:
  v: active
experimental:
  v: false
date:
  v: 2025-10-10T09:58:30+10:00
publisher:
  v: Australian Digital Health Agency
contact:
  name:
    v: Australian Digital Health Agency
  telecom:
    system:
      v: email
description:
  v: **Australian adaptation of the [HL7 International CDA Entity Name dataType]( https://hl7.org/cda/stds/core/2.0.1-sd/StructureDefinition-EN.html)**. This is a generated StructureDefinition that describes CDA - that is, CDA as it actually is for R2. The intent of this StructureDefinition is to enable CDA to be a FHIR resource. That enables the FHIR infrastructure - API, conformance, query - to be used directly against CDA
jurisdiction:
  coding:
    system:
      v: urn:iso:std:iso:3166
    code:
      v: AU
copyright:
  v: Copyright © 2024 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: 5.0.0
mapping:
  identity:
    v: rim
  uri:
    v: http://hl7.org/v3
  name:
    v: RIM Mapping
kind:
  v: logical
abstract:
  v: false
type:
  v: http://hl7.org/cda/stds/core/StructureDefinition/EN
base definition:
  v: http://hl7.org/cda/stds/core/StructureDefinition/ANY
  link: http://hl7.org/cda/stds/core/StructureDefinition/ANY
derivation:
  v: specialization
snapshot:
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version
    value: string
      v: 1.0.1
  element:
    id:
      v: EN
    path:
      v: EN
    short:
      v: Australian adaptation of the HL7 International EntityName (EN) dataType
    definition:
      v: A name for a person, organization, place or thing. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for entity name values are "Jim Bob Walton, Jr.", "Health Level Seven, Inc.", "Lake Tahoe", etc. An entity name may be as simple as a character string or may consist of several entity name parts, such as, "Jim", "Bob", "Walton", and "Jr.", "Health Level Seven" and "Inc.", "Lake" and "Tahoe".
    min:
      v: 1
    max:
      v: *
    base:
      path:
        v: Base
      min:
        v: 0
      max:
        v: *
    is modifier:
      v: false
    mapping:
      identity:
        v: rim
      map:
        v: n/a
  element:
    id:
      v: EN.nullFlavor
    path:
      v: EN.nullFlavor
    representation:
      v: xmlAttr
    label:
      v: Exceptional Value Detail
    definition:
      v: If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
    min:
      v: 0
    max:
      v: 1
    base:
      path:
        v: ANY.nullFlavor
      min:
        v: 0
      max:
        v: 1
    type:
      code:
        v: code
      profile:
        v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
        link: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    binding:
      strength:
        v: required
      value set:
        v: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
        link: http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
  element:
    id:
      v: EN.use
    path:
      v: EN.use
    representation:
      v: xmlAttr
    label:
      v: Use Code
    definition:
      v: A set of codes advising a system or user which name in a set of like names to select for a given purpose. A name without specific use code might be a default name useful for any purpose, but a name with a specific use code would be preferred for that respective purpose
    min:
      v: 0
    max:
      v: *
    base:
      path:
        v: EN.use
      min:
        v: 0
      max:
        v: *
    type:
      code:
        v: code
      profile:
        v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
        link: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
    binding:
      strength:
        v: required
      value set:
        v: http://ns.electronichealth.net.au/cda/ValueSet/dh-entitynameuse
        link: http://ns.electronichealth.net.au/cda/ValueSet/dh-entitynameuse
  element:
    id:
      v: EN.item
    extension:
      url:
        v: http://hl7.org/fhir/tools/StructureDefinition/xml-choice-group
      value: boolean
        v: true
    path:
      v: EN.item
    definition:
      v: A series of items that constitute the name.
    min:
      v: 0
    max:
      v: *
    base:
      path:
        v: EN.item

v: 0

v: *

key:
  v: EN-1
severity:
  v: error
human:
  v: Can only have only one of the possible item elements in each choice
expression:
  v: (delimiter | family | given | prefix | suffix | xmlText).count() = 1

id:
  v: EN.item.delimiter
path:
  v: EN.item.delimiter
min:
  v: 0
max:
  v: *
base:
  path:
    v: EN.item.delimiter
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ENXP

id:
  v: EN.item.family
path:
  v: EN.item.family
min:
  v: 0
max:
  v: *
base:
  path:
    v: EN.item.family
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ENXP

id:
  v: EN.item.given
path:
  v: EN.item.given
min:
  v: 0
max:
  v: *
base:
  path:
    v: EN.item.given
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ENXP

id:
  v: EN.item.prefix
path:
  v: EN.item.prefix
min:
  v: 0
max:
  v: *
base:
  path:
    v: EN.item.prefix
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ENXP

id:
  v: EN.item.suffix
path:
  v: EN.item.suffix
min:
  v: 0
max:
  v: *
base:
  path:
    v: EN.item.suffix
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ENXP

id:
  v: EN.item.xmlText
path:
  v: EN.item.xmlText
representation:
  v: xmlText
short:
  v: Allows for mixed text content
comment:
  v: This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EN.item.xmlText
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
    link: http://hl7.org/cda/stds/core/StructureDefinition/st-simple

id:
  v: EN.validTime
path:
  v: EN.validTime
label:
  v: Valid Time
definition:
  v: An interval of time specifying the time during which the name is or was used for the entity. This accomodates the fact that people change names for people, places and things.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: EN.validTime
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS

element:
  id:
    v: EN
  path:
    v: EN
  short:
    v: Australian adaptation of the HL7 International EntityName (EN) dataType
  definition:
    v: A name for a person, organization, place or thing. A sequence of name parts, such as given name or family name, prefix, suffix, etc. Examples for entity name values are "Jim Bob Walton, Jr.", "Health Level Seven, Inc.", "Lake Tahoe", etc. An entity name may be as simple as a character string or may consist of several entity name parts, such as, "Jim", "Bob", "Walton", and "Jr.", "Health Level Seven" and "Inc.", "Lake" and "Tahoe".
  min:
    v: 1
  max:
    v: *
element:
  id:
    v: EN.use
  path:
    v: EN.use
  representation:
    v: xmlAttr
  label:
    v: Use Code
  definition:
    v: A set of codes advising a system or user which name in a set of like names to select for a given purpose. A name without specific use code might be a default name useful for any purpose, but a name with a specific use code would be preferred for that respective purpose
  min:
    v: 0
  max:
    v: *
  type:
    code:
      v: code
    profile:
      v: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
      link: http://hl7.org/cda/stds/core/StructureDefinition/cs-simple
  binding:
    strength:
      v: required
    value set:
      v: http://ns.electronichealth.net.au/cda/ValueSet/dh-entitynameuse
      link: http://ns.electronichealth.net.au/cda/ValueSet/dh-entitynameuse
element:
  id:
    v: EN.item
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/xml-choice-group
    value: boolean
      v: true
  path:
    v: EN.item
  definition:
    v: A series of items that constitute the name.
  min:
    v: 0
  max:
    v: *
  type:
    code:
      v: http://hl7.org/fhir/StructureDefinition/Base
  constraint:
    key:
      v: EN-1
    severity:
      v: error
    human:
      v: Can only have only one of the possible item elements in each choice
    expression:
      v: (delimiter | family | given | prefix | suffix | xmlText).count() = 1
element:
  id:
    v: EN.item.delimiter
  path:
    v: EN.item.delimiter
  min:
    v: 0
  max:
    v: *
  type:
    code:
      v: http://hl7.org/cda/stds/core/StructureDefinition/ENXP
element:
  id:
    v: EN.item.family
  path:
    v: EN.item.family
  min:
    v: 0
  max:
    v: *
  type:
    code:
      v: http://hl7.org/cda/stds/core/StructureDefinition/ENXP
element:
  id:
    v: EN.item.given
  path:
    v: EN.item.given
  min:
    v: 0
  max:
    v: *
  type:
    code:
      v: http://hl7.org/cda/stds/core/StructureDefinition/ENXP
element:
  id:
    v: EN.item.prefix
  path:
    v: EN.item.prefix
  min:
    v: 0
  max:
    v: *
  type:
    code:
      v: http://hl7.org/cda/stds/core/StructureDefinition/ENXP
element:
  id:
    v: EN.item.suffix
  path:
    v: EN.item.suffix
  min:
    v: 0
  max:
    v: *
  type:
    code:
      v: http://hl7.org/cda/stds/core/StructureDefinition/ENXP
element:
  id:
    v: EN.item.xmlText
  path:
    v: EN.item.xmlText
  representation:
    v: xmlText
  short:
    v: Allows for mixed text content
  comment:
    v: This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: string
    profile:
      v: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
      link: http://hl7.org/cda/stds/core/StructureDefinition/st-simple
element:
  id:
    v: EN.validTime
  path:
    v: EN.validTime
  label:
    v: Valid Time
  definition:
    v: An interval of time specifying the time during which the name is or was used for the entity. This accomodates the fact that people change names for people, places and things.
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS