AU Base Implementation Guide
7.0.0-ci-build - CI Build Australia flag

AU Base Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 7.0.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. 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

Data Type Profile: AU G-NAF Identifier

Official URL: http://hl7.org.au/fhir/StructureDefinition/au-gnafidentifier Version: 7.0.0-ci-build
Standards status: Trial-use Maturity Level: 2 Computable Name: AUGNAFIdentifier

Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.

This identifier profile defines a Geocoded National Address File (G-NAF) identifier in an Australian context. The PSMA G-NAF is Australia’s authoritative, geocoded address file. A G-NAF identifier (sometimes referred to as G-NAF ID, or G-NAF PID, or GNAF ID, or address_detail_pid) identifies an address in the PSMA G-NAF.

Usage Notes

Usages:

You can also check for usages in the FHIR IG Statistics

Changes since version 6.0.0:

  • No changes

    • Formal Views of Profile Content

    Description of Profiles, Differentials, Snapshots and how the different presentations work.

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Identifier 0..* Identifier Geocoded National Address File (G-NAF) Identifier
    Identifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
    Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
    Identifier.type This element is included in summaries. 1..1 CodeableConcept Coded identifier type for G-NAF
    Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
    Required Pattern: 
    {
  "coding" : [
    {
      "system" : "http://terminology.hl7.org.au/CodeSystem/v2-0203",
      "code" : "GNAF"
    }
  ]
}
    Identifier.system This element is included in summaries. 1..1 uri The namespace for the identifier value
    Fixed Value: http://hl7.org.au/id/gnafidentifier (no extensions allowed)
    Identifier.value This element is included in summaries. 1..1 string G-NAF identifier
    Example General: 123456
    Example G-NAF identifier: GAVIC411711441
    Max Length:15

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
    Identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression
    ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())

    This structure is derived from Identifier

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Identifier 0..* Identifier Geocoded National Address File (G-NAF) Identifier
    Identifier.type 1..1 CodeableConcept Coded identifier type for G-NAF
    Required Pattern: 
    {
  "coding" : [
    {
      "system" : "http://terminology.hl7.org.au/CodeSystem/v2-0203",
      "code" : "GNAF"
    }
  ]
}
    Identifier.system 1..1 uri The namespace for the identifier value
    Fixed Value: http://hl7.org.au/id/gnafidentifier (no extensions allowed)
    Identifier.value 1..1 string G-NAF identifier
    Example G-NAF identifier: GAVIC411711441
    Max Length:15

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Identifier 0..* Identifier Geocoded National Address File (G-NAF) Identifier
    Identifier.id 0..1 string Unique id for inter-element referencing
    Identifier.extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    Identifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
    Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
    Identifier.type This element is included in summaries. 1..1 CodeableConcept Coded identifier type for G-NAF
    Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
    Required Pattern: 
    {
  "coding" : [
    {
      "system" : "http://terminology.hl7.org.au/CodeSystem/v2-0203",
      "code" : "GNAF"
    }
  ]
}
    Identifier.system This element is included in summaries. 1..1 uri The namespace for the identifier value
    Fixed Value: http://hl7.org.au/id/gnafidentifier (no extensions allowed)
    Identifier.value This element is included in summaries. 1..1 string G-NAF identifier
    Example General: 123456
    Example G-NAF identifier: GAVIC411711441
    Max Length:15
    Identifier.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
    Identifier.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
    Identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression
    ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
    ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

    This structure is derived from Identifier

    Summary

    Mandatory: 3 elements
    Fixed: 1 element

    Maturity: 2

    Key Elements View

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Identifier 0..* Identifier Geocoded National Address File (G-NAF) Identifier
    Identifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
    Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
    Identifier.type This element is included in summaries. 1..1 CodeableConcept Coded identifier type for G-NAF
    Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
    Required Pattern: 
    {
  "coding" : [
    {
      "system" : "http://terminology.hl7.org.au/CodeSystem/v2-0203",
      "code" : "GNAF"
    }
  ]
}
    Identifier.system This element is included in summaries. 1..1 uri The namespace for the identifier value
    Fixed Value: http://hl7.org.au/id/gnafidentifier (no extensions allowed)
    Identifier.value This element is included in summaries. 1..1 string G-NAF identifier
    Example General: 123456
    Example G-NAF identifier: GAVIC411711441
    Max Length:15

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
    Identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression
    ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())

    Differential View

    This structure is derived from Identifier

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Identifier 0..* Identifier Geocoded National Address File (G-NAF) Identifier
    Identifier.type 1..1 CodeableConcept Coded identifier type for G-NAF
    Required Pattern: 
    {
  "coding" : [
    {
      "system" : "http://terminology.hl7.org.au/CodeSystem/v2-0203",
      "code" : "GNAF"
    }
  ]
}
    Identifier.system 1..1 uri The namespace for the identifier value
    Fixed Value: http://hl7.org.au/id/gnafidentifier (no extensions allowed)
    Identifier.value 1..1 string G-NAF identifier
    Example G-NAF identifier: GAVIC411711441
    Max Length:15

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Identifier 0..* Identifier Geocoded National Address File (G-NAF) Identifier
    Identifier.id 0..1 string Unique id for inter-element referencing
    Identifier.extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    Identifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
    Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
    Identifier.type This element is included in summaries. 1..1 CodeableConcept Coded identifier type for G-NAF
    Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
    Required Pattern: 
    {
  "coding" : [
    {
      "system" : "http://terminology.hl7.org.au/CodeSystem/v2-0203",
      "code" : "GNAF"
    }
  ]
}
    Identifier.system This element is included in summaries. 1..1 uri The namespace for the identifier value
    Fixed Value: http://hl7.org.au/id/gnafidentifier (no extensions allowed)
    Identifier.value This element is included in summaries. 1..1 string G-NAF identifier
    Example General: 123456
    Example G-NAF identifier: GAVIC411711441
    Max Length:15
    Identifier.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
    Identifier.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
    Identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression
    ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
    ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

    This structure is derived from Identifier

    Summary

    Mandatory: 3 elements
    Fixed: 1 element

    Maturity: 2

     

    Other representations of profile: CSV, Excel, Schematron