MediRecords FHIR Implementation Guide
20221128 - ci-build


Data Type Profile: MediRecords Australian Address DataType

Defining URL:https://fhir.medirecords.com/StructureDefinition/mr-address-aus
Version:20221128
Name:MRAusAddress
Title:MediRecords Australian Address DataType
Status:Active as of 2023-01-25 05:48:41+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

Formal Views of Profile Content

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

This structure is derived from AustralianAddress

Summary

Must-Support: 6 elements

Extensions

This structure refers to these extensions:

This structure is derived from AustralianAddress

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..*AustralianAddressAn address in Australia for use within an Australian healthcare context
... isPrimary S0..1booleanAddress Is Primary Extension
URL: https://fhir.medirecords.com/StructureDefinition/mr-address-isprimary-extn
... line S0..3stringStreet name, number, direction & P.O. Box etc.
Max Length: 50
... city S0..1stringName of city, town or suburb
Max Length: 60
... postalCode S0..1stringPostal code for area
Max Length: 10
... country S0..1stringAustralia as a 2 digit ISO 3166 code

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Address C0..*AustralianAddressAn address in Australia for use within an Australian healthcare context
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... identifier 0..*IdentifierIdentifier for the address
URL: http://hl7.org.au/fhir/StructureDefinition/address-identifier
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/address-identifier"
.... value[x] 1..1Identifier, DeliveryPointIdentifier, AUGNAFIdentifierAn identifier intended for computation
... isPrimary S0..1booleanAddress Is Primary Extension
URL: https://fhir.medirecords.com/StructureDefinition/mr-address-isprimary-extn
... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
... line SΣ0..3stringStreet 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..1stringName of city, town or suburb
Example General: Erewhon
Max Length: 60
... district Σ0..1stringDistrict name (aka county)
Example General: Madison
... state SΣ0..1stringAustralian state or territory
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 (required)
Max Length: 20
... postalCode SΣC0..1stringPostal code for area
Example General: 9132
Max Length: 10
... country SΣ0..1stringAustralia as a 2 digit ISO 3166 code
Fixed Value: AU
... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Address C0..*AustralianAddressAn address in Australia for use within an Australian healthcare context
... isPrimary 0..1booleanAddress Is Primary Extension
URL: https://fhir.medirecords.com/StructureDefinition/mr-address-isprimary-extn
... line Σ0..3stringStreet 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..1stringName of city, town or suburb
Max Length: 60
... postalCode ΣC0..1stringPostal code for area
Max Length: 10
... country Σ0..1stringAustralia as a 2 digit ISO 3166 code
Fixed Value: AU

doco Documentation for this format

This structure is derived from AustralianAddress

Summary

Must-Support: 6 elements

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from AustralianAddress

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..*AustralianAddressAn address in Australia for use within an Australian healthcare context
... isPrimary S0..1booleanAddress Is Primary Extension
URL: https://fhir.medirecords.com/StructureDefinition/mr-address-isprimary-extn
... line S0..3stringStreet name, number, direction & P.O. Box etc.
Max Length: 50
... city S0..1stringName of city, town or suburb
Max Length: 60
... postalCode S0..1stringPostal code for area
Max Length: 10
... country S0..1stringAustralia as a 2 digit ISO 3166 code

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address C0..*AustralianAddressAn address in Australia for use within an Australian healthcare context
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... identifier 0..*IdentifierIdentifier for the address
URL: http://hl7.org.au/fhir/StructureDefinition/address-identifier
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/address-identifier"
.... value[x] 1..1Identifier, DeliveryPointIdentifier, AUGNAFIdentifierAn identifier intended for computation
... isPrimary S0..1booleanAddress Is Primary Extension
URL: https://fhir.medirecords.com/StructureDefinition/mr-address-isprimary-extn
... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
... line SΣ0..3stringStreet 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..1stringName of city, town or suburb
Example General: Erewhon
Max Length: 60
... district Σ0..1stringDistrict name (aka county)
Example General: Madison
... state SΣ0..1stringAustralian state or territory
Binding: https://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2 (required)
Max Length: 20
... postalCode SΣC0..1stringPostal code for area
Example General: 9132
Max Length: 10
... country SΣ0..1stringAustralia as a 2 digit ISO 3166 code
Fixed Value: AU
... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Address.userequiredAddressUse
Address.typerequiredAddressType
Address.staterequiredhttps://healthterminologies.gov.au/fhir/ValueSet/australian-states-territories-2

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()
inv-add-3errorAddress.postalCodePostal code shall be 4 digits
: matches('^[0-9]{4}$')