AU Base Implementation Guide
4.1.0-ballot - CI Build
AU
This page is part of AU Base v4.1.0 based on FHIR R4. For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org.au/fhir/StructureDefinition/au-gnafidentifier | Version: 4.1.0-ballot | |||
Active as of 2022-11-10 | 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[1] in an Australian context.
The PSMA G-NAF[2] 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:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Identifier
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Identifier | 0..* | Identifier | Geocoded National Address File (G-NAF) Identifier | |
type | 1..1 | CodeableConcept | Coded identifier type for G-NAF Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: GNAF | |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org.au/id/gnafidentifier | |
value | 1..1 | string | G-NAF identifier Example G-NAF identifier: GAVIC411711441 Max Length: 15 | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Identifier | 0..* | Identifier | Geocoded National Address File (G-NAF) Identifier | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | Σ | 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: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: GNAF | |
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org.au/id/gnafidentifier |
value | Σ | 1..1 | string | G-NAF identifier Example General: 123456 Example G-NAF identifier: GAVIC411711441 Max Length: 15 |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Identifier.use | required | IdentifierUse |
Identifier.type | extensible | Pattern: GNAF |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Identifier | 0..* | Identifier | Geocoded National Address File (G-NAF) Identifier | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | Σ | 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: At least the following |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203 | |
version | 0..1 | string | Version of the system - if relevant | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: GNAF | |
display | 0..1 | string | Representation defined by the system | |
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
text | 0..1 | string | Plain text representation of the concept | |
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org.au/id/gnafidentifier |
value | Σ | 1..1 | string | G-NAF identifier Example General: 123456 Example G-NAF identifier: GAVIC411711441 Max Length: 15 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use |
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Identifier.use | required | IdentifierUse |
Identifier.type | extensible | Pattern: GNAF |
This structure is derived from Identifier
Differential View
This structure is derived from Identifier
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Identifier | 0..* | Identifier | Geocoded National Address File (G-NAF) Identifier | |
type | 1..1 | CodeableConcept | Coded identifier type for G-NAF Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: GNAF | |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org.au/id/gnafidentifier | |
value | 1..1 | string | G-NAF identifier Example G-NAF identifier: GAVIC411711441 Max Length: 15 | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Identifier | 0..* | Identifier | Geocoded National Address File (G-NAF) Identifier | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | Σ | 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: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: GNAF | |
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org.au/id/gnafidentifier |
value | Σ | 1..1 | string | G-NAF identifier Example General: 123456 Example G-NAF identifier: GAVIC411711441 Max Length: 15 |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Identifier.use | required | IdentifierUse |
Identifier.type | extensible | Pattern: GNAF |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Identifier | 0..* | Identifier | Geocoded National Address File (G-NAF) Identifier | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
type | Σ | 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: At least the following |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
id | 0..1 | id | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org.au/CodeSystem/v2-0203 | |
version | 0..1 | string | Version of the system - if relevant | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: GNAF | |
display | 0..1 | string | Representation defined by the system | |
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
text | 0..1 | string | Plain text representation of the concept | |
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org.au/id/gnafidentifier |
value | Σ | 1..1 | string | G-NAF identifier Example General: 123456 Example G-NAF identifier: GAVIC411711441 Max Length: 15 |
period | Σ | 0..1 | Period | Time period when id is/was valid for use |
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Identifier.use | required | IdentifierUse |
Identifier.type | extensible | Pattern: GNAF |
This structure is derived from Identifier
Other representations of profile: CSV, Excel, Schematron
not specified