assigningGeographicArea
type: StructureDefinition
node role: treeRoot
id:
  v: assigningGeographicArea
text:
  status:
    v: extensions
  div: Generated Narrative: StructureDefinition assigningGeographicArea Name Flags Card. Type Description & Constraints assigningGeographicArea 1..* InfrastructureRoot XML Namespace: urn:hl7-org:v3 Base for all types and resources Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) #xD; @classCode 0..1 cs Fixed Value: PLC #xD; name 0..1 ST XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 ADHA CDA extension to represent the extent that the identifier applies to the object XML Namespace: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0 #xD; xmlText 1..1 st Allows for mixed text content Binding: Health Care Geographic Area (required) #xD; Documentation for this format
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/StructureDefinition/elementdefinition-namespace
  value: uri
    v: urn:hl7-org:v3
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/xml-name
  value: string
    v: infrastructureRoot
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/type-profile-style
  value: code
    v: cda
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/logical-container
  value: uri
    v: http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm
  value: integer
    v: 1
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom
      value: canonical
        v: http://ns.electronichealth.net.au/cda/ImplementationGuide/au.digitalhealth.cda.schema
        link: http://ns.electronichealth.net.au/cda/ImplementationGuide/au.digitalhealth.cda.schema
url:
  v: http://ns.electronichealth.net.au/cda/StructureDefinition/assigningGeographicArea
version:
  v: 1.0.1
name:
  v: assigningGeographicArea
title:
  v: ADHA extension assigningGeographicArea used in asEntityIdentifier
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: Element assigningGeographicArea MAY be used and, if it is used, SHALL be the range and extent that the identifier applies to the object with which it is associated that is populated geographic area. This SHOULD NOT be used for machine readability purposes.
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://ns.electronichealth.net.au/cda/StructureDefinition/assigningGeographicArea
base definition:
  v: http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
  link: http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
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: assigningGeographicArea
    path:
      v: assigningGeographicArea
    short:
      v: Base for all types and resources
    definition:
      v: An Australian identifier that uniquely identifies a thing or object.
    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: assigningGeographicArea.nullFlavor
    path:
      v: assigningGeographicArea.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: assigningGeographicArea.realmCode
    path:
      v: assigningGeographicArea.realmCode
    definition:
      v: When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question
    min:
      v: 0
    max:
      v: *
    base:
      path:
        v: InfrastructureRoot.realmCode
      min:
        v: 0
      max:
        v: *
    type:
      code:
        v: http://hl7.org/cda/stds/core/StructureDefinition/CS
  element:
    id:
      v: assigningGeographicArea.typeId
    path:
      v: assigningGeographicArea.typeId
    definition:
      v: When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.
    min:
      v: 0

v: 1

path:
  v: InfrastructureRoot.typeId
min:
  v: 0
max:
  v: 1

key:
  v: II-1
severity:
  v: error
human:
  v: An II instance must have either a root or an nullFlavor.
expression:
  v: root.exists() or nullFlavor.exists()
source:
  v: http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot
  link: http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot

id:
  v: assigningGeographicArea.typeId.nullFlavor
path:
  v: assigningGeographicArea.typeId.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

id:
  v: assigningGeographicArea.typeId.assigningAuthorityName
path:
  v: assigningGeographicArea.typeId.assigningAuthorityName
representation:
  v: xmlAttr
label:
  v: Assigning Authority Name
definition:
  v: A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: II.assigningAuthorityName
  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: assigningGeographicArea.typeId.displayable
path:
  v: assigningGeographicArea.typeId.displayable
representation:
  v: xmlAttr
label:
  v: Displayable
definition:
  v: Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: II.displayable
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/bl-simple
    link: http://hl7.org/cda/stds/core/StructureDefinition/bl-simple

id:
  v: assigningGeographicArea.typeId.root
path:
  v: assigningGeographicArea.typeId.root
representation:
  v: xmlAttr
label:
  v: Root
definition:
  v: Identifies the type as an HL7 Registered model
min:
  v: 1
max:
  v: 1
base:
  path:
    v: II.root
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/oid
    link: http://hl7.org/cda/stds/core/StructureDefinition/oid
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/uuid
    link: http://hl7.org/cda/stds/core/StructureDefinition/uuid
  profile:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ruid
    link: http://hl7.org/cda/stds/core/StructureDefinition/ruid
fixed: string
  v: 2.16.840.1.113883.1.3

