AU Base Implementation Guide
5.1.0-preview - Preview

Publication Build: This will be filled in by the publication tooling

## Data Type Profile: AU DVA Number

Official URL: http://hl7.org.au/fhir/StructureDefinition/au-dvanumber | Version: 5.1.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:

- Use this DataType Constraint: AU Base Coverage, AU Base Patient and AU Base Related Person

Changes since version 5.0.0:

- No changes

### Formal Views of Profile Content

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

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Identifier |  | 0..* | Identifier | Department of Veterans' Affairs (DVA) Number ele-1: All FHIR elements must have a @value or children
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: DVA Entitlement (required) ele-1: All FHIR elements must have a @value or children
system | Σ | 1..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Fixed Value: http://ns.electronichealth.net.au/id/dva
value | Σ | 1..1 | string | DVA number ele-1: All FHIR elements must have a @value or children Example General: 123456 Example DVA number: NBUR9080 Max Length:9
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
Identifier.type | required | DVAEntitlement `http://terminology.hl7.org.au/ValueSet/dva-entitlement` from this IG

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Identifier |  | 0..* | Identifier | Department of Veterans' Affairs (DVA) Number
type |  | 1..1 | CodeableConcept | Description of identifier Binding: DVA Entitlement (required)
system |  | 1..1 | uri | The namespace for the identifier value Fixed Value: http://ns.electronichealth.net.au/id/dva
value |  | 1..1 | string | DVA number Example DVA number: NBUR9080 Max Length:9
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
Identifier.type | required | DVAEntitlement `http://terminology.hl7.org.au/ValueSet/dva-entitlement` from this IG

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Identifier |  | 0..* | Identifier | Department of Veterans' Affairs (DVA) Number
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 | Description of identifier Binding: DVA Entitlement (required)
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://ns.electronichealth.net.au/id/dva
value | Σ | 1..1 | string | DVA number Example General: 123456 Example DVA number: NBUR9080 Max Length:9
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

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
Identifier.type | required | DVAEntitlement `http://terminology.hl7.org.au/ValueSet/dva-entitlement` from this IG

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Identifier |  | 0..* | Identifier | Department of Veterans' Affairs (DVA) Number ele-1: All FHIR elements must have a @value or children
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
type | Σ | 1..1 | CodeableConcept | Description of identifier Binding: DVA Entitlement (required) ele-1: All FHIR elements must have a @value or children
system | Σ | 1..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Fixed Value: http://ns.electronichealth.net.au/id/dva
value | Σ | 1..1 | string | DVA number ele-1: All FHIR elements must have a @value or children Example General: 123456 Example DVA number: NBUR9080 Max Length:9
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
Identifier.type | required | DVAEntitlement `http://terminology.hl7.org.au/ValueSet/dva-entitlement` from this IG

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Identifier |  | 0..* | Identifier | Department of Veterans' Affairs (DVA) Number
type |  | 1..1 | CodeableConcept | Description of identifier Binding: DVA Entitlement (required)
system |  | 1..1 | uri | The namespace for the identifier value Fixed Value: http://ns.electronichealth.net.au/id/dva
value |  | 1..1 | string | DVA number Example DVA number: NBUR9080 Max Length:9
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet | URI
Identifier.type | required | DVAEntitlement `http://terminology.hl7.org.au/ValueSet/dva-entitlement` from this IG

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Identifier |  | 0..* | Identifier | Department of Veterans' Affairs (DVA) Number
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 | Description of identifier Binding: DVA Entitlement (required)
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://ns.electronichealth.net.au/id/dva
value | Σ | 1..1 | string | DVA number Example General: 123456 Example DVA number: NBUR9080 Max Length:9
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

#### Terminology Bindings

Path | Conformance | ValueSet | URI
Identifier.use | required | IdentifierUse `http://hl7.org/fhir/ValueSet/identifier-use|4.0.1` from the FHIR Standard
Identifier.type | required | DVAEntitlement `http://terminology.hl7.org.au/ValueSet/dva-entitlement` from this IG

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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