1.0.0 - ci-build Norway flag

HelseAPI - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Data Type Profile: NoHelseAPIAddress

Official URL: http://hl7.no/fhir/StructureDefinition/no-helseapi-Address Version: 1.0.0
Draft as of 2024-02-09 Computable Name: NoHelseAPIAddress

Usage:

  • This DataType Constraint is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

This structure is derived from NoBasisAddress

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..*NoBasisAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... extension:official S0..1NoBasisAddressOfficialThe concept of an officially registered address
... use S0..1codehome | work | temp | old | billing - purpose of this address
... type S0..1codepostal | physical | both
... city 1..1stringPoststed or city
... district S0..1stringname of "kommune"
... state S0..1stringnorwegian "fylke"
... postalCode 1..1stringPostal code for area
... country S0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..*NoBasisAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... official S0..1booleanThe concept of an officially registered address
URL: http://hl7.no/fhir/StructureDefinition/no-basis-address-official
... urbanDistrict N0..1Codingurban district information
URL: http://hl7.no/fhir/StructureDefinition/no-basis-urban-district
Binding: urn:oid:2.16.578.1.12.4.1.1.3403 (required): Bydel


... propertyInformation N0..*(Complex)Real property identification
URL: http://hl7.no/fhir/StructureDefinition/no-basis-propertyinformation
... type SΣ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
... line SΣ0..*stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
... city Σ1..1stringPoststed or city
Example General: Erewhon
... district SΣ0..1stringname of "kommune"
Example General: Madison
.... municipalitycode N0..1CodingCoded value for municipality/county Norwegian kommune
URL: http://hl7.no/fhir/StructureDefinition/no-basis-municipalitycode
Binding: https://register.geonorge.no/subregister/sosi-kodelister/kartverket/kommunenummer-alle (required)
... state SΣ0..1stringnorwegian "fylke"
... postalCode Σ1..1stringPostal code for area
Example General: 9132
... country SΣ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)

doco Documentation for this format

Terminology Bindings

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

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..*NoBasisAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... id 0..1stringUnique id for inter-element referencing
... Slices for extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... official S0..1booleanThe concept of an officially registered address
URL: http://hl7.no/fhir/StructureDefinition/no-basis-address-official
... propertyInformation N0..*(Complex)Real property identification
URL: http://hl7.no/fhir/StructureDefinition/no-basis-propertyinformation
... use ?!SΣ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


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


Example General: both
... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
... line SΣ0..*stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
... city Σ1..1stringPoststed or city
Example General: Erewhon
... district SΣ0..1stringname of "kommune"
Example General: Madison
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... municipalitycode N0..1CodingCoded value for municipality/county Norwegian kommune
URL: http://hl7.no/fhir/StructureDefinition/no-basis-municipalitycode
Binding: https://register.geonorge.no/subregister/sosi-kodelister/kartverket/kommunenummer-alle (required)
.... value 0..1stringPrimitive value for string
Max Length: 1048576
... state SΣ0..1stringnorwegian "fylke"
... postalCode Σ1..1stringPostal code for area
Example General: 9132
... country SΣ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
... period ΣC0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}

doco Documentation for this format

Terminology Bindings

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

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
per-1errorAddress.periodIf present, start SHALL have a lower value than end
: start.hasValue().not() or end.hasValue().not() or (start <= end)

This structure is derived from NoBasisAddress

Summary

Mandatory: 2 elements
Must-Support: 7 elements

Differential View

This structure is derived from NoBasisAddress

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..*NoBasisAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... extension:official S0..1NoBasisAddressOfficialThe concept of an officially registered address
... use S0..1codehome | work | temp | old | billing - purpose of this address
... type S0..1codepostal | physical | both
... city 1..1stringPoststed or city
... district S0..1stringname of "kommune"
... state S0..1stringnorwegian "fylke"
... postalCode 1..1stringPostal code for area
... country S0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..*NoBasisAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... official S0..1booleanThe concept of an officially registered address
URL: http://hl7.no/fhir/StructureDefinition/no-basis-address-official
... urbanDistrict N0..1Codingurban district information
URL: http://hl7.no/fhir/StructureDefinition/no-basis-urban-district
Binding: urn:oid:2.16.578.1.12.4.1.1.3403 (required): Bydel


... propertyInformation N0..*(Complex)Real property identification
URL: http://hl7.no/fhir/StructureDefinition/no-basis-propertyinformation
... type SΣ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
... line SΣ0..*stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
... city Σ1..1stringPoststed or city
Example General: Erewhon
... district SΣ0..1stringname of "kommune"
Example General: Madison
.... municipalitycode N0..1CodingCoded value for municipality/county Norwegian kommune
URL: http://hl7.no/fhir/StructureDefinition/no-basis-municipalitycode
Binding: https://register.geonorge.no/subregister/sosi-kodelister/kartverket/kommunenummer-alle (required)
... state SΣ0..1stringnorwegian "fylke"
... postalCode Σ1..1stringPostal code for area
Example General: 9132
... country SΣ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)

doco Documentation for this format

Terminology Bindings

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

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Address 0..*NoBasisAddressAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
... id 0..1stringUnique id for inter-element referencing
... Slices for extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... official S0..1booleanThe concept of an officially registered address
URL: http://hl7.no/fhir/StructureDefinition/no-basis-address-official
... propertyInformation N0..*(Complex)Real property identification
URL: http://hl7.no/fhir/StructureDefinition/no-basis-propertyinformation
... use ?!SΣ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


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


Example General: both
... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
... line SΣ0..*stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
... city Σ1..1stringPoststed or city
Example General: Erewhon
... district SΣ0..1stringname of "kommune"
Example General: Madison
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... municipalitycode N0..1CodingCoded value for municipality/county Norwegian kommune
URL: http://hl7.no/fhir/StructureDefinition/no-basis-municipalitycode
Binding: https://register.geonorge.no/subregister/sosi-kodelister/kartverket/kommunenummer-alle (required)
.... value 0..1stringPrimitive value for string
Max Length: 1048576
... state SΣ0..1stringnorwegian "fylke"
... postalCode Σ1..1stringPostal code for area
Example General: 9132
... country SΣ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
... period ΣC0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}

doco Documentation for this format

Terminology Bindings

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

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
per-1errorAddress.periodIf present, start SHALL have a lower value than end
: start.hasValue().not() or end.hasValue().not() or (start <= end)

This structure is derived from NoBasisAddress

Summary

Mandatory: 2 elements
Must-Support: 7 elements

 

Other representations of profile: CSV, Excel, Schematron