Address

Description

A data type used to describe a postal address. The address can be used for persons and for example also doctors.

Use

– Use only for postal address

Not use

– Do not use for any other address, e.g. email, ip or web. This contact data is stored in the Telcom data type.

Data Model

Name Type M Description Example
street String X Street part of address. “Maria Trost”
zip String X Zip part of address “56070”
city String X City the address is placed. “Koblenz”
state String Which state the city lays in? “Rheinland-Pfalz”
country CodedEntry X See catalog country_id “DE”

Rules

– The street field must contain the house number.
– The street field should contain any additional address information like “Complex B”
– For language reasons, the country is supposed to be in ISO 3166 format.

Enums

No enums necessary.

Catalogs

– CGM Catalog: Country_Id

Update Rhythm

The address should be updated whenever it changes.

Schema

{
“id”: “/core/Address”,
“$schema”: “http://json-schema.org/draft-04/schema#”,
“type”: “object”,
“properties”: {
“street”: {
“type”: “string”
},
“zip”: {
“type”: “string”
},
“city”: {
“type”: “string”
},
“state”: {
“type”: “string”
},
“country”: {
“type”: “string”
}
},
“additionalProperties”: false
}

Compatible Standards

The address is compatible to EHR – openEHR-DEMOGRAPHIC-ADDRESS.address.v1.