AU Base on FHIR R4

Australian Base Implementation Guide

This page is part of AU Base v4.0.0 based on FHIR R4. For a full list of available versions, see the Directory of published versions

D.4.1.4 StructureDefinition: - Detailed Descriptions

Definitions for the StructureDefinition-date-of-arrival Profile.

1. Extension
Definition	The date a person first arrived in Australia, from another country, with the intention of living in Australia for one year or more. This date is captured once for a person and is not subsequently updated with subsequent arrivals.
Control	0..1 This element is affected by the following invariants: ele-1
Comments	See Australian Bureau of Statics (ABS) 1200.0.55.007 - Year of Arrival Standard, 2014, Version 1.5 and the Australian Institute of Health and Welfare (AIHW) Person—year of first arrival in Australia (ID 269447) for further materials.
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())
2. Extension.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. Extension.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 Extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
4. Extension.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Control	1..1
Type	uri
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Fixed Value	http://hl7.org.au/fhir/StructureDefinition/date-of-arrival
5. Extension.value[x]
Definition	Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Control	1..1
Type	date
[x] Note	See Choice of Data Types for further information about how to use [x]
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
6. Extension.value[x].id
Definition	unique id for the element within a resource (for internal references)
Control	0..1
Type	string
7. Extension.value[x].extension
Definition	An Extension
Control	0..*
Type	Extension
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 Extension.value[x].extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
8. Extension.value[x].extension:date-accuracy-indicator
SliceName	date-accuracy-indicator
Definition	General date accuracy indicator coding.
Control	0..1 This element is affected by the following invariants: ele-1
Type	Extension(DateAccuracyIndicator) (Extension Type: Coding)
Comments	In some circumstances, systems may capture date or dateTime data that has unknown or estimated parts. This coding indicates the accuracy of the day, month and year parts. See Australian Institute of Health and Welfare (AIHW) Date—accuracy indicator (ID 294418) for further information.
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())
9. Extension.value[x].extension:date-accuracy-indicator.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
10. Extension.value[x].extension:date-accuracy-indicator.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 Extension.value[x].extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
11. Extension.value[x].extension:date-accuracy-indicator.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Control	1..1
Type	uri
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Fixed Value	date-accuracy-indicator
12. Extension.value[x].extension:date-accuracy-indicator.value[x]
Definition	Coding of the accuracy of a date.
Control	1..1
Binding	The codes SHALL be taken from https://healthterminologies.gov.au/fhir/ValueSet/date-accuracy-indicator-1 Date accuracy coding
Type	Coding
[x] Note	See Choice of Data Types for further information about how to use [x]
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
13. Extension.value[x].value
Definition	The actual value
Control	0..1
Type	date