id:
  v: assigningGeographicArea.typeId.extension
path:
  v: assigningGeographicArea.typeId.extension
representation:
  v: xmlAttr
label:
  v: Extension
definition:
  v: A character string as a unique identifier within the scope of the identifier root.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: II.extension
  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: assigningGeographicArea.templateId
path:
  v: assigningGeographicArea.templateId
definition:
  v: When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question
min:
  v: 0
max:
  v: *
base:
  path:
    v: InfrastructureRoot.templateId
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/II

id:
  v: assigningGeographicArea.classCode
path:
  v: assigningGeographicArea.classCode
representation:
  v: xmlAttr
min:
  v: 0
max:
  v: 1
base:
  path:
    v: assigningGeographicArea.classCode
  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
fixed: code
  v: PLC

id:
  v: assigningGeographicArea.name
extension:
  url:
    v: http://hl7.org/fhir/tools/StructureDefinition/xml-namespace
  value: uri
    v: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
path:
  v: assigningGeographicArea.name
short:
  v: ADHA CDA extension to represent the extent that the identifier applies to the object
comment:
  v: Element ext:name MAY be used and, if it is used, SHALL be the range and extent that the identifier applies to the object with which it is associated that is populated directly from the geographic area. This SHOULD NOT be used for machine readability purposes.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: assigningGeographicArea.name
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: http://hl7.org/cda/stds/core/StructureDefinition/ST
constraint:
  key:
    v: text-null
  severity:
    v: error
  human:
    v: xmlText and nullFlavor are mutually exclusive (one must be present)
  expression:
    v: (xmlText | nullFlavor).count() = 1

id:
  v: assigningGeographicArea.name.nullFlavor
path:
  v: assigningGeographicArea.name.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

id:
  v: assigningGeographicArea.name.representation
path:
  v: assigningGeographicArea.name.representation
representation:
  v: xmlAttr
definition:
  v: Specifies the representation of the binary data that is the content of the binary data value
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ST.representation
  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
fixed: code
  v: TXT

id:
  v: assigningGeographicArea.name.mediaType
path:
  v: assigningGeographicArea.name.mediaType
representation:
  v: xmlAttr
label:
  v: Media Type
definition:
  v: Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ST.mediaType
  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
fixed: code
  v: text/plain

id:
  v: assigningGeographicArea.name.language
path:
  v: assigningGeographicArea.name.language
representation:
  v: xmlAttr
label:
  v: Language
definition:
  v: For character based information the language property specifies the human language of the text.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: ST.language
  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

id:
  v: assigningGeographicArea.name.xmlText
path:
  v: assigningGeographicArea.name.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: 1
max:
  v: 1
base:
  path:
    v: ST.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
binding:
  strength:
    v: required
  value set:
    v: http://ns.electronichealth.net.au/cda/ValueSet/dh-HealthCareGeographicArea
    link: http://ns.electronichealth.net.au/cda/ValueSet/dh-HealthCareGeographicArea

element:
  id:
    v: assigningGeographicArea
  path:
    v: assigningGeographicArea
  definition:
    v: An Australian identifier that uniquely identifies a thing or object.
  min:
    v: 1
  max:
    v: *
element:
  id:
    v: assigningGeographicArea.classCode
  path:
    v: assigningGeographicArea.classCode
  representation:
    v: xmlAttr
  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
  fixed: code
    v: PLC
element:
  id:
    v: assigningGeographicArea.name
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/xml-namespace
    value: uri
      v: http://ns.electronichealth.net.au/Ci/Cda/Extensions/3.0
  path:
    v: assigningGeographicArea.name
  short:
    v: ADHA CDA extension to represent the extent that the identifier applies to the object
  comment:
    v: Element ext:name MAY be used and, if it is used, SHALL be the range and extent that the identifier applies to the object with which it is associated that is populated directly from the geographic area. This SHOULD NOT be used for machine readability purposes.
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: http://hl7.org/cda/stds/core/StructureDefinition/ST
element:
  id:
    v: assigningGeographicArea.name.xmlText
  path:
    v: assigningGeographicArea.name.xmlText
  min:
    v: 1
  max:
    v: 1
  binding:
    strength:
      v: required
    value set:
      v: http://ns.electronichealth.net.au/cda/ValueSet/dh-HealthCareGeographicArea
      link: http://ns.electronichealth.net.au/cda/ValueSet/dh-HealthCareGeographicArea