ai.newnal.mydata.defs
The shared defs of the mydata-core Lexicons.
Details · defs
| Kind | defs |
|---|---|
| Authority | mydata.newnal.ai |
| Commit rev | 3n2lk5rjzfw23 |
| Indexed |
#addressEntry
objectAn address item that groups a purpose label, a postal address, tags and whether it is the primary one.
Properties
address
refThe postal address.
coordinates
refThe coordinates of this address.
label
stringA label for what the address is used as.
maxLength: 640maxGraphemes: 64knownValues: home | work | mailing | shipping | billing
primary
booleanWhether this is the item to use first among items of the same kind.
tags
arrayList of the tags for the meaning, traits or context the user gave to or adopted for this address. A tag itself does not decide visibility or access rights: disclosure is decided by a separate user permission policy.
maxLength: 100
One item of the list of the tags for the meaning, traits or context the user gave to or adopted for this address.
maxLength: 640maxGraphemes: 64knownValues: home | shipping | billing | official_mail
#archiveEntry
objectOne archive record held in an archive section. It is made of a subtype, a title, an issuer, a time, tags and open content.
Properties
content
unknownAn open object for storage. It holds content that differs from record to record, such as text, JSON and nested blobs. A file or document is uploaded as a blob and placed inside content as a blob object (`$type` `blob`); a bare CID link (`$link`) does not attach the blob to the record. The top-level content itself cannot be a CID link (`$link`) or a blob. Checked by the MyData domain validator, not by the Lexicon.
issuer
stringThe issuer or provider of the record. self when the user wrote it.
maxLength: 640maxGraphemes: 64knownValues: self
recordType
stringThe subtype of the archive record.
maxLength: 640maxGraphemes: 64
tags
arrayList of the tags for the meaning, traits or context the user gave to or adopted for this record. A tag itself does not decide visibility or access rights: disclosure is decided by a separate user permission policy.
maxLength: 100
One item of the list of the tags for the meaning, traits or context the user gave to or adopted for this record.
maxLength: 640maxGraphemes: 64knownValues: housing | tax | immigration | family | health | finance | business | travel
time
unionThe point in time the record was issued or written, or the period it covers.
title
stringThe title of the record.
maxLength: 2560maxGraphemes: 256
#coding
objectA code from a standard classification, given next to the free-text value it classifies: the code system, the code and its display name.
Properties
code
stringThe code in that code system.
maxLength: 640maxGraphemes: 64
display
stringThe human-readable name of the code in that code system.
maxLength: 2560maxGraphemes: 256
system
stringThe code system the code belongs to, as its URI or well-known name (for example http://snomed.info/sct, ICD-10, LOINC, RxNorm, ATC, ISCO-08, ISCED 2011).
maxLength: 2560maxGraphemes: 256
#contactPoint
objectAn item for one contact point, such as an email address, a phone number or an account.
Properties
identifier
stringThe actual identifier of the contact point.
maxLength: 2560maxGraphemes: 256
identifierKind
stringThe kind of identifier, telling whether it is an address or an account handle.
maxLength: 640maxGraphemes: 64knownValues: address | handle | number
label
stringA display name for the contact point.
maxLength: 2560maxGraphemes: 256
primary
booleanWhether this is the item to use first among items of the same kind.
provider
stringThe provider of the contact point, such as a mail service or a carrier.
maxLength: 2560maxGraphemes: 256
tags
arrayList of the tags for the meaning, traits or context the user gave to or adopted for this contact point. A tag itself does not decide visibility or access rights: disclosure is decided by a separate user permission policy.
maxLength: 100
One item of the list of the tags for the meaning, traits or context the user gave to or adopted for this contact point.
maxLength: 640maxGraphemes: 64knownValues: personal | work | billing
type
stringThe type of contact point, such as email, phone or messaging.
maxLength: 640maxGraphemes: 64knownValues: email | phone | messaging | social_account | did | wallet
uri
string · uriA URI form of the contact point, such as a mailto: or tel: URI or a profile URL.
#date
stringA calendar date in YYYY-MM-DD form. Checked by the MyData domain validator, not by the Lexicon.
maxLength: 10
#decimal
stringA canonical decimal string with no unnecessary leading zeros, no trailing zeros in the fraction, no exponent and no plus sign. `-0` is not allowed. Grammar `^(?!-0$)-?(0|[1-9][0-9]*)(\.[0-9]*[1-9])?$`. Checked by the MyData domain validator, not by the Lexicon.
maxLength: 64
#geoCoordinates
objectA point given as WGS 84 latitude and longitude (decimal degrees) with an accuracy radius. Latitude and longitude are present together or absent together, and the accuracy cannot be present alone. The ranges and the pairing are checked by the MyData domain validator, not by the Lexicon.
Properties
accuracy
refThe accuracy radius of the coordinates (metres). It means the actual position is within this distance of the coordinates; for coordinates that stand for an area, such as the representative point of an administrative area, write the approximate radius of that area. Must be 0 or greater. When absent, the accuracy is unknown (it does not mean an exact point).
latitude
refLatitude (decimal degrees, north positive). The range is from -90 to 90 (both ends inclusive).
longitude
refLongitude (decimal degrees, east positive). The range is from -180 to 180 (both ends inclusive).
#instantTime
objectThe time union variant for a single point in time.
#intervalTime
objectThe time union variant for a period from a start time to an end time.
Properties
endAt
string · datetimeThe time the period ends. Omit the key when the period is ongoing or the end time is not stored.
precision
stringThe precision of the time value.
maxLength: 640maxGraphemes: 64knownValues: minute | day | month | year
The date and time the period starts.
timezone
stringThe IANA time zone name (for example Asia/Seoul).
maxLength: 640maxGraphemes: 64
#localTime
stringA time of day in 24-hour HH:MM form. Grammar `^([01][0-9]|2[0-3]):[0-5][0-9]$`. Checked by the MyData domain validator, not by the Lexicon.
maxLength: 5
#measuredAmount
objectA measured quantity, given as an amount and a unit.
#money
objectAn amount of money, given as a currency and an amount.
#moneyRange
objectA money range given as a currency and minimum and maximum amounts. When both the minimum and the maximum are present, the minimum is at most the maximum: checked by the MyData domain validator, not by the Lexicon.
Properties
currency
stringThe currency of the amount, as an ISO 4217 code (for example KRW).
maxLength: 640maxGraphemes: 64
max
refThe upper bound of the range. When min is also present, it cannot be less than min.
min
refThe lower bound of the range. When max is also present, it cannot be greater than max.
#postalAddress
objectA postal address made of a street address, city and administrative area, postal code and country.
Properties
adminArea
stringThe first-level administrative area below the country.
maxLength: 2560maxGraphemes: 256
country
stringThe country, as an ISO 3166-1 alpha-2 code (for example KR).
maxLength: 640maxGraphemes: 64
locality
stringThe city or locality of the address.
maxLength: 2560maxGraphemes: 256
postalCode
stringThe postal code.
maxLength: 2560maxGraphemes: 256
streetAddress
stringThe street address, including the street name, building number and the like.
maxLength: 2560maxGraphemes: 256
#recordMeta
objectProperties
The time this record was first created. The first value is kept when the record is updated.
#weekday
stringThe weekday code a recurring time window applies to.
enum: mon | tue | wed | thu | fri | sat | sun