Readers Guide and use of RESTful FHIR API

The implementation guide uses the mechanisms described in the Profiling chapter of the HL7 FHIR specification to describe the interface from the Person information Service:

https://www.hl7.org/fhir/profiling.html#5.1.0

The implementation guide will have three main parts.

Top level description of the use-cases supported (Use-case)
Top level description of the server requirements for the Person Information Service (Service Interface)
Detailed description of the HL7 FHIR based information model (Person Information)

In addition to the main parts there is also a chapter describing all extensions that are part of the package and a Readers guide (this chapter).

Common conformance definitions

HL7 FHIR Conformance language

This specification uses the conformance verbs SHALL, SHOULD, and MAY as defined in RFC 2119. Unlike RFC 2119, however, this specification allows that different applications might not be able to interoperate because of how they use optional features. In particular:

SHALL: an absolute requirement for all implementations

SHALL NOT: an absolute prohibition against inclusion for all implementations

SHOULD/SHOULD NOT: A best practice or recommendation to be considered by implementers within the context of their particular implementation; there may be valid reasons to ignore an item, but the full implications must be understood and carefully weighed before choosing a different course

MAY: This is truly optional language for an implementation; can be included or omitted as the implementer decides with no implications

Must support

Any FHIR element can have a flag set called must support. The must support flag can have three flavors, true, false and the flag can be missing (not set). must support elements is marked by a red S in the documentation on each resource. Like the propertyInformation, cadastralAddress and separatelyOccupiedUnit in the GdAddressCadastral below:

