Datatypes

This page gives guidance on the representation of constructs, such as:

  • Representing structured addresses using Address.

Address

A physical address(es) for the organization, location and patient.

id0..1string
adsS I0..1Extension(Coding)
ehakS I0..1Extension(Coding)
useΣ ?!0..1codeBinding
typeΣ0..1codeBinding
textΣ0..1string
id0..1string
censusTractI0..1Extension(string)
streetNameI0..1Extension(string)
streetNameBaseI0..1Extension(string)
houseNumberI0..1Extension(string)
additionalLocatorI0..1Extension(string)
value0..1System.String
cityΣ0..1string
districtΣ0..1string
stateΣ0..1string
postalCodeΣ0..1string
countryΣ0..1string
periodΣ I0..1Period

In addition to the base Address, the Estonian address includes ADS and EHAK extensions.


ADS
Address ID from the Estonian address register.


EHAK
Code from EHAK classifier. The specified code will be validated against the latest version of the EHAK classifier. In the case of the exact version of the EHAK the Coding.version attribute should be specified.

 
  <extension url="https://hl7.ee/fhir/StructureDefinition/Extension-EEBase-EHAK">
    <valueCoding>
      <system value="http://fhir.hl7.ee/id/ehak-number"/>
      <version value="2021v3"/>
      <code value="2928"/>
      <display value="Kehra linn"/>
    </valueCoding>
  </extension>


use
The purpose of this address.
The required ValueSet used in this case is address-use, meaning these values MUST be exchanged. Local value sets SHOULD be mapped to the required ValueSet.


type
Distinguishes between physical addresses and mailing addresses. Most addresses are both.
The required ValueSet used in this case is address-type, meaning these values MUST be exchanged. Local value sets SHOULD be mapped to the required ValueSet.


text
The text element 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. 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.
The text form of the address should conform to ADS interfacing guide (ADS-iga liidestumise juhend).


line
This component contains extensions, such as censusTract, streetName, streetNameBase, houseNumber, additionalLocator.


city
Textual presentation of the administrative unit name. Suitable for any unit type: city, borough, village. Only informative. It doesn't have business meaning.


district
Textual presentation of the parish. Only informative. It doesn't have business meaning.


state
Textual presentation of the county. It should be used according to the EHAK classifier, for example, "Harju maakond" instead of "Harjumaa".


postalCode
Postal code for the area.


country
ISO 3166 3 letter code.


period
Time period when address was/is in use.


Identifiers

Business Registry ID

Organization's Business Registry code.

id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)


use
Identifies the purpose for this identifier, if known.
The required ValueSet used in this case is identifier-use, meaning these values MUST be exchanged. Local value sets SHOULD be mapped to the required ValueSet.

type

This data element should not be used for this Identifier as the identifier.system is known.
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

system
This is a mandatory data element.
Namespace for the organization's Business Registry code. This element has a fixed value: https://hl7.ee/fhir/NamingSystem/org-est-id

value
This is a mandatory data element.
The value of the Organization's Business Registry code

period
Time period during which this identifier is/was valid for use.

assigner
Organization that issued/manages the identifier. References to Organization.

Estonian Personal Identification Number (Must support)

Personal identification number for Estonians.

id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
typeS Σ0..1CodeableConceptBinding
systemS Σ1..1uriFixed Value
valueS Σ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)


use
Identifies the purpose for this identifier, if known.
The required ValueSet used in this case is identifier-use, meaning these values MUST be exchanged. Local value sets SHOULD be mapped to the required ValueSet.

type (must support)

This data element should not be used for this Identifier as the identifier.system is known.
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

system (must support)
This is a mandatory data element.
Namespace for the Estonian personal identification number. This element has a fixed value: https://hl7.ee/fhir/NamingSystem/pid-est-id.

value (must support)
This is a mandatory data element.
The value of an Estonian personal identification number.

period
Time period during which this identifier is/was valid for use.

assigner
Organization that issued/manages the identifier. References to Organization.

MedreTAM Practitioner ID (Must support)

Healthcare professional number that is registered at Estonian Health Board.

id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
typeS Σ0..1CodeableConceptBinding
systemS Σ1..1uriFixed Value
valueS Σ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)


use
Identifies the purpose for this identifier, if known.
The required ValueSet used in this case is identifier-use, meaning these values MUST be exchanged. Local value sets SHOULD be mapped to the required ValueSet.

type (must support)

This data element should not be used for this Identifier as the identifier.system is known.

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

system (must support)

This is a mandatory data element.
Namespace for the healthcare professional code. This element has a fixed value: https://hl7.ee/fhir/NamingSystem/pid-medre-id.

value (must support)
This is a mandatory data element.
The value of the Healthcare professional code.
period
Time period during which this identifier is/was valid for use.

assigner
Organization that issued/manages the identifier. References to Organization.

MedreTAM Organization ID (Must support)

Healthcare facility number that is registered at Estonian Health Board.

id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
typeS Σ0..1CodeableConceptBinding
systemS Σ1..1uriFixed Value
valueS Σ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)


use
Identifies the purpose for this identifier, if known.
The required ValueSet used in this case is identifier-use, meaning these values MUST be exchanged. Local value sets SHOULD be mapped to the required ValueSet.
type (must support)

This data element should not be used for this Identifier as the identifier.system is known.
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

system (must support)
This is a mandatory data element.
Namespace for the healthcare facility identifier. This element has a fixed value: https://hl7.ee/fhir/NamingSystem/org-medre-id.

value (must support)
This is a mandatory data element.
The value of the Healthcare facility number.
period
Time period during which this identifier is/was valid for use.

assigner
Organization that issued/manages the identifier. References to Organization.

TIS ID

An unique identificator for person which is generated by National Health System (TIS).

id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)


use
Identifies the purpose for this identifier, if known.
The required ValueSet used in this case is identifier-use, meaning these values MUST be exchanged. Local value sets SHOULD be mapped to the required ValueSet.
type

This data element should not be used for this Identifier as the identifier.system is known.
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

system
This is a mandatory data element.
Namespace for the unique code generated by National Health System. This element has a fixed value: https://hl7.ee/fhir/NamingSystem/pid-tis-id.

value
This is a mandatory data element.
The value of an unique code generated by National Health System (TIS).
period
Time period during which this identifier is/was valid for use.

assigner
Organization that issued/manages the identifier. References to Organization.

VATIN

Value added tax identification number for person, business or non-legal entity.

id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemS Σ1..1uriFixed Value
valueS Σ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)


use
Identifies the purpose for this identifier, if known.
The required ValueSet used in this case is identifier-use, meaning these values MUST be exchanged. Local value sets SHOULD be mapped to the required ValueSet.
type

This data element should not be used for this Identifier as the identifier.system is known.
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

system (must support)
This is a mandatory data element.
Namespace for the VAT number. This element has a fixed value: https://hl7.ee/fhir/NamingSystem/org-vatin.

value (must support)
This is a mandatory data element.
The value of an unique number that is registered for VAT.

period
Time period during which this identifier is/was valid for use.

assigner
Organization that issued/manages the identifier. References to Organization.