Schemas / Person / organisation / party
rig.person.vital
v0.31.0 · draft 8 fields 0 required
Fields
| Field | Type | Meaning | |
|---|---|---|---|
sex |
enumunknown · male · female · not-applicable | optional | Recorded sex: unknown / male / female / not-applicable |
gender |
string | optional | Self-described gender identity |
birthDate |
string | optional | Calendar day, YYYY-MM-DD |
birthTown |
string | optional | Town / city of birth |
birthCountrySubDivision |
string | optional | State / province of birth |
birthCountry |
string | optional | ISO 3166-1 alpha-2, uppercase |
nationality |
string | optional | ISO 3166-1 alpha-2, uppercase |
countryOfResidence |
string | optional | ISO 3166-1 alpha-2, uppercase |
Sex, gender identity, and birth of a human, character, user, or contact. Format when present.
Recorded sex follows ISO/IEC 5218. Gender identity is a separate self-described string - not an ISO 5218 code. Birth and nationality fields follow ISO 20022 DateAndPlaceOfBirth / party residence.
All fields optional. Emit what the source has; omit empty strings. An empty component is invalid - attach at least one field.
sex and gender are different meanings. Do not copy one into the other. ISO 20022 GenderCode (MALE / FEMALE) maps onto sex, not gender.
Name parts are rig.person.name. Do not re-declare those here.
JSON Schema
Resolves at https://rig.works/schemas/rig.person.vital.schema.json —
raw file.
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://rig.works/schemas/rig.person.vital.schema.json",
"title": "rig.person.vital",
"type": "object",
"additionalProperties": false,
"properties": {
"sex": {
"type": "string",
"enum": [
"unknown",
"male",
"female",
"not-applicable"
]
},
"gender": {
"$ref": "./_defs.schema.json#/$defs/string"
},
"birthDate": {
"type": "string",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$",
"description": "ISO 8601 calendar date (ISO 20022 BirthDt)."
},
"birthTown": {
"$ref": "./_defs.schema.json#/$defs/string"
},
"birthCountrySubDivision": {
"$ref": "./_defs.schema.json#/$defs/string"
},
"birthCountry": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "ISO 3166-1 alpha-2 (ISO 20022 CtryOfBirth)."
},
"nationality": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "ISO 3166-1 alpha-2 (ISO 20022 Ntlty)."
},
"countryOfResidence": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "ISO 3166-1 alpha-2 (ISO 20022 CtryOfRes)."
}
},
"description": "Sex, gender identity, and birth. Sex follows ISO/IEC 5218; gender is self-described; birth follows ISO 20022 DateAndPlaceOfBirth.",
"minProperties": 1
}