Address			Address	Element Id Address Short description Grunndata adresse fra FREG Alternate names matrikkeladresse Definition Grunndata 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. 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). Data Type Address Constraints 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 freg:matrikkeladresse
extension		0..*	Extension	Element Id Address.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May 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. 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. Data Type Extension Sliced: Unordered, Open, by url(Value) Constraints 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
official		0..1	Extension(boolean)	There are no (further) constraints on this element Element Id Address.extension:official Short description The concept of an officially registered address Alternate names extensions, user content, offisiell adresse Definition Defines the concept of an officially registered address in Norway. Usually this will be the adress registered in "Folkeregisteret" for persons or "Enhetsregisteret" for organizations. 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. Data Type Extension(boolean) Extension URL http://hl7.no/fhir/StructureDefinition/no-basis-address-official Constraints 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
urbanDistrict	S	0..1	Extension(Coding)	There are no (further) constraints on this element Element Id Address.extension:urbanDistrict Short description Urban district of this address Alternate names extensions, user content, bydel, urban district Definition Simple 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 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. Data Type Extension(Coding) Extension URL http://hl7.no/fhir/StructureDefinition/no-basis-urban-district Constraints 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 freg:n/a
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Address.extension:urbanDistrict.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. 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. Data Type System.String Fixed Value http://hl7.no/fhir/StructureDefinition/no-basis-urban-district Mappings rim:N/A
value[x]	S	0..1	Binding	There are no (further) constraints on this element Element Id Address.extension:urbanDistrict.value[x] Short description Urban District information Alternate names Bydel, Urban district Definition The 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 Comments A stream of bytes, base64 encoded Binding urn:oid:2.16.578.1.12.4.1.1.3403 (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
valueCoding			Coding	There are no (further) constraints on this element Data Type Coding
system	Σ	0..1	uri	There are no (further) constraints on this element Element Id Address.extension:urbanDistrict.value[x].system Short description Identity of the terminology system Definition The identification of the code system that defines the meaning of the symbol in the code. 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. Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE.3 rim:./codeSystem orim:*fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
version	Σ	0..1	string	There are no (further) constraints on this element Element Id Address.extension:urbanDistrict.value[x].version Short description Version of the system - if relevant Definition The 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. 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. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE.7 rim:./codeSystemVersion orim:*fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
code	S Σ	0..1	code	There are no (further) constraints on this element Element Id Address.extension:urbanDistrict.value[x].code Short description bydelsnummer Alternate names bydelsnummer Definition A 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). Requirements Need to refer to a particular code in the system. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE.1 rim:./code orim:*fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
display	S Σ	0..1	string	There are no (further) constraints on this element Element Id Address.extension:urbanDistrict.value[x].display Short description The name of the urban district Alternate names bydelsnavn Definition The name of the urban district 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 Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE.2 - but note this is not well followed rim:CV.displayName orim:*fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
userSelected	Σ	0..1	boolean	There are no (further) constraints on this element Element Id Address.extension:urbanDistrict.value[x].userSelected Short description If this coding was chosen directly by the user Definition Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). 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. Data Type boolean Constraints 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 ]
propertyInformation	S	0..*	Extension(Complex)	Element Id Address.extension:propertyInformation Short description matrikkelnummer fra FREG Alternate names extensions, user content, matrikkelnummer Definition gd-Address-cadastral uses property information to contain the cadastralnumber from FREG. The cadastral number describing a cadastral address NEVER contains a condoniumUnitNumber. FREG exposes a subNumber to describe different units on the same cadastral number. Identification 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 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. Data Type Extension(Complex) Extension URL http://hl7.no/fhir/StructureDefinition/no-basis-propertyinformation Constraints 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 freg:matrikkelnummer
extension		0..*	Extension	Element Id Address.extension:propertyInformation.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May 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. 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. Data Type Extension Sliced: Unordered, Open, by url(Value) Constraints 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
cadastralUnitNumber		0..1	Extension	Element Id Address.extension:propertyInformation.extension:cadastralUnitNumber Short description cadastral unit number Alternate names extensions, user content, cadastral unit number, gårdsnummer Definition Identification 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. Gårdsnummer is called Cadastral unit number in English. Comments Gårdsnummer Data Type Extension Constraints 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 freg:gaardsnummer
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Address.extension:propertyInformation.extension:cadastralUnitNumber.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. 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. Data Type System.String Fixed Value cadastralUnitNumber Mappings rim:N/A
value[x]		0..1		There are no (further) constraints on this element Element Id Address.extension:propertyInformation.extension:cadastralUnitNumber.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Comments A stream of bytes, base64 encoded Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
valueInteger			integer	There are no (further) constraints on this element Data Type integer
propertyUnitNumber		0..1	Extension	Element Id Address.extension:propertyInformation.extension:propertyUnitNumber Short description Property unit number Alternate names extensions, user content, Property unit number, bruksnummer Definition Identification 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. Bruksnummer is called Property unit number in English. Comments bruksnummer Data Type Extension Constraints 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 freg:bruksnummer
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Address.extension:propertyInformation.extension:propertyUnitNumber.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. 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. Data Type System.String Fixed Value propertyUnitNumber Mappings rim:N/A
value[x]		0..1		There are no (further) constraints on this element Element Id Address.extension:propertyInformation.extension:propertyUnitNumber.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Comments A stream of bytes, base64 encoded Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
valueInteger			integer	There are no (further) constraints on this element Data Type integer
leaseholdNumber		0..*	Extension	Element Id Address.extension:propertyInformation.extension:leaseholdNumber Short description Leasehold number Alternate names extensions, user content, Leasehold number, Festenummer Definition Identification 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. Festenummer is called Leasehold number in english. Comments Festenummer Data Type Extension Constraints 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 freg:festenummer
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Address.extension:propertyInformation.extension:leaseholdNumber.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. 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. Data Type System.String Fixed Value leaseholdNumber Mappings rim:N/A
value[x]		0..1		There are no (further) constraints on this element Element Id Address.extension:propertyInformation.extension:leaseholdNumber.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Comments A stream of bytes, base64 encoded Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
valueInteger			integer	There are no (further) constraints on this element Data Type integer
condominiumUnitNumber		0..*	Extension	There are no (further) constraints on this element Element Id Address.extension:propertyInformation.extension:condominiumUnitNumber Short description Condominium unit number Alternate names extensions, user content, Condominium unit number, seksjonsnummer Definition Identification of a real property in Norway is defined using gårdsnummer, bruksnummer and kommunenummer. In addition some real property is split into sections identified by its seksjonsnummer. Seksjonsnummer is called Condominium unit number in English. Comments Seksjonsnummer Data Type Extension Constraints 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
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Address.extension:propertyInformation.extension:condominiumUnitNumber.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. 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. Data Type System.String Fixed Value condominiumUnitNumber Mappings rim:N/A
value[x]		0..1		There are no (further) constraints on this element Element Id Address.extension:propertyInformation.extension:condominiumUnitNumber.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Comments A stream of bytes, base64 encoded Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
valueInteger			integer	There are no (further) constraints on this element Data Type integer
municipality		0..*	ExtensionBinding	Element Id Address.extension:propertyInformation.extension:municipality Short description Identification of the Municipality Alternate names extensions, user content, Kommune, kommunenummer Definition The norwegian kommune identifies an administrative geographic unit in Norway called kommune by a predefined number and its official name. 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. Data Type Extension Binding urn:oid:2.16.578.1.12.4.1.1.3402 (required) Constraints 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 freg:kommunenummer
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Address.extension:propertyInformation.extension:municipality.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. 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. Data Type System.String Fixed Value municipality Mappings rim:N/A
value[x]		0..1	Binding	There are no (further) constraints on this element Element Id Address.extension:propertyInformation.extension:municipality.value[x] Short description Kommunenummer according to CodeSystem Alternate names kommunenummer Definition The norwegian kommunenummer identifies an administrative geographic unit in Norway called kommune by a predefined number. The number should be coded according to CodeSystem Kommunenummer og regionale spesialkoder (OID=3402). Comments A stream of bytes, base64 encoded Binding urn:oid:2.16.578.1.12.4.1.1.3402 (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
valueCoding			Coding	There are no (further) constraints on this element Data Type Coding
url		1..1	uriFixed Value	There are no (further) constraints on this element Element Id Address.extension:propertyInformation.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. 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. Data Type uri Fixed Value http://hl7.no/fhir/StructureDefinition/no-basis-propertyinformation Mappings rim:N/A
value[x]		0..0		There are no (further) constraints on this element Element Id Address.extension:propertyInformation.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Comments A stream of bytes, base64 encoded Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
fregMetadata	S	0..1	Extension(Complex)	There are no (further) constraints on this element Element Id Address.extension:fregMetadata Short description registermetadata fra folkeregisteret Alternate names extensions, user content, Registermetadata Definition fregmetadata (registermetadata) describes metadata about resources available from the norwegian person index (folkeregisteret, freg), all resources containing metadata from folkeregisteret will include registermetadata 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. Data Type Extension(Complex) Extension URL http://ehelse.no/fhir/StructureDefinition/gd-fregmetadata Constraints 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 freg:Registermetadata
addressMetadata	S	0..1	Extension(Complex)	There are no (further) constraints on this element Element Id Address.extension:addressMetadata Short description Address specific metadata from FREG Alternate names extensions, user content Definition Describes 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 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. Data Type Extension(Complex) Extension URL http://ehelse.no/fhir/StructureDefinition/gd-address-metadata Constraints 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
extension		0..*	Extension	There are no (further) constraints on this element Element Id Address.extension:addressMetadata.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May 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. 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. Data Type Extension Sliced: Unordered, Open, by url(Value) Constraints 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
confidentiality		1..1	ExtensionBinding	There are no (further) constraints on this element Element Id Address.extension:addressMetadata.extension:confidentiality Short description adressegradering Alternate names extensions, user content, adressegradering Definition kategori av beskyttelsesgrad på adresseinformasjon i Folkeregisteret Gyldige kodeverdier er: ugradert klientadresse fortrolig Bostedsadressen kan være beskyttet iht. Beskyttelsesinstruksen (fortrolig og strengtFortrolig) eller Folkeregisterloven (klientadresse). Adresse med gradering strengtFortrolig oppgis ikke av Folkeregisteret og er derfor ikke blant kodene. 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. Data Type Extension Binding GdAddressConfidentialityValueSet (required) Constraints 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 freg:adressegradering
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Address.extension:addressMetadata.extension:confidentiality.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. 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. Data Type System.String Fixed Value confidentiality Mappings rim:N/A
value[x]		0..1		There are no (further) constraints on this element Element Id Address.extension:addressMetadata.extension:confidentiality.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Comments A stream of bytes, base64 encoded Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
valueCode			code	There are no (further) constraints on this element Data Type code
basicStatisticalUnit		0..1	Extension	There are no (further) constraints on this element Element Id Address.extension:addressMetadata.extension:basicStatisticalUnit Short description grunnkrets Alternate names extensions, user content, grunnkrets Definition en mindre geografisk enhet som består av et geografisk sammenhengende område som er mest mulig ensartet når det gjelder natur og næringsgrunnlag, kommunikasjonsforhold og bygningsmessig struktur Informasjonen er gitt ved en unik kode innenfor kommunen. 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. Data Type Extension Constraints 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 freg:grunnkrets
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Address.extension:addressMetadata.extension:basicStatisticalUnit.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. 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. Data Type System.String Fixed Value basicStatisticalUnit Mappings rim:N/A
value[x]		0..1		There are no (further) constraints on this element Element Id Address.extension:addressMetadata.extension:basicStatisticalUnit.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Comments A stream of bytes, base64 encoded Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
valueInteger			integer	There are no (further) constraints on this element Data Type integer
parishId		0..1	Extension	There are no (further) constraints on this element Element Id Address.extension:addressMetadata.extension:parishId Short description kirkekrets Alternate names extensions, user content, kirkekrets Definition minste kirkelige administrative inndeling Entydig nummer på kirkesokn. Soknene er grunnenhetene i kirken og disse er organisert i kirkelig fellesråd. Kirkekretsene kan strekke seg over flere kommuner. 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. Data Type Extension Constraints 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 freg:kirkekrets
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Address.extension:addressMetadata.extension:parishId.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. 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. Data Type System.String Fixed Value parishId Mappings rim:N/A
value[x]		0..1		There are no (further) constraints on this element Element Id Address.extension:addressMetadata.extension:parishId.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Comments A stream of bytes, base64 encoded Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
valueInteger			integer	There are no (further) constraints on this element Data Type integer
closeCadastralIdentifier		0..1	Extension	There are no (further) constraints on this element Element Id Address.extension:addressMetadata.extension:closeCadastralIdentifier Short description nærAdresseidentifikatorFraMatrikkelen Alternate names extensions, user content, naerAdresseIdentifikatorFraMatrikkelen Definition FREG lagrer en "reserve" adresseidentifikator i de tilfellene at FREG ikke finner en nøyaktig samstemmighet i matrikkelen slik at FREG likevel kan fange opp endringer i kommunenummer, adressenavn, gårds-/bruksnummer osv. Det kan f.eks. hende at det blir oppgitt en vegadresse uten husbokstav på et husnummer som bare finnes med husbokstaver i matrikkelen. Vi tar da identifikatoren til huset med f.eks. "A" som husbokstav. 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. Data Type Extension Constraints 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 freg:naerAdresseIdentifikatorFraMatrikkelen
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Address.extension:addressMetadata.extension:closeCadastralIdentifier.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. 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. Data Type System.String Fixed Value closeCadastralIdentifier Mappings rim:N/A
value[x]		0..1		There are no (further) constraints on this element Element Id Address.extension:addressMetadata.extension:closeCadastralIdentifier.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Comments A stream of bytes, base64 encoded Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
valueString			string	There are no (further) constraints on this element Data Type string
constituencyId		0..1	Extension	There are no (further) constraints on this element Element Id Address.extension:addressMetadata.extension:constituencyId Short description stemmekrets Alternate names extensions, user content, valgkrets, stemmekrets Definition FREG kaller dette stemmekrets, matrikkelen kaller dette valgkrets. del av en geografisk inndeling av kommunen som er bestemt av valgstyret Informasjonen er gitt ved en unik kode innenfor kommunen. 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. Data Type Extension Constraints 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 freg:stemmekrets
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Address.extension:addressMetadata.extension:constituencyId.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. 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. Data Type System.String Fixed Value constituencyId Mappings rim:N/A
value[x]		0..1		There are no (further) constraints on this element Element Id Address.extension:addressMetadata.extension:constituencyId.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Comments A stream of bytes, base64 encoded Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
valueInteger			integer	There are no (further) constraints on this element Data Type integer
fregAddressContentType		0..1	ExtensionBinding	There are no (further) constraints on this element Element Id Address.extension:addressMetadata.extension:fregAddressContentType Short description Content type for address provided by FREG Alternate names extensions, user content Definition FREG exposes 9 AddressContentTypes Vegadresse VegadresseForPost Postboksadresse Matrikkeladresse InternasjonalAdresse PostadresseFrittFormat InternasjonalAdresseIFrittFormat UkjentBosted AdressenErUkjent (only for "oppholdsadresse") 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. Data Type Extension Binding GdAddressContenttypeValueSet (required) Constraints 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
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Address.extension:addressMetadata.extension:fregAddressContentType.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. 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. Data Type System.String Fixed Value fregAddressContentType Mappings rim:N/A
value[x]		0..1		There are no (further) constraints on this element Element Id Address.extension:addressMetadata.extension:fregAddressContentType.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Comments A stream of bytes, base64 encoded Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
valueCode			code	There are no (further) constraints on this element Data Type code
fregAddressType		0..1	ExtensionBinding	There are no (further) constraints on this element Element Id Address.extension:addressMetadata.extension:fregAddressType Short description address types provided by FREG Alternate names extensions, user content Definition FREG exposes 6 different AddressTypes Bostedsadresse Oppholdsadresse DeltBosted Kontaktadresse KontaktadresseUtlandet PreferertKontaktadresse 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. Data Type Extension Binding GdAddressTypeValueSet (required) Constraints 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
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Address.extension:addressMetadata.extension:fregAddressType.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. 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. Data Type System.String Fixed Value fregAddressType Mappings rim:N/A
value[x]		0..1		There are no (further) constraints on this element Element Id Address.extension:addressMetadata.extension:fregAddressType.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Comments A stream of bytes, base64 encoded Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
valueCode			code	There are no (further) constraints on this element Data Type code
physicalAddressType		0..1	ExtensionBinding	There are no (further) constraints on this element Element Id Address.extension:addressMetadata.extension:physicalAddressType Short description oppholdAnnetSted Alternate names extensions, user content, oppholdAnnetSted Definition kategorisering av type oppholdssted iht. folkeregisterforskriften militær utenriks påSvalbard pendler 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. Data Type Extension Binding GdAddressPhysicaladdresstypeValueSet (required) Constraints 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 freg:oppholdAnnetSted
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Address.extension:addressMetadata.extension:physicalAddressType.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. 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. Data Type System.String Fixed Value physicalAddressType Mappings rim:N/A
value[x]		0..1		There are no (further) constraints on this element Element Id Address.extension:addressMetadata.extension:physicalAddressType.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Comments A stream of bytes, base64 encoded Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
valueCode			code	There are no (further) constraints on this element Data Type code
schoolDistrict		0..1	Extension	There are no (further) constraints on this element Element Id Address.extension:addressMetadata.extension:schoolDistrict Short description skolekrets fra FREG Alternate names extensions, user content, skolekrets Definition en kommunal inndeling som gir en ikke bindende skoletilhørighet for barna i kretsen Informasjonen er gitt ved en unik kode innenfor kommunen. 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. Data Type Extension Constraints 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 freg:skolekrets
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Address.extension:addressMetadata.extension:schoolDistrict.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. 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. Data Type System.String Fixed Value schoolDistrict Mappings rim:N/A
value[x]		0..1		There are no (further) constraints on this element Element Id Address.extension:addressMetadata.extension:schoolDistrict.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Comments A stream of bytes, base64 encoded Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
valueInteger			integer	There are no (further) constraints on this element Data Type integer
cadastralIdentifier		0..1	Extension	There are no (further) constraints on this element Element Id Address.extension:addressMetadata.extension:cadastralIdentifier Short description adresseidentifikatorFraMatrikkelen Alternate names extensions, user content, adresseidentifikatorFraMatrikkelen Definition Kartverkets matrikkel har en unik informasjonsfri identifikator for enhver adresse ned på husnummer – husbokstav nivå eller bruksnummer/festenummer nivå. FREG tar vare på denne identifikatoren for å kunne fange endringer fra matrikkelen. 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. Data Type Extension Constraints 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 freg:adresseIdentifikatorFraMatrikkelen
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Address.extension:addressMetadata.extension:cadastralIdentifier.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. 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. Data Type System.String Fixed Value cadastralIdentifier Mappings rim:N/A
value[x]		0..1		There are no (further) constraints on this element Element Id Address.extension:addressMetadata.extension:cadastralIdentifier.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Comments A stream of bytes, base64 encoded Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
valueString			string	There are no (further) constraints on this element Data Type string
addressIsUnknown		0..1	Extension	There are no (further) constraints on this element Element Id Address.extension:addressMetadata.extension:addressIsUnknown Short description AdressenErUkjent Alternate names extensions, user content, adressenErUkjent Definition The boolean value of the FREG element AdressenErUkjent. SHALL only be set true for an unknown "Oppholdsadresse". SHALL not have any value otherwise. 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. Data Type Extension Constraints 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()` addressType-1:addressIsUnknown must have fregAddressType of AdressenErUkjent `addressIsUnknown.value() and (fregAddressContentType.Value()='AdressenErUkjent')` Mappings rim:n/a rim:N/A freg:adressenErUkjent
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Address.extension:addressMetadata.extension:addressIsUnknown.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. 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. Data Type System.String Fixed Value addressIsUnknown Mappings rim:N/A
value[x]		0..1		There are no (further) constraints on this element Element Id Address.extension:addressMetadata.extension:addressIsUnknown.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Comments A stream of bytes, base64 encoded Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
valueBoolean			boolean	There are no (further) constraints on this element Data Type boolean
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Address.extension:addressMetadata.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. 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. Data Type System.String Fixed Value http://ehelse.no/fhir/StructureDefinition/gd-address-metadata Mappings rim:N/A
value[x]		0..0		There are no (further) constraints on this element Element Id Address.extension:addressMetadata.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Comments A stream of bytes, base64 encoded Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
cadastralAddress	S	0..1	Extension(Complex)	Element Id Address.extension:cadastralAddress Short description includes subNumber and additionalName for the Cadastral address Alternate names extensions, user content Definition includes subNumber and additionalName for the Cadastral address as registered in the Norwegian Master Person Index. undernummer addressetilleggsnavn 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. Data Type Extension(Complex) Extension URL http://ehelse.no/fhir/StructureDefinition/gd-cadastral-address Constraints 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
extension		0..*	Extension	Element Id Address.extension:cadastralAddress.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May 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. 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. Data Type Extension Sliced: Unordered, Open, by url(Value) Constraints 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
subNumber		0..1	Extension	Element Id Address.extension:cadastralAddress.extension:subNumber Short description includes subNumber and additionalName for the Cadastral address Alternate names extensions, user content, undernummer Definition includes subNumber and additionalName for the Cadastral address as registered in the Norwegian Master Person Index. undernummer addressetilleggsnavn 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. Data Type Extension Constraints 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 freg:undernummer
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Address.extension:cadastralAddress.extension:subNumber.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. 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. Data Type System.String Fixed Value subNumber Mappings rim:N/A
value[x]		0..1		There are no (further) constraints on this element Element Id Address.extension:cadastralAddress.extension:subNumber.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Comments A stream of bytes, base64 encoded Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
valueInteger			integer	There are no (further) constraints on this element Data Type integer
addressAdditionalName		0..1	Extension	There are no (further) constraints on this element Element Id Address.extension:cadastralAddress.extension:addressAdditionalName Short description additional name in use (adressetilleggsnavn) Alternate names extensions, user content, addressetilleggsnavn Definition addressetilleggsnavn nedarvet bruksnavn eller navn på en institusjon eller bygning, brukt som del av den offisielle adressen 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. Data Type Extension Constraints 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 freg:adressetilleggsnavn
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Address.extension:cadastralAddress.extension:addressAdditionalName.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. 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. Data Type System.String Fixed Value addressAdditionalName Mappings rim:N/A
value[x]		0..1		There are no (further) constraints on this element Element Id Address.extension:cadastralAddress.extension:addressAdditionalName.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Comments A stream of bytes, base64 encoded Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
valueString			string	There are no (further) constraints on this element Data Type string
url		1..1	System.StringFixed Value	There are no (further) constraints on this element Element Id Address.extension:cadastralAddress.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. 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. Data Type System.String Fixed Value http://ehelse.no/fhir/StructureDefinition/gd-cadastral-address Mappings rim:N/A
value[x]		0..0		There are no (further) constraints on this element Element Id Address.extension:cadastralAddress.value[x] Short description Value of extension Definition Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). Comments A stream of bytes, base64 encoded Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:N/A
separatelyOccupiedUnit	S	0..1	Extension(Complex)	Element Id Address.extension:separatelyOccupiedUnit Short description bruksenhetstype og bruksenhetsnummer fra FREG Alternate names extensions, user content, bruksenhet Definition Includes the identification and type of a separately occupied unit as registered in the Norwegian Master Person Index. 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. Data Type Extension(Complex) Extension URL http://ehelse.no/fhir/StructureDefinition/gd-separately-occupied-unit Constraints 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
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element Id Address.use Short description home \| work \| temp \| old \| billing - purpose of this address Definition Grunndata 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. 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. Data Type code Binding AddressUse (required) Constraints 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
type	Σ	0..1	codeBinding	There are no (further) constraints on this element Element Id Address.type Short description postal \| physical \| both Definition Grunndata 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. 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). Data Type code Binding AddressType (required) Constraints 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
text	Σ	0..1	string	There are no (further) constraints on this element Element Id Address.text Short description Text representation of the address Definition Specifies 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. 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. Data Type string Constraints 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
line	Σ	0..*	string	There are no (further) constraints on this element Element Id Address.line Short description Street name, number, direction & P.O. Box etc. Definition This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints 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)
extension		0..*	Extension	Element Id Address.line.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May 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. 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. Data Type Extension Sliced: Unordered, Open, by url(Value) Constraints 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
coName		0..1	Extension(string)	Element Id Address.line.extension:coName Short description coAdressenavn fra FREG Alternate names extensions, user content, coAdressenavn Definition coAdressenavn fra FREG, beskrivelse av enten hvem mottakeren er i "omsorg" hos (C/O="care of") eller hvem som er mottaker innen en organisasjon (v/=ved eller Att:="attention") 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. Data Type Extension(string) Extension URL http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-careOf Constraints 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=CAR] freg:coAdressenavn
city	Σ	0..1	string	There are no (further) constraints on this element Element Id Address.city Short description Poststed or city Alternate names Municpality, by, poststed, poststedsnavn Definition gd-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. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints 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
district	Σ	0..1	string	There are no (further) constraints on this element Element Id Address.district Short description name of "kommune" or district Alternate names County, kommune Definition gd-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). 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. Data Type string Constraints 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]
extension		0..*	Extension	There are no (further) constraints on this element Element Id Address.district.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May 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. 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. Data Type Extension Sliced: Unordered, Open, by url(Value) Constraints 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
municipalitycode		0..1	Extension(Coding)	There are no (further) constraints on this element Element Id Address.district.extension:municipalitycode Short description Coded value for municipality/county Norwegian kommune Alternate names extensions, user content Definition Coded value for municipality/county Norwegian kommune 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. Data Type Extension(Coding) Extension URL http://hl7.no/fhir/StructureDefinition/no-basis-municipalitycode Constraints 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
state	Σ	0..1	string	There are no (further) constraints on this element Element Id Address.state Short description norwegian "fylke" Alternate names Province, Territory, fylke Definition Name 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). Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints 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
postalCode	Σ	0..1	string	There are no (further) constraints on this element Element Id Address.postalCode Short description Postal code for area Alternate names Zip, postnummer Definition A postal code designating a region defined by the postal service. In Norway this is af four digit number defined by the norwegian postal service. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints 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
country	Σ	0..1	string	There are no (further) constraints on this element Element Id Address.country Short description Country (e.g. can be ISO 3166 2 or 3 letter code) Definition Country - a nation as commonly understood or generally accepted. Comments ISO 3166 3 letter codes can be used in place of a human readable country name. Data Type string Constraints 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
period	S Σ	0..1	Period	There are no (further) constraints on this element Element Id Address.period Short description Time period when address was/is in use Alternate names flyttedato, oppholdsadressedato, startdatoForKontrakt, sluttdatoForKontrakt Definition Grunndata uses this element to represent flyttedato, oppholdsadressedato and startdatoForKontrakt/sluttdatoForKontrakt Time period when address was/is in use. 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. Data Type Period Constraints 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
start	S Σ	0..1	dateTime	There are no (further) constraints on this element Element Id Address.period.start Short description Starting time with inclusive boundary Alternate names flyttedato, oppholdsadressedato, startdatoForKontrakt Definition Grunndata uses this element to represent flyttedato, oppholdsadressedato and startdatoForKontrakt The start of the period. The boundary is inclusive. Comments If the low element is missing, the meaning is that the low boundary is not known. Data Type dateTime Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:DR.1 rim:./low freg.Bostedsadresse:flyttedato freg.Oppholdsadresse:oppholdsadressedato freg.DeltBosted:startdatoForKontrakt
end	S Σ	0..1	dateTime	There are no (further) constraints on this element Element Id Address.period.end Short description End time with inclusive boundary, if not ongoing Alternate names sluttdatoForKontrakt Definition Grunndata uses this element to represent sluttdatoForKontrakt The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. Comments The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03. Data Type dateTime Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:DR.2 rim:./high freg.DeltBosted:sluttdatoForKontrakt

Must support definitions

In the context of Master Person Index, Must Support on any data element SHALL be interpreted as follows:

Must support = true

Usually this means that the Responders should include the data in the query result if the data is present for the given resource instance.

Responders SHALL be capable of including the data element as part of the query results as specified by the Server Capability Statement. In situations where information on a particular data element is not present and the reason for absence is unknown, Responders SHALL NOT include the data elements in the resource instance returned as part of the query results.

Requestors SHALL be capable of processing resource instances containing the data elements without generating an error or causing the application to fail. Requestors SHOULD be capable of displaying the data elements for human use. Requestors SHOULD be able to store the information for other purposes.

must support = false

Usually this means that Responders has no data to populate the element and Requestors is not expected to display the data elements for human use.

Responders SHALL NOT be capable of including the data element as part of the query results as specified by the Server Capability Statement.

Requestors MAY be capable of displaying the data elements for human use. Requestors SHOULD be able to store the information for other purposes. Requestors SHALL be capable of processing resource instances containing the data elements without generating an error or causing the application to fail.

must support not set

If the must support flag is not set no requirements exist as to wether the data is expected to be included in the search result. In most cases this means that the information is not awailable to the Responders, but the information could be included in a later version.

Responders MAY be capable of including the data element as part of the query results as specified by the Server Capability Statement.

Must support rendering in the Implementation guide

Unfortunately the Implementation guide rendering of the must-support flag is not perfect on the SIMPLIFIER platform. Only the instances where the must support = true is rendered in the resource-profile overview (look for the red "S" in the profile rendering). The flag is not even included in the detailed rendering. This results in a situation where the rendering is not able to show the difference between must support = false and not-set. This distinction is only visible in the StructureDefinition XML.

Read interaction

GET [base]/[Resource-type]/[id] {parameters}

GET is the HTTP verb used for fetching a resource

Content surrounded by [] is mandatory, and will be replaced by the string literal identified.
base: The Service Root URL (e.g. “https://fhir-open-api-dstu2.smarthealthit.org”)
Resource-type: The name of a resource type (e.g. “Person”)
id: The Logical Id of a resource(e.g. “24342”)
Content surrounded by is optional
parameters: URL parameters as defined for the particular interaction (e.g.”?_format=xml”}

Example
`GET http://hapi.fhir.org/baseR4/Person/53098`

For more information see the FHIR RESTful API

Search interaction

For searching a resource, interactions on profile pages are defined with the following syntax:

GET [base]/[Resource-type]?name=value&...

For this RESTful search, the parameters are a series of name=[value] pairs encoded in the URL. The search parameter names are defined for each resource. For example, the Observation resource the name “code” for search on the LOINC code. For more information see the FHIR RESTful Search API

To search for RelatedPersons og Provenance resources connected to a Person you need to include the Person identifier in the search parameters of the related resource.

GET [base]/RelatedPerson?patient=[id]
GET [base]/RelatedPerson?patient:identifier=[system]|[code]

Example
`GET [base]/RelatedPerson?patient=53098`

Special note on searching on person identifier

The person identifiers (DNR and FNR in particular) is considered sensitive data that should not end up in any access logs of the server system. Usually HTTP parameters from the HTTP request will end up in the logs and could be read by personnell accessing these logs. The preferred method to avoid this happening is to use a POST transaction for searching on these parameters and put the search parameters in the body of the HTTP message like this:

Example
`POST /baseR4/Person/_search HTTP/1.1` `Host: hapi.fhir.org` `Content-Type: application/x-www-form-urlencoded` `Cache-Control: no-cache` `Postman-Token: b43d58f5-f006-fe4a-4fc3-e8c60e1af589` `identifier=urn%3Aoid%3A2.16.578.1.12.4.1.4.1%7C04021950128`

The CapabilityStatement specifies what search parameters that requires a POST transaction for searching.

Dataminimization by default

The service expects the clients to specify what information elements they need (based on "tjenstlig behov") using the _elements operation. When the _elements operation is missing from the read/search statement, no information is returned to the client.

_total parameter

The return Bundle has an element total which is the number of resources that match the search parameters. The _total parameter makes it possible to specify what information the client needs for the total element in the return Bundle.

The Service has a default value of none set for the _total parameter. The default value reduce the server load for large search-sets. The default behaviour can be changed by setting the _total parameter in the search request, please consider not changing the _total parameter to accurate unless your client really needs this information.

Guidance On Limiting The Number Of Search Results

In order to manage the number of search results returned, the server may choose to return the results in a series of pages. The search result set contains the URLs that the client uses to request additional pages from the search set. For a simple RESTful search, the page links are contained in the returned bundle as links. See the managing returned resources in the FHIR specification for more information.

History of a resource

Every Person resource returned by the server contains both currently active information and all information that was active at some earlier point in time, (e.g. historic information). The consumer of the information must read the fregMetadata.currentInfo element to tell the current and historic information apart.

Thus the historic information of resources from the Master Person Index deviates from how this is usually implemented on FHIR servers using the _history operation.

HTTP Status Codes

HTTP status codes are handled as described in the FHIR RESTful API specification.