MediRecords FHIR Implementation Guide
1.4.1 - release


Data Type Profile: MR Address Foreign

Defining URL:https://fhir.medirecords.com/StructureDefinition/mr-address-foreign
Version:1.4.1
Name:MRForeignAddress
Title:MR Address Foreign
Status:Active as of 2025-02-03 04:29:41+0000
Definition:

MediRecords Foreign Address DataType profile

Source Resource:XML / JSON / Turtle

The official URL for this profile is: 

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

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:

This structure is derived from Address

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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 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 etc.
Max Length:60
... postalCode S 0..1 string Postal code for area
Max Length:10
... country S 1..1 string Use a 2 digit ISO 3166 code from the following binding.
Binding: Iso3166-1-2 (preferred)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..* Address An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... 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
... 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 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Σ 1..1 string Use a 2 digit ISO 3166 code from the following binding.
Binding: Iso3166-1-2 (preferred)
... period Σ 0..1 Period Time 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 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 Σ 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 etc.
Max Length:60
... postalCode Σ 0..1 string Postal code for area
Max Length:10
... country Σ 1..1 string Use a 2 digit ISO 3166 code from the following binding.
Binding: Iso3166-1-2 (preferred)

doco 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:

Differential View

This structure is derived from Address

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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 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 etc.
Max Length:60
... postalCode S 0..1 string Postal code for area
Max Length:10
... country S 1..1 string Use a 2 digit ISO 3166 code from the following binding.
Binding: Iso3166-1-2 (preferred)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..* Address An address expressed using postal conventions (as opposed to GPS or other location definition formats)
... 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
... 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 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Σ 1..1 string Use a 2 digit ISO 3166 code from the following binding.
Binding: Iso3166-1-2 (preferred)
... period Σ 0..1 Period Time 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

PathConformanceValueSetURI
Address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Address.countrypreferredIso3166-1-2
http://hl7.org/fhir/ValueSet/iso3166-1-2
from the FHIR Standard

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()