MedNet interface implementation guide
0.15.0 - CI Build

MedNet interface implementation guide - Local Development build (v0.15.0). See the Directory of published versions

Data Type Profile: MedNet Interface (MNI) - Address

Official URL: https://mednet.swiss/fhir/StructureDefinition/mni-address Version: 0.15.0
Active as of 2022-06-13 Computable Name: MNIAddress

Copyright/Legal: novcom AG

MedNet Interface (MNI) - Address Profile

Usage:

Formal Views of Profile Content

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

This structure is derived from CHCoreAddress

Summary

Must-Support: 7 elements

This structure is derived from CHCoreAddress

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..*CHCoreAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... use S0..1codehome | work | temp | old | billing - purpose of this address
... type S0..1codepostal | physical | both
... line S0..*stringStreet name, number, direction & P.O. Box etc.
... state S0..1stringSub-unit of country (abbreviations ok)
... postalCode S0..1stringPostal code for area
... country S0..1stringISO 3166 2 or 3 letter country code

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..*CHCoreAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... id 0..1stringUnique id for inter-element referencing
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... use ?!SΣ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
... line SΣ0..*stringStreet 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
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Ordered, Open by value:url, value:value
..... ch-ext-ech-10-linetype 0..1codeExtension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
Binding: eCH-010 Address Line Type (required): A set of codes advising a system or user which name in a set of names to select for a given purpose.


...... id 0..1stringUnique id for inter-element referencing
...... extension 0..0
...... url 1..1uri"http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
...... Slices for value[x] 0..1codeValue of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueCode 1..1codeValue of extension
Binding: eCH-010 Address Line Type (required): A set of codes advising a system or user which name in a set of names to select for a given purpose.


Fixed Value: addressLine1
..... ch-ext-ech-10-linetype 0..1codeExtension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
Binding: eCH-010 Address Line Type (required): A set of codes advising a system or user which name in a set of names to select for a given purpose.


...... id 0..1stringUnique id for inter-element referencing
...... extension 0..0
...... url 1..1uri"http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
...... Slices for value[x] 0..1codeValue of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueCode 1..1codeValue of extension
Binding: eCH-010 Address Line Type (required): A set of codes advising a system or user which name in a set of names to select for a given purpose.


Fixed Value: addressLine2
..... ch-ext-ech-10-linetype 0..1codeExtension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
Binding: eCH-010 Address Line Type (required): A set of codes advising a system or user which name in a set of names to select for a given purpose.


...... id 0..1stringUnique id for inter-element referencing
...... extension 0..0
...... url 1..1uri"http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
...... Slices for value[x] 0..1codeValue of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueCode 1..1codeValue of extension
Binding: eCH-010 Address Line Type (required): A set of codes advising a system or user which name in a set of names to select for a given purpose.


Fixed Value: street
..... iso21090-ADXP-houseNumber 0..1stringhouseNumber part of the street line
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
..... iso21090-ADXP-unitID 0..1stringunitID, dwellingNumber part of the street line
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID
..... ch-ext-ech-10-linetype 0..1codePostbox addresses need an postbox text and optional postbox number
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
Binding: eCH-010 Address Line Type (required): A set of codes advising a system or user which name in a set of names to select for a given purpose.


...... id 0..1stringUnique id for inter-element referencing
...... extension 0..0
...... url 1..1uri"http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
...... Slices for value[x] 0..1codeValue of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueCode 1..1codeValue of extension
Binding: eCH-010 Address Line Type (required): A set of codes advising a system or user which name in a set of names to select for a given purpose.


Fixed Value: postOfficeBoxText
..... iso21090-ADXP-postBox 0..1stringOptional postOfficeBoxNumber as a separate part of the postOfficeBoxText
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
.... value 0..1stringPrimitive value for string
Max Length: 1048576
... city SΣ0..1stringName of city, town etc.
Example General: Erewhon
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... ch-ext-ech-7-municipalityid 0..1stringExtension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-7-municipalityid
.... value 0..1stringPrimitive value for string
Max Length: 1048576
... district Σ0..1stringDistrict name (aka county)
Example General: Madison
... state SΣ0..1stringSub-unit of country (abbreviations ok)
... postalCode SΣ0..1stringPostal code for area
Example General: 9132
... country SΣ0..1stringISO 3166 2 or 3 letter country code
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... iso21090-SC-coding I0..1CodingISO Country Alpha-2 or ISO Country Alpha-3 code
URL: http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding
Binding: (unbound) (example): A coded representation for a string. Could be codes for country in a country address part, codes for prefixes in a name part, etc.


.... value 0..1stringPrimitive value for string
Max Length: 1048576
... 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 0..*CHCoreAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.

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

... line Σ0..*stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
... state Σ0..1stringSub-unit of country (abbreviations ok)
... postalCode Σ0..1stringPostal code for area
... country Σ0..1stringISO 3166 2 or 3 letter country code

doco Documentation for this format

This structure is derived from CHCoreAddress

Summary

Must-Support: 7 elements

Differential View

This structure is derived from CHCoreAddress

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..*CHCoreAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... use S0..1codehome | work | temp | old | billing - purpose of this address
... type S0..1codepostal | physical | both
... line S0..*stringStreet name, number, direction & P.O. Box etc.
... state S0..1stringSub-unit of country (abbreviations ok)
... postalCode S0..1stringPostal code for area
... country S0..1stringISO 3166 2 or 3 letter country code

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..*CHCoreAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... id 0..1stringUnique id for inter-element referencing
... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... use ?!SΣ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
... line SΣ0..*stringStreet 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
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Ordered, Open by value:url, value:value
..... ch-ext-ech-10-linetype 0..1codeExtension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
Binding: eCH-010 Address Line Type (required): A set of codes advising a system or user which name in a set of names to select for a given purpose.


...... id 0..1stringUnique id for inter-element referencing
...... extension 0..0
...... url 1..1uri"http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
...... Slices for value[x] 0..1codeValue of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueCode 1..1codeValue of extension
Binding: eCH-010 Address Line Type (required): A set of codes advising a system or user which name in a set of names to select for a given purpose.


Fixed Value: addressLine1
..... ch-ext-ech-10-linetype 0..1codeExtension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
Binding: eCH-010 Address Line Type (required): A set of codes advising a system or user which name in a set of names to select for a given purpose.


...... id 0..1stringUnique id for inter-element referencing
...... extension 0..0
...... url 1..1uri"http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
...... Slices for value[x] 0..1codeValue of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueCode 1..1codeValue of extension
Binding: eCH-010 Address Line Type (required): A set of codes advising a system or user which name in a set of names to select for a given purpose.


Fixed Value: addressLine2
..... ch-ext-ech-10-linetype 0..1codeExtension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
Binding: eCH-010 Address Line Type (required): A set of codes advising a system or user which name in a set of names to select for a given purpose.


...... id 0..1stringUnique id for inter-element referencing
...... extension 0..0
...... url 1..1uri"http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
...... Slices for value[x] 0..1codeValue of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueCode 1..1codeValue of extension
Binding: eCH-010 Address Line Type (required): A set of codes advising a system or user which name in a set of names to select for a given purpose.


Fixed Value: street
..... iso21090-ADXP-houseNumber 0..1stringhouseNumber part of the street line
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber
..... iso21090-ADXP-unitID 0..1stringunitID, dwellingNumber part of the street line
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-unitID
..... ch-ext-ech-10-linetype 0..1codePostbox addresses need an postbox text and optional postbox number
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype
Binding: eCH-010 Address Line Type (required): A set of codes advising a system or user which name in a set of names to select for a given purpose.


...... id 0..1stringUnique id for inter-element referencing
...... extension 0..0
...... url 1..1uri"http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-10-linetype"
...... Slices for value[x] 0..1codeValue of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueCode 1..1codeValue of extension
Binding: eCH-010 Address Line Type (required): A set of codes advising a system or user which name in a set of names to select for a given purpose.


Fixed Value: postOfficeBoxText
..... iso21090-ADXP-postBox 0..1stringOptional postOfficeBoxNumber as a separate part of the postOfficeBoxText
URL: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-postBox
.... value 0..1stringPrimitive value for string
Max Length: 1048576
... city SΣ0..1stringName of city, town etc.
Example General: Erewhon
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... ch-ext-ech-7-municipalityid 0..1stringExtension
URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-7-municipalityid
.... value 0..1stringPrimitive value for string
Max Length: 1048576
... district Σ0..1stringDistrict name (aka county)
Example General: Madison
... state SΣ0..1stringSub-unit of country (abbreviations ok)
... postalCode SΣ0..1stringPostal code for area
Example General: 9132
... country SΣ0..1stringISO 3166 2 or 3 letter country code
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... iso21090-SC-coding I0..1CodingISO Country Alpha-2 or ISO Country Alpha-3 code
URL: http://hl7.org/fhir/StructureDefinition/iso21090-SC-coding
Binding: (unbound) (example): A coded representation for a string. Could be codes for country in a country address part, codes for prefixes in a name part, etc.


.... value 0..1stringPrimitive value for string
Max Length: 1048576
... 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 / Code
Address.userequiredAddressUse
Address.typerequiredAddressType
Address.line.extension:addressLine1.value[x]:valueCoderequiredFixed Value: addressLine1
Address.line.extension:addressLine2.value[x]:valueCoderequiredFixed Value: addressLine2
Address.line.extension:street.value[x]:valueCoderequiredFixed Value: street
Address.line.extension:postOfficeBoxText.value[x]:valueCoderequiredFixed Value: postOfficeBoxText

Constraints

IdGradePathDetailsRequirements
ele-1errorAddressAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorAddress.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorAddress.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorAddress.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorAddress.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorAddress.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorAddress.lineAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorAddress.line.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorAddress.line.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorAddress.line.extension:addressLine1All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorAddress.line.extension:addressLine1Must have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorAddress.line.extension:addressLine1.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorAddress.line.extension:addressLine1.value[x]:valueCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorAddress.line.extension:addressLine2All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorAddress.line.extension:addressLine2Must have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorAddress.line.extension:addressLine2.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorAddress.line.extension:addressLine2.value[x]:valueCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorAddress.line.extension:streetAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorAddress.line.extension:streetMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorAddress.line.extension:street.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorAddress.line.extension:street.value[x]:valueCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorAddress.line.extension:houseNumberAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorAddress.line.extension:houseNumberMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorAddress.line.extension:unitIDAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorAddress.line.extension:unitIDMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorAddress.line.extension:postOfficeBoxTextAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorAddress.line.extension:postOfficeBoxTextMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorAddress.line.extension:postOfficeBoxText.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorAddress.line.extension:postOfficeBoxText.value[x]:valueCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorAddress.line.extension:postOfficeBoxNumberAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorAddress.line.extension:postOfficeBoxNumberMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorAddress.cityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorAddress.city.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorAddress.city.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorAddress.city.extension:bfsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorAddress.city.extension:bfsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorAddress.districtAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorAddress.stateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorAddress.postalCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorAddress.countryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorAddress.country.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorAddress.country.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorAddress.country.extension:countrycodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorAddress.country.extension:countrycodeMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ch-addr-1errorAddress.country.extension:countrycodeISO Country Alpha-2 or ISO Country Alpha-3 code
: ((valueCoding.code.length()=2) and valueCoding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2')) or ((valueCoding.code.length() = 3) and valueCoding.code.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))
ele-1errorAddress.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())