AU Base Implementation Guide
4.2.0-preview - Working Australia flag

This page is part of the Australian Base IG (v4.2.0-preview: QA Preview) 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 DVA Number

Official URL: http://hl7.org.au/fhir/StructureDefinition/au-dvanumber Version: 4.2.0-preview
Standards status: Trial-use Maturity Level: 2 Computable Name: AUDVANumber

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

This identifier profile defines a Department of Veterans’ Affairs (DVA) number) in an Australian context. This definition supports sending an individual’s state-based DVA file number as displayed on a Veteran Card, i.e. a Gold, White, or Orange Card. A Veteran Card may be issued by DVA to eligible individuals to allowing access to specific goods and services at a concessional rate.

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 0..*IdentifierDepartment of Veterans' Affairs (DVA) Number
... type 1..1CodeableConceptDescription of identifier
Binding: DVA Entitlement (required)
... system 1..1uriThe namespace for the identifier value
Fixed Value: http://ns.electronichealth.net.au/id/dva
... value 1..1stringDVA number
Example DVA number: NBUR9080
Max Length: 9

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Identifier.typerequiredDVAEntitlement
http://terminology.hl7.org.au/ValueSet/dva-entitlement
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier 0..*IdentifierDepartment of Veterans' Affairs (DVA) Number
... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

... type Σ1..1CodeableConceptDescription of identifier
Binding: DVA Entitlement (required)
... system Σ1..1uriThe namespace for the identifier value
Fixed Value: http://ns.electronichealth.net.au/id/dva

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Identifier.typerequiredDVAEntitlement
http://terminology.hl7.org.au/ValueSet/dva-entitlement
from this IG

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier 0..*IdentifierDepartment of Veterans' Affairs (DVA) Number
... id 0..1stringUnique id for inter-element referencing
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

... system Σ1..1uriThe namespace for the identifier value
Fixed Value: http://ns.electronichealth.net.au/id/dva
... value Σ1..1stringDVA number
Example General: 123456
Example DVA number: NBUR9080
Max Length: 9
... period Σ0..1PeriodTime period when id is/was valid for use
... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Identifier.typerequiredDVAEntitlement
http://terminology.hl7.org.au/ValueSet/dva-entitlement
from this IG

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()

This structure is derived from Identifier

Summary

Mandatory: 3 elements
Fixed Value: 1 element

Maturity: 2

Differential View

This structure is derived from Identifier

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier 0..*IdentifierDepartment of Veterans' Affairs (DVA) Number
... type 1..1CodeableConceptDescription of identifier
Binding: DVA Entitlement (required)
... system 1..1uriThe namespace for the identifier value
Fixed Value: http://ns.electronichealth.net.au/id/dva
... value 1..1stringDVA number
Example DVA number: NBUR9080
Max Length: 9

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Identifier.typerequiredDVAEntitlement
http://terminology.hl7.org.au/ValueSet/dva-entitlement
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier 0..*IdentifierDepartment of Veterans' Affairs (DVA) Number
... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

... type Σ1..1CodeableConceptDescription of identifier
Binding: DVA Entitlement (required)
... system Σ1..1uriThe namespace for the identifier value
Fixed Value: http://ns.electronichealth.net.au/id/dva

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Identifier.typerequiredDVAEntitlement
http://terminology.hl7.org.au/ValueSet/dva-entitlement
from this IG

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier 0..*IdentifierDepartment of Veterans' Affairs (DVA) Number
... id 0..1stringUnique id for inter-element referencing
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

... system Σ1..1uriThe namespace for the identifier value
Fixed Value: http://ns.electronichealth.net.au/id/dva
... value Σ1..1stringDVA number
Example General: 123456
Example DVA number: NBUR9080
Max Length: 9
... period Σ0..1PeriodTime period when id is/was valid for use
... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Identifier.typerequiredDVAEntitlement
http://terminology.hl7.org.au/ValueSet/dva-entitlement
from this IG

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()

This structure is derived from Identifier

Summary

Mandatory: 3 elements
Fixed Value: 1 element

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron