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

Extension: Date of Arrival in Australia

Official URL: http://hl7.org.au/fhir/StructureDefinition/date-of-arrival Version: 4.2.2-ballot
Standards status: Trial-use Maturity Level: 1 Computable Name: DateOfArrivalAustralia

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

This extension applies to the Patient, RelatedPerson, and Practitioner resources and is used to represent a person’s date of arrival in an Australian context (see Australian Bureau of Statistics for further information). The date of arrival is when a person (born outside of Australia) first arrived in Australia, from another country, with the intention of living in Australia for one year or more. This date is recorded once for a person and is not subsequently updated with subsequent arrivals. This element is a part of Cultural and Linguistic Diversity (CALD) data set. It is an important indicator of cultural identity, and provides further information about a person’s cultural values and practices which can be significant in determining service type, support required, and possible needs.

This extension may be used on the following element(s):

  • Element ID Patient
  • Element ID RelatedPerson
  • Element ID Practitioner

Usage Notes

Usage:

Formal Views of Extension Content

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

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1 Extension The date a person first arrived in Australia, from another country, with the intention of living in Australia for one year or more
... url 1..1 uri "http://hl7.org.au/fhir/StructureDefinition/date-of-arrival"
... value[x] 1..1 date Date of first arrival in Australia
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... date-accuracy-indicator 0..1 (Complex) Date accuracy indicator
URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator
...... url 1..1 uri "date-accuracy-indicator"
...... value[x] 1..1 Coding Date accuracy coding

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1 Extension The date a person first arrived in Australia, from another country, with the intention of living in Australia for one year or more
... id 0..1 string Unique id for inter-element referencing
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... url 1..1 uri "http://hl7.org.au/fhir/StructureDefinition/date-of-arrival"
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... date-accuracy-indicator 0..1 (Complex) Date accuracy indicator
URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1 uri "date-accuracy-indicator"
...... value[x] 1..1 Coding Date accuracy coding
Binding: Date Accuracy Indicator . (required): Date accuracy coding

.... value 0..1 date Primitive value for date

doco Documentation for this format

This structure is derived from Extension

Summary

Simple Extension of type date: This extension applies to the Patient, RelatedPerson, and Practitioner resources and is used to represent a person's date of arrival in an Australian context (see Australian Bureau of Statistics for further information). The date of arrival is when a person (born outside of Australia) first arrived in Australia, from another country, with the intention of living in Australia for one year or more. This date is recorded once for a person and is not subsequently updated with subsequent arrivals. This element is a part of Cultural and Linguistic Diversity (CALD) data set. It is an important indicator of cultural identity, and provides further information about a person's cultural values and practices which can be significant in determining service type, support required, and possible needs.

Maturity: 1

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1 Extension The date a person first arrived in Australia, from another country, with the intention of living in Australia for one year or more
... url 1..1 uri "http://hl7.org.au/fhir/StructureDefinition/date-of-arrival"
... value[x] 1..1 date Date of first arrival in Australia
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... date-accuracy-indicator 0..1 (Complex) Date accuracy indicator
URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator
...... url 1..1 uri "date-accuracy-indicator"
...... value[x] 1..1 Coding Date accuracy coding

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1 Extension The date a person first arrived in Australia, from another country, with the intention of living in Australia for one year or more
... id 0..1 string Unique id for inter-element referencing
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... url 1..1 uri "http://hl7.org.au/fhir/StructureDefinition/date-of-arrival"
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... date-accuracy-indicator 0..1 (Complex) Date accuracy indicator
URL: http://hl7.org.au/fhir/StructureDefinition/date-accuracy-indicator
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... url 1..1 uri "date-accuracy-indicator"
...... value[x] 1..1 Coding Date accuracy coding
Binding: Date Accuracy Indicator . (required): Date accuracy coding

.... value 0..1 date Primitive value for date

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSetURI
Extension.value[x].extension:date-accuracy-indicator.value[x]requiredDateAccuracyIndicator . (a valid code from https://healthterminologies.gov.au/fhir/CodeSystem/date-accuracy-indicator-1)
https://healthterminologies.gov.au/fhir/ValueSet/date-accuracy-indicator-1

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