AU Base Implementation Guide
4.2.2-ballot - Ballot Australia flag

This page is part of the Australian Base IG (v4.2.2-ballot: AU Base R4.2 Ballot 5) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 4.1.0. For a full list of available versions, see the Directory of published versions

Data Type Profile: AU Delivery Point Identifier

Official URL: http://hl7.org.au/fhir/StructureDefinition/au-deliverypointidentifier Version: 4.2.2-ballot
Standards status: Trial-use Maturity Level: 2 Computable Name: AUDeliveryPointIdentifier

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

This identifier profile defines an Australia Post Delivery Point Identifier (DPID) in an Australian context (see Australia Post for further information). A DPID is a randomly generated, unique 8-digit number, allocated by Australia Post to an address. A DPID enables each delivery point in Australia to be uniquely identified.

Usage Notes

Usage:

Formal Views of Profile Content

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

This structure is derived from Identifier

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier C 0..* Identifier Australia Post Delivery Point Identifier (DPID)
inv-dpid-0: DPID shall be 8 digits
... type 1..1 CodeableConcept Coded identifier type for DPID
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: DPID
... system 1..1 uri The namespace for the identifier value
Fixed Value: http://hl7.org.au/id/dpid
... value C 1..1 string DPID
Example DPID: 34567890

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
inv-dpid-0errorIdentifierDPID shall be 8 digits
: value.matches('^([0-9]{8})$')
NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier C 0..* Identifier Australia Post Delivery Point Identifier (DPID)
inv-dpid-0: DPID shall be 8 digits
... 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 DPID
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: DPID
... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: http://hl7.org.au/id/dpid

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Identifier.typeextensiblePattern: DPID
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
inv-dpid-0errorIdentifierDPID shall be 8 digits
: value.matches('^([0-9]{8})$')
NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier C 0..* Identifier Australia Post Delivery Point Identifier (DPID)
inv-dpid-0: DPID shall be 8 digits
... 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 .

.... id 0..1 string 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 string 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: DPID
..... 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/dpid
... value ΣC 1..1 string DPID
Example General: 123456
Example DPID: 34567890
... 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)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Identifier.typeextensiblePattern: DPID
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-dpid-0errorIdentifierDPID shall be 8 digits
: value.matches('^([0-9]{8})$')

This structure is derived from Identifier

Summary

Mandatory: 3 elements
Fixed: 1 element

Maturity: 2

Differential View

This structure is derived from Identifier

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier C 0..* Identifier Australia Post Delivery Point Identifier (DPID)
inv-dpid-0: DPID shall be 8 digits
... type 1..1 CodeableConcept Coded identifier type for DPID
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: DPID
... system 1..1 uri The namespace for the identifier value
Fixed Value: http://hl7.org.au/id/dpid
... value C 1..1 string DPID
Example DPID: 34567890

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
inv-dpid-0errorIdentifierDPID shall be 8 digits
: value.matches('^([0-9]{8})$')

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier C 0..* Identifier Australia Post Delivery Point Identifier (DPID)
inv-dpid-0: DPID shall be 8 digits
... 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 DPID
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: DPID
... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: http://hl7.org.au/id/dpid

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Identifier.typeextensiblePattern: DPID
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
inv-dpid-0errorIdentifierDPID shall be 8 digits
: value.matches('^([0-9]{8})$')

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier C 0..* Identifier Australia Post Delivery Point Identifier (DPID)
inv-dpid-0: DPID shall be 8 digits
... 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 .

.... id 0..1 string 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 string 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: DPID
..... 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/dpid
... value ΣC 1..1 string DPID
Example General: 123456
Example DPID: 34567890
... 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)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Identifier.typeextensiblePattern: DPID
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-dpid-0errorIdentifierDPID shall be 8 digits
: value.matches('^([0-9]{8})$')

This structure is derived from Identifier

Summary

Mandatory: 3 elements
Fixed: 1 element

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron