This page is part of the Australian Base IG (v2.1.0: AU Base 2 on R4) based on FHIR R4. For a full list of available versions, see the Directory of published versions 

Definitions for the StructureDefinition-au-dvanumber Profile.
| 1. Identifier | |
| Definition | Department of Veterans' Affairs (DVA) number. |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) inv-dva-number-gold: DVA number identifier type text must be 'DVA Number (Gold)' when colour coding is DVG. (: type.coding.code='DVG' implies type.text = 'DVA Number (Gold)') inv-dva-number-lilac: DVA number identifier type text must be 'DVA Number (Lilac)' when colour coding is DVL. (: type.coding.code='DVL' implies type.text = 'DVA Number (Lilac)') inv-dva-number-orange: DVA number identifier type text must be 'DVA Number (Orange)' when colour coding is DVO. (: type.coding.code='DVO' implies type.text = 'DVA Number (Orange)') inv-dva-number-text: DVA number identifier type text must be one of 'DVA Number', 'DVA Number (Gold)', 'DVA Number (White), 'DVA Number (Orange), 'DVA Number (Lilac)' (: type.text = 'DVA Number' or type.text = 'DVA Number (Gold)' or type.text = 'DVA Number (White)' or type.text = 'DVA Number (Orange)' or type.text = 'DVA Number (Lilac)') inv-dva-number-unspecified: DVA number identifier type text must be 'DVA Number' when colour is not specified (: type.coding.empty() implies type.text = 'DVA Number') inv-dva-number-white: DVA number identifier type text must be 'DVA Number (White)' when colour coding is DVW. (: type.coding.code='DVW' implies type.text = 'DVA Number (White)') |
| 2. Identifier.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Control | 0..1 |
| Type | string |
| 3. Identifier.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Control | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 4. Identifier.use | |
| Definition | The purpose of this identifier. |
| Control | 0..1 |
| Binding | Identifies the purpose for this identifier, if known . The codes SHALL be taken from IdentifierUse |
| Type | code |
| Is Modifier | true |
| Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
| Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 5. Identifier.type | |
| Definition | Department of Veterans' Affairs (DVA) colour identifier type. |
| Control | 0..1 |
| Binding | Local Identifier Type The codes SHALL be taken from V2 Identifier Type - AU Extended |
| Type | CodeableConcept |
| Requirements | Allows users to make use of identifiers when the identifier system is not known. |
| Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 6. Identifier.type.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Control | 0..1 |
| Type | string |
| 7. Identifier.type.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Control | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Identifier.type.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 8. Identifier.type.coding | |
| Definition | A reference to a code defined by a terminology system. |
| Control | 0..* |
| Type | Coding |
| Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
| Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 9. Identifier.type.text | |
| Definition | Type of DVA card (specific colour may be provided) |
| Control | 0..1 |
| Type | string |
| Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
| Comments | Very often the text is the same as a displayName of one of the codings. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 10. Identifier.system | |
| Definition | DVA number assigned uri. |
| Control | 1..1 |
| Type | uri |
| Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
| Comments | Identifier.system is always case sensitive. |
| Fixed Value | http://ns.electronichealth.net.au/id/dva |
| Example | General:http://www.acme.com/identifiers/patient |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 11. Identifier.value | |
| Definition | Up to 9 digit value in the form AAXXNNNN[A]. |
| Control | 1..1 |
| Type | string |
| Comments | Reference: http://meteor.aihw.gov.au/content/index.phtml/itemId/339127 |
| Max Length | 9 |
| Example | General:123456 Department of Veterans' Affairs (DVA) number:NBUR9080 |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 12. Identifier.period | |
| Definition | Time period during which identifier is/was valid for use. |
| Control | 0..1 |
| Type | Period |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
| 13. Identifier.assigner | |
| Definition | Organization that issued/manages the identifier. |
| Control | 0..1 |
| Type | Reference(Organization) |
| Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. |
| Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |