Master Person Index R4

gd-Address-box

GdAddressBox profile

Contains information and metadata for addresses defined in Norwegian Master Person Index (FREG) and Norwegian Directorate of e-Health's health related Master Person Index.

The profile defines information structure of a Norwegian post box address (postboksadresse), as defined by FREG.

postadresse til en postboks

official0..1Extension(boolean)
url1..1Fixed Value
systemΣ0..1uri
versionΣ0..1string
codeS Σ0..1code
displayS Σ0..1string
userSelectedΣ0..1boolean
valueCodingCoding
propertyInformation0..*Extension(Complex)
fregMetadataS0..1Extension(Complex)
addressMetadataS0..1Extension(Complex)
postBoxOwnerS0..1Extension(Complex)
useΣ ?!0..1codeBinding
typeΣ0..1codeBinding
textΣ0..1string
postBoxS1..1Extension(string)
cityΣ0..1string
districtΣ0..1string
stateΣ0..1string
postalCodeΣ0..1string
countryΣ0..1string
periodΣ0..1Period
Address
DefinitionGrunndata adresse Contains information and metadata for addresses defined in Norwegian Master Person Index and Norwegian Directorate of e-Health's health related Master Person Index. An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.
Cardinality0...*
Comments

Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:XAD
  • rim:AD
  • servd:Address
Address.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Type
Mappings
  • rim:n/a
Address.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
Address.extension:official
DefinitionDefines the concept of an officially registered address in Norway. Usually this will be the adress registered in "Folkeregisteret" for persons or "Enhetsregisteret" for organizations.
Cardinality0...1
TypeExtension(boolean)
Aliasextensions, user content, offisiell adresse
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
Address.extension:urbanDistrict
DefinitionSimple extension containing information about what part of a norwegian city the patient is a resident. Administrative purpose. Five Norwegian cities have defined administrative districts called bydel. This is Oslo, Bergen, Trondheim, Stavanger og Drammen. There are still some uncertainty on what is the official source of bydel information. TBD
Cardinality0...1
TypeExtension(Coding)
Must SupportTrue
Aliasextensions, user content, bydel, urban district
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
Address.extension:urbanDistrict.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Type
Mappings
  • rim:n/a
Address.extension:urbanDistrict.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
Address.extension:urbanDistrict.url
DefinitionSource of the definition for the extension code - a logical name or a URL.
Cardinality1...1
Type
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Value
http://hl7.no/fhir/StructureDefinition/no-basis-urban-district
Mappings
  • rim:N/A
Address.extension:urbanDistrict.value[x]
DefinitionThe name and number of the bydel (part of the city). If coded this information should be coded according to CodeSystem urn:oid:2.16.578.1.12.4.1.1.3403
Cardinality0...1
TypeCoding
Bindingurn:oid:2.16.578.1.12.4.1.1.3403 (required)
AliasBydel, Urban district
Comments

A stream of bytes, base64 encoded

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim:n/a
  • rim:N/A
Address.extension:urbanDistrict.value[x].id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Type
Mappings
  • rim:n/a
Address.extension:urbanDistrict.value[x].extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
Address.extension:urbanDistrict.value[x].system
DefinitionThe identification of the code system that defines the meaning of the symbol in the code.
Cardinality0...1
Typeuri
SummaryTrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:C*E.3
  • rim:./codeSystem
  • orim:fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
Address.extension:urbanDistrict.value[x].version
DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Cardinality0...1
Typestring
SummaryTrue
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:C*E.7
  • rim:./codeSystemVersion
  • orim:fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
Address.extension:urbanDistrict.value[x].code
DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Cardinality0...1
Typecode
Must SupportTrue
SummaryTrue
Aliasbydelsnummer
Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:C*E.1
  • rim:./code
  • orim:fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
Address.extension:urbanDistrict.value[x].display
DefinitionThe name of the urban district
Cardinality0...1
Typestring
Must SupportTrue
SummaryTrue
Aliasbydelsnavn
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:C*E.2 - but note this is not well followed
  • rim:CV.displayName
  • orim:fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
Address.extension:urbanDistrict.value[x].userSelected
DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Cardinality0...1
Typeboolean
SummaryTrue
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:Sometimes implied by being first
  • rim:CD.codingRationale
  • orim:fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
Address.extension:propertyInformation
DefinitionIdentification of a real property in Norway is defined using gårdsnummer, bruksnummer and kommunenummer. In addition real property can be rented out, the area of the real property that is rented is measured and is further identified by its festenummer. In addition some real property is split into sections identified by its seksjonsnummer
Cardinality0...*
TypeExtension(Complex)
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
Address.extension:fregMetadata
Definitionfregmetadata (registermetadata) describes metadata about resources available from the norwegian person index (folkeregisteret, freg), all resources containing metadata from folkeregisteret will include registermetadata
Cardinality0...1
TypeExtension(Complex)
Must SupportTrue
Aliasextensions, user content, registermetadata, RegistermetadataMedGyldighet
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
Address.extension:addressMetadata
DefinitionDescribes address specific metadata about the address resources available from the the central person index (folkeregisteret, FREG), all address resources containing metadata from folkeregisteret will include gd-address-metadata
Cardinality0...1
TypeExtension(Complex)
Must SupportTrue
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
Address.extension:postBoxOwner
Definitionpostbokseier fra FREG, den som leier postboksen fra eier av postboksanlegget
Cardinality0...1
TypeExtension(Complex)
Must SupportTrue
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
Address.use
DefinitionGrunndata don't use this element The purpose of this address. Mapping of values to other Norwegian CodeSystems is documented in the implementation guide. In general the address used for visiting the person should have use "home" and type "physical" or "both". The "official" flag can be either true or false.
Cardinality0...1
Typecode
BindingAddressUse (required)
ModifierTrue
SummaryTrue
Requirements

Allows an appropriate address to be chosen from a list of many.

Comments

Applications can assume that an address is current unless it explicitly says that it is temporary or old.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General
home

Mappings
  • rim:n/a
  • v2:XAD.7
  • rim:unique(./use)
  • servd:./AddressPurpose
Address.type
DefinitionGrunndata don't use this element Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. Mapping of values to other Norwegian CodeSystems is documented in the implementation guide. In general the address used for visiting the person should have use "home" and type "physical" or "both". The "official" flag can be either true or false.
Cardinality0...1
Typecode
BindingAddressType (required)
SummaryTrue
Comments

The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General
both

Mappings
  • rim:n/a
  • v2:XAD.18
  • rim:unique(./use)
  • vcard:address type parameter
Address.text
DefinitionSpecifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.
Cardinality0...1
Typestring
SummaryTrue
Requirements

A renderable, unencoded form.

Comments

Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General
137 Nowhere Street, Erewhon 9132

Mappings
  • rim:n/a
  • v2:XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6
  • rim:./formatted
  • vcard:address label parameter
Address.line
DefinitionThis component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.
Cardinality1...*
Typestring
Must SupportTrue
SummaryTrue
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General
137 Nowhere Street

Mappings
  • rim:n/a
  • v2:XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)
  • rim:AD.part[parttype = AL]
  • vcard:street
  • servd:./StreetAddress (newline delimitted)
Address.line.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Type
Mappings
  • rim:n/a
Address.line.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
Address.line.extension:postBox
Definitionpostboks fra FREG, identifikator på postboks som består av landets betegnelse for postboks samt den alfanumeriske identifikatoren til denne
Cardinality1...1
TypeExtension(string)
Must SupportTrue
Aliasextensions, user content, postboks
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
  • rim:ADXP[partType=POB]
Address.line.value
DefinitionPrimitive value for string
Cardinality0...1
Type
Address.city
Definitiongd-Address: All Norwegian addresses are from Master Person Index uses this element for "poststed" or "postedsnavn". International addresses uses this element to communicate the name of the city. The name of the poststed or city. When a postalcode is given the name of the city must be according to the official list of postalcodes used in Norway. The name of the city, town, village or other community or delivery center.
Cardinality0...1
Typestring
SummaryTrue
AliasMunicpality, by, poststed, poststedsnavn
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General
Erewhon

Mappings
  • rim:n/a
  • v2:XAD.3
  • rim:AD.part[parttype = CTY]
  • vcard:locality
  • servd:./Jurisdiction
Address.district
Definitiongd-Address: Norwegian addresses uses district for the norwegian "kommune", international addresses uses district for any other applicable district in that country. Name of the county (norwegian "kommune"). If kommune number is required "eiendomsinformasjon" should be used. The name of the administrative area (county).
Cardinality0...1
Typestring
SummaryTrue
AliasCounty, kommune
Comments

District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General
Madison

Mappings
  • rim:n/a
  • v2:XAD.9
  • rim:AD.part[parttype = CNT | CPA]
Address.state
DefinitionName of the norwegian "fylke"). If fylkes-number is required "eiendomsinformasjon" should be used with koded kommune-number. Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (i.e. US 2 letter state codes).
Cardinality0...1
Typestring
SummaryTrue
AliasProvince, Territory, fylke
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:XAD.4
  • rim:AD.part[parttype = STA]
  • vcard:region
  • servd:./Region
Address.postalCode
DefinitionA postal code designating a region defined by the postal service. In Norway this is af four digit number defined by the norwegian postal service.
Cardinality0...1
Typestring
SummaryTrue
AliasZip, postnummer
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General
9132

Mappings
  • rim:n/a
  • v2:XAD.5
  • rim:AD.part[parttype = ZIP]
  • vcard:code
  • servd:./PostalIdentificationCode
Address.country
DefinitionCountry - a nation as commonly understood or generally accepted.
Cardinality0...1
Typestring
SummaryTrue
Comments

ISO 3166 3 letter codes can be used in place of a human readable country name.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:XAD.6
  • rim:AD.part[parttype = CNT]
  • vcard:country
  • servd:./Country
Address.period
DefinitionTime period when address was/is in use.
Cardinality0...1
TypePeriod
SummaryTrue
Requirements

Allows addresses to be placed in historical context.

Comments

A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times").

Period is not used for a duration (a measure of elapsed time). See Duration.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • per-1:If present, start SHALL have a lower value than end
    start.hasValue().not() or end.hasValue().not() or (start <= end)
Examples
General
{
  "start": "2010-03-23",
  "end": "2010-07-01"
}

Mappings
  • rim:n/a
  • v2:DR
  • rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
  • v2:XAD.12 / XAD.13 + XAD.14
  • rim:./usablePeriod[type="IVL<TS>"]
  • servd:./StartDate and ./EndDate