MR.R4.CORE\MR Address

MediRecords FHIR Implementation Guide

1.4.2 - release

Data Type Profile: MR Address

Defining URL:

https://fhir.medirecords.com/StructureDefinition/mr-address

Version:

1.4.2

Name:

MRAddress

Title:

MR Address

Status:

Active as of 2025-04-04 01:10:23+0000

Definition:

MediRecords Address DataType profile

Source Resource:

XML / JSON / Turtle

The official URL for this profile is:

https://fhir.medirecords.com/StructureDefinition/mr-address

Formal Views of Profile Content

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

This structure is derived from Address

Summary

Mandatory: 1 element
Must-Support: 6 elements

Extensions

This structure refers to these extensions:

https://fhir.medirecords.com/StructureDefinition/mr-address-isprimary-extn

This structure is derived from Address

Name	Flags	Card.	Type	Description & Constraints
Address	C	0..*	Address	An address expressed using postal conventions (as opposed to GPS or other location definition formats) inv-au-postcode: Australia postal code shall be 4 digits
Slices for extension				Content/Rules for all slices
isPrimary	S	0..1	boolean	Address Is Primary Extension URL: https://fhir.medirecords.com/StructureDefinition/mr-address-isprimary-extn
line	S	1..2	string	Street name, number, direction & P.O. Box etc. Max Length:50
city	S	0..1	string	Name of city, town etc. Max Length:60
state	S	0..1	string	Sub-unit of country (abbreviations ok) Max Length:20
postalCode	S	0..1	string	Postal code for area Max Length:10
country	S	0..1	string	Use a 2 digit ISO 3166 country code Binding: Iso3166-1-2 (required)
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Address	C	0..*	Address	An address expressed using postal conventions (as opposed to GPS or other location definition formats) inv-au-postcode: Australia postal code shall be 4 digits
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
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Σ	1..2	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 etc. Example General: Erewhon Max Length:60
district	Σ	0..1	string	District name (aka county) Example General: Madison
state	SΣ	0..1	string	Sub-unit of country (abbreviations ok) Max Length:20
postalCode	SΣ	0..1	string	Postal code for area Example General: 9132 Max Length:10
country	SΣ	0..1	string	Use a 2 digit ISO 3166 country code Binding: Iso3166-1-2 (required)
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..*	Address	An address expressed using postal conventions (as opposed to GPS or other location definition formats)
Slices for extension				Content/Rules for all slices
isPrimary		0..1	boolean	Address Is Primary Extension URL: https://fhir.medirecords.com/StructureDefinition/mr-address-isprimary-extn
line	Σ	1..2	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 etc. Max Length:60
state	Σ	0..1	string	Sub-unit of country (abbreviations ok) Max Length:20
postalCode	Σ	0..1	string	Postal code for area Max Length:10
country	Σ	0..1	string	Use a 2 digit ISO 3166 country code Binding: Iso3166-1-2 (required)
Documentation for this format

This structure is derived from Address

Summary

Mandatory: 1 element
Must-Support: 6 elements

Extensions

This structure refers to these extensions:

https://fhir.medirecords.com/StructureDefinition/mr-address-isprimary-extn

Differential View

This structure is derived from Address

Name	Flags	Card.	Type	Description & Constraints
Address	C	0..*	Address	An address expressed using postal conventions (as opposed to GPS or other location definition formats) inv-au-postcode: Australia postal code shall be 4 digits
Slices for extension				Content/Rules for all slices
isPrimary	S	0..1	boolean	Address Is Primary Extension URL: https://fhir.medirecords.com/StructureDefinition/mr-address-isprimary-extn
line	S	1..2	string	Street name, number, direction & P.O. Box etc. Max Length:50
city	S	0..1	string	Name of city, town etc. Max Length:60
state	S	0..1	string	Sub-unit of country (abbreviations ok) Max Length:20
postalCode	S	0..1	string	Postal code for area Max Length:10
country	S	0..1	string	Use a 2 digit ISO 3166 country code Binding: Iso3166-1-2 (required)
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Address	C	0..*	Address	An address expressed using postal conventions (as opposed to GPS or other location definition formats) inv-au-postcode: Australia postal code shall be 4 digits
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
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Σ	1..2	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 etc. Example General: Erewhon Max Length:60
district	Σ	0..1	string	District name (aka county) Example General: Madison
state	SΣ	0..1	string	Sub-unit of country (abbreviations ok) Max Length:20
postalCode	SΣ	0..1	string	Postal code for area Example General: 9132 Max Length:10
country	SΣ	0..1	string	Use a 2 digit ISO 3166 country code Binding: Iso3166-1-2 (required)
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

Terminology Bindings

Path	Conformance	ValueSet	URI
Address.use	required	AddressUse `http://hl7.org/fhir/ValueSet/address-use\|4.0.1` from the FHIR Standard
Address.type	required	AddressType `http://hl7.org/fhir/ValueSet/address-type\|4.0.1` from the FHIR Standard
Address.country	required	Iso3166-1-2 `http://hl7.org/fhir/ValueSet/iso3166-1-2` from the FHIR Standard

Constraints

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-au-postcode	error	Address	Australia postal code shall be 4 digits : (country.exists() and country.matches('^AU$').not()) or postalCode.matches('^[0-9]{4}$')