Australian Base Implementation Guide (AU Base 2)

AU Base Implementation Guide, published by HL7 Australia. This is not an authorized publication; it is the continuous build for version 2.1.0). This version is based on the current content of https://github.com/hl7au/au-fhir-base/ and changes regularly. See the Directory of published versions

1.0 StructureDefinition-au-dvanumber

AU DVA Number [FMM Level 0]

This identifier profile defines a Departement of Veterans’ Affairs (DVA) Number[1] [2] in an Australian healthcare context.

Examples

Patient with IHI and DVA Number

1.0.1 Formal Views of Profile Content

The official URL for this profile is:

http://hl7.org.au/fhir/StructureDefinition/au-dvanumber

This identifier profile defines a Departement of Veterans' Affairs (DVA) Number in an Australian healthcare context.

This profile builds on Identifier.

This profile was published on Tue Mar 10 00:00:00 UTC 2020 as a draft by Health Level Seven Australia (Patient Administration WG).

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier I0..*IdentifierDepartment of Veterans' Affairs (DVA) Number
inv-dva-number-unspecified: DVA number identifier type text must be 'DVA Number' when colour is not specified
inv-dva-number-gold: DVA number identifier type text must be 'DVA Number (Gold)' when colour coding is DVG.
inv-dva-number-white: DVA number identifier type text must be 'DVA Number (White)' when colour coding is DVW.
inv-dva-number-orange: DVA number identifier type text must be 'DVA Number (Orange)' when colour coding is DVO.
inv-dva-number-lilac: DVA number identifier type text must be 'DVA Number (Lilac)' when colour coding is DVL.
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 0..1CodeableConceptCoded identifier type for DVA number
Binding: V2 Identifier Type - AU Extended (required)
.... text 0..1stringPlain text representation of the concept
... system 1..1uriNamespace for DVA number
Fixed Value: http://ns.electronichealth.net.au/id/dva
... value 1..1stringDVA number
Example Department of Veterans' Affairs (DVA) number: NBUR9080
Max Length: 9

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier I0..*IdentifierDepartment of Veterans' Affairs (DVA) Number
inv-dva-number-unspecified: DVA number identifier type text must be 'DVA Number' when colour is not specified
inv-dva-number-gold: DVA number identifier type text must be 'DVA Number (Gold)' when colour coding is DVG.
inv-dva-number-white: DVA number identifier type text must be 'DVA Number (White)' when colour coding is DVW.
inv-dva-number-orange: DVA number identifier type text must be 'DVA Number (Orange)' when colour coding is DVO.
inv-dva-number-lilac: DVA number identifier type text must be 'DVA Number (Lilac)' when colour coding is DVL.
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)'
... id 0..1stringUnique id for inter-element referencing
... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
... type ΣI0..1CodeableConceptCoded identifier type for DVA number
Binding: V2 Identifier Type - AU Extended (required)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding ΣI0..*CodingCode defined by a terminology system
.... text ΣI0..1stringPlain text representation of the concept
... system ΣI1..1uriNamespace for DVA number
Fixed Value: http://ns.electronichealth.net.au/id/dva
... value ΣI1..1stringDVA number
Example General: 123456
Example Department of Veterans' Affairs (DVA) number: NBUR9080
Max Length: 9
... period ΣI0..1PeriodTime period when id is/was valid for use
... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)

doco Documentation for this format

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier I0..*IdentifierDepartment of Veterans' Affairs (DVA) Number
inv-dva-number-unspecified: DVA number identifier type text must be 'DVA Number' when colour is not specified
inv-dva-number-gold: DVA number identifier type text must be 'DVA Number (Gold)' when colour coding is DVG.
inv-dva-number-white: DVA number identifier type text must be 'DVA Number (White)' when colour coding is DVW.
inv-dva-number-orange: DVA number identifier type text must be 'DVA Number (Orange)' when colour coding is DVO.
inv-dva-number-lilac: DVA number identifier type text must be 'DVA Number (Lilac)' when colour coding is DVL.
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 0..1CodeableConceptCoded identifier type for DVA number
Binding: V2 Identifier Type - AU Extended (required)
.... text 0..1stringPlain text representation of the concept
... system 1..1uriNamespace for DVA number
Fixed Value: http://ns.electronichealth.net.au/id/dva
... value 1..1stringDVA number
Example Department of Veterans' Affairs (DVA) number: NBUR9080
Max Length: 9

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier I0..*IdentifierDepartment of Veterans' Affairs (DVA) Number
inv-dva-number-unspecified: DVA number identifier type text must be 'DVA Number' when colour is not specified
inv-dva-number-gold: DVA number identifier type text must be 'DVA Number (Gold)' when colour coding is DVG.
inv-dva-number-white: DVA number identifier type text must be 'DVA Number (White)' when colour coding is DVW.
inv-dva-number-orange: DVA number identifier type text must be 'DVA Number (Orange)' when colour coding is DVO.
inv-dva-number-lilac: DVA number identifier type text must be 'DVA Number (Lilac)' when colour coding is DVL.
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)'
... id 0..1stringUnique id for inter-element referencing
... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
... type ΣI0..1CodeableConceptCoded identifier type for DVA number
Binding: V2 Identifier Type - AU Extended (required)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding ΣI0..*CodingCode defined by a terminology system
.... text ΣI0..1stringPlain text representation of the concept
... system ΣI1..1uriNamespace for DVA number
Fixed Value: http://ns.electronichealth.net.au/id/dva
... value ΣI1..1stringDVA number
Example General: 123456
Example Department of Veterans' Affairs (DVA) number: NBUR9080
Max Length: 9
... period ΣI0..1PeriodTime period when id is/was valid for use
... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron

 

1.0.2 Quick Start

Below is an overview of the required search and read operations.

Summary of Search Criteria for StructureDefinition-au-dvanumber

none defined