AU Base Implementation Guide
4.1.0-ballot - CI Build
AU
AU Base Implementation Guide
4.1.0-ballot - CI Build
AU
This page is part of AU Base v4.1.0 based on FHIR R4. For a full list of available versions, see the Directory of published versions 
| Active as of 2022-11-10 | Maturity Level: 1 |
Definitions for the date-of-arrival extension.
| 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. Optional Extension Element - found in all resources. |
| Control | 0..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. |
| 2. Extension.url | |
| Fixed Value | http://hl7.org.au/fhir/StructureDefinition/date-of-arrival |
| 3. Extension.value[x] | |
| Control | 10..1 |
| Type | Choice of: , Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| 4. Extension.value[x].extension | |
| Control | 0..? |
| 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:
|
| 5. Extension.value[x].extension:date-accuracy-indicator | |
| SliceName | date-accuracy-indicator |
| Control | 0..1 |
| Type | Extension(DateAccuracyIndicator) (Extension Type: Coding) |
| 6. Extension.value[x].extension:date-accuracy-indicator.url | |
| Control | 0..? |
| Fixed Value | date-accuracy-indicator |
| 7. Extension.value[x].extension:date-accuracy-indicator.value[x] | |
| Control | 1..? |
| Type | Coding |
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| 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. Optional Extension Element - found in all resources. |
| 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.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Control | 1..1 |
| Type | uri |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 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 |
| 3. Extension.value[x] | |
| Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Control | 10..1 |
| Type | Choice of: date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time |
| [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())) |
| 4. Extension.value[x].extension | |
| Definition | An Extension 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. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
| 5. 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()) |
| 6. 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 |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 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 |
| 7. Extension.value[x].extension:date-accuracy-indicator.value[x] | |
| Definition | Coding of the accuracy of a date. Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
| Control | 10..1 |
| Binding | The codes SHALL be taken from https://healthterminologies.gov.au/fhir/ValueSet/date-accuracy-indicator-1For codes, see (unbound) Date accuracy codin |
| Type | Choice of: Coding, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time |
| [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())) |
| 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. |
| 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 |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 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 | extensionsuser 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:
|
| 4. Extension.url | |
| Definition | Source of the definition for the extension code - a logical name or a URL. |
| Control | 1..1 |
| Type | uri |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 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 |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 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:
|
| 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 |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 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 | extensionsuser 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:
|
| 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 |
| XML Representation | In the XML format, this property is represented as an attribute. |
| 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 codin |
| 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 |
| XML Representation | In the XML format, this property is represented as an attribute. |
IG © 2017+ HL7 Australia. Package hl7.fhir.au.base#4.1.0-ballot based on FHIR 4.0.1. Generated 2022-11-10
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change