MediRecords FHIR Implementation Guide
1.4.1 - release
| Defining URL: | https://fhir.medirecords.com/StructureDefinition/mr-address-aus |
| Version: | 1.4.1 |
| Name: | MRAusAddress |
| Title: | MR Address AU |
| Status: | Active as of 2024-10-28 02:34:31+0000 |
| Definition: | MediRecords Australian Address DataType profile |
| Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
https://fhir.medirecords.com/StructureDefinition/mr-address-aus
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AustralianAddress
This structure is derived from AustralianAddress
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Address | 0..* | AustralianAddress | An address in Australia for use within an Australian healthcare context | |
  isPrimary | S | 0..1 | boolean | Address Is Primary Extension URL: https://fhir.medirecords.com/StructureDefinition/mr-address-isprimary-extn |
| line | S | 0..3 | string | Street name, number, direction & P.O. Box etc. Max Length: 50 |
| city | S | 0..1 | string | Name of city, town or suburb Max Length: 60 |
| state | S | 0..1 | string | Australian state or territory Max Length: 20 |
| postalCode | S | 0..1 | string | Postal code for area Max Length: 10 |
 country | S | 0..1 | string | Australia as a 2 digit ISO 3166 code |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Address | C | 0..* | AustralianAddress | An address in Australia for use within an Australian healthcare context inv-add-0: The address shall at least have text or a line inv-add-1: If asserting no fixed address, the type shall be 'physical' inv-add-2: If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS' |
 id | 0..1 | string | Unique id for inter-element referencing | |
 Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 identifier | 0..* | Identifier | Identifier for the address URL: http://hl7.org.au/fhir/StructureDefinition/address-identifier | |
  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/address-identifier" | |
  value[x] | 1..1 | Identifier, DeliveryPointIdentifier, AUGNAFIdentifier | An identifier intended for computation | |
| noFixedAddress | 0..1 | boolean | No fixed address indicator URL: http://hl7.org.au/fhir/StructureDefinition/no-fixed-address | |
| isPrimary | S | 0..1 | boolean | Address Is Primary Extension URL: https://fhir.medirecords.com/StructureDefinition/mr-address-isprimary-extn |
| use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
| type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both |
| text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 |
| line | SΣ | 0..3 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street Max Length: 50 |
| city | SΣ | 0..1 | string | Name of city, town or suburb Example General: Erewhon Max Length: 60 |
| district | Σ | 0..1 | string | District name (aka county) Example General: Madison |
| state | SΣ | 0..1 | string | Australian state or territory Binding: Australian States and Territories  (required)Max Length: 20 |
| postalCode | SΣC | 0..1 | string | Postal code for area inv-add-3: Postal code shall be 4 digits Example General: 9132 Max Length: 10 |
| country | SΣ | 0..1 | string | Australia as a 2 digit ISO 3166 code Fixed Value: AU |
| period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Address | 0..* | AustralianAddress | An address in Australia for use within an Australian healthcare context | |
| isPrimary | 0..1 | boolean | Address Is Primary Extension URL: https://fhir.medirecords.com/StructureDefinition/mr-address-isprimary-extn | |
| line | Σ | 0..3 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Max Length: 50 |
| city | Σ | 0..1 | string | Name of city, town or suburb Max Length: 60 |
| state | Σ | 0..1 | string | Australian state or territory Binding: Australian States and Territories (required)Max Length: 20 |
| postalCode | ΣC | 0..1 | string | Postal code for area inv-add-3: Postal code shall be 4 digits Max Length: 10 |
| country | Σ | 0..1 | string | Australia as a 2 digit ISO 3166 code Fixed Value: AU |
| Documentation for this format | ||||
This structure is derived from AustralianAddress
Differential View
This structure is derived from AustralianAddress
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Address | 0..* | AustralianAddress | An address in Australia for use within an Australian healthcare context | |
| isPrimary | S | 0..1 | boolean | Address Is Primary Extension URL: https://fhir.medirecords.com/StructureDefinition/mr-address-isprimary-extn |
| line | S | 0..3 | string | Street name, number, direction & P.O. Box etc. Max Length: 50 |
| city | S | 0..1 | string | Name of city, town or suburb Max Length: 60 |
| state | S | 0..1 | string | Australian state or territory Max Length: 20 |
| postalCode | S | 0..1 | string | Postal code for area Max Length: 10 |
| country | S | 0..1 | string | Australia as a 2 digit ISO 3166 code |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Address | C | 0..* | AustralianAddress | An address in Australia for use within an Australian healthcare context inv-add-0: The address shall at least have text or a line inv-add-1: If asserting no fixed address, the type shall be 'physical' inv-add-2: If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS' |
| id | 0..1 | string | Unique id for inter-element referencing | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| identifier | 0..* | Identifier | Identifier for the address URL: http://hl7.org.au/fhir/StructureDefinition/address-identifier | |
| 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/address-identifier" | |
| value[x] | 1..1 | Identifier, DeliveryPointIdentifier, AUGNAFIdentifier | An identifier intended for computation | |
| noFixedAddress | 0..1 | boolean | No fixed address indicator URL: http://hl7.org.au/fhir/StructureDefinition/no-fixed-address | |
| isPrimary | S | 0..1 | boolean | Address Is Primary Extension URL: https://fhir.medirecords.com/StructureDefinition/mr-address-isprimary-extn |
| use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
| type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both |
| text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 |
| line | SΣ | 0..3 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street Max Length: 50 |
| city | SΣ | 0..1 | string | Name of city, town or suburb Example General: Erewhon Max Length: 60 |
| district | Σ | 0..1 | string | District name (aka county) Example General: Madison |
| state | SΣ | 0..1 | string | Australian state or territory Binding: Australian States and Territories (required)Max Length: 20 |
| postalCode | SΣC | 0..1 | string | Postal code for area inv-add-3: Postal code shall be 4 digits Example General: 9132 Max Length: 10 |
| country | SΣ | 0..1 | string | Australia as a 2 digit ISO 3166 code Fixed Value: AU |
| period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} |
| Documentation for this format | ||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet | URI |
| Address.use | required | AddressUsehttp://hl7.org/fhir/ValueSet/address-use|4.0.1from the FHIR Standard | |
| Address.type | required | AddressTypehttp://hl7.org/fhir/ValueSet/address-type|4.0.1from the FHIR Standard | |
| Address.state | required | AustralianStatesAndTerritories https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| inv-add-0 | error | Address | The address shall at least have text or a line : text.exists() or line.exists() | |
| inv-add-1 | error | Address | If asserting no fixed address, the type shall be 'physical' : extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies type='physical' | |
| inv-add-2 | error | Address | If asserting no fixed address, the address text shall begin with 'NO FIXED ADDRESS' : extension('http://hl7.org.au/fhir/StructureDefinition/no-fixed-address').exists() implies text.startsWith('NO FIXED ADDRESS') | |
| inv-add-3 | error | Address.postalCode | Postal code shall be 4 digits : matches('^[0-9]{4}$') |