Properties

address

concept:Address

The physical or postal address associated with this household.

Used by: Household

address_area

string

The name of a geographic area such as a neighborhood, quarter, or ward that groups addresses below the city level.

Used by: Address

administration_mode

string · administration-mode

How the instrument was administered to the subject: self-report, proxy-report (someone else answering about the subject), assisted (the subject answer…

Used by: Profile

administrative_area

string

The first-level administrative subdivision (province, state, region) containing the address.

Used by: Address

administrative_level

integer

The numeric tier in the administrative hierarchy, following the OCHA COD-AB convention: 0 = country, 1 = first subnational (state, province, region), …

Used by: Location

affected_locations

concept:Location · multiple

The geographic or administrative areas affected by this event.

Used by: HazardEvent

affected_programs

concept:sp/Program · multiple

Programs whose operations or beneficiaries are affected by this event.

Used by: HazardEvent

allowed_recipient_categories

string · multiple · organization-type

Categories of organizations permitted to receive the data, as described to the data subject in the notice. Complements 'recipients', which names speci…

Used by: ConsentRecord

amount

decimal

The monetary or quantitative value of the item being delivered, owed, or redeemed, expressed as a decimal number in the associated currency.

Used by: sp/BenefitSchedule, sp/Entitlement, VoucherRedemption, Voucher

anxiety_frequency

string · cfm-symptom-frequency

How often the person feels worried, nervous, or anxious. Applies to adults (WG-ES ANX_1) and to children ages 5-17 (CFM CF23, phrased as 'seems very a…

Used by: FunctioningProfile

anxiety_intensity

string · functional-intensity

The intensity of the person's last feeling of worry, nervousness, or anxiety. Applies to adults (WG-ES ANX_3). Asked of respondents who reported feeli…

Used by: FunctioningProfile

anxiety_medication

boolean

Whether the person takes medication for anxiety or worry. Applies to adults (WG-ES ANX_2). This filter is used to interpret anxiety_frequency answers,…

Used by: FunctioningProfile

applicant

concept:Person

The person or group that applied for and received this eligibility decision.

Used by: sp/EligibilityDecision

assessment_band

string

The ordinal or categorical classification result of an assessment, such as a wealth quintile, poverty band, or other grouping defined by the assessmen…

Used by: ScoringEvent

automated_decision_description

string

PrivacyNotice-only. Prose description of any automated decision-making, including profiling, that produces legal effects or similarly significant effe…

Used by: PrivacyNotice

available_languages

string · multiple · language

PrivacyNotice-only. ISO 639-3 codes of all languages in which this notice is available. See `notice_presentation_language` on the ConsentRecord for wh…

Used by: PrivacyNotice

beneficiary

concept:Party

The person or group enrolled in the program.

Used by: sp/Enrollment

biometric_modality

string · biometric-modality

The type of biometric measurement (face, fingerprint, iris, signature, voice).

Used by: BiometricSample

biometric_samples

concept:BiometricSample · multiple

Biometric samples associated with this person, linking to fingerprint, iris, face, and other biometric records.

Used by: Person

biometric_subtype

string · biometric-subtype

The specific body part or position within a biometric modality (e.g., right index finger, left eye, portrait).

Used by: BiometricSample

building_name

string

The name of a building, estate, or compound, used in contexts where locations are identified by name rather than street number.

Used by: Address

capture_date

date

The date on which the biometric sample was captured.

Used by: BiometricSample

capture_device

string

An identifier or description of the device used to capture the biometric sample.

Used by: BiometricSample

certainty

string · event-certainty

The confidence that the event has occurred or will occur.

Used by: HazardEvent

chronic_illness_in_household

boolean

Whether any household member is reported to have a chronic illness or long-term medical condition (e.g. hypertension, diabetes, HIV, TB, asthma). Reco…

Used by: Household

city

string

The city, town, or village component of the address.

Used by: Address

cognition_remembering_frequency

string · cognition-remembering-frequency

How often the person has difficulty remembering. Applies to adults (WG-ES COG_3). Asked only of respondents whose cognition difficulty includes rememb…

Used by: FunctioningProfile

cognition_subdomain

string · cognition-subdomain

Whether the person's cognition difficulty is with remembering, concentrating, or both. Applies to adults (WG-ES COG_2). Asked of respondents who repor…

Used by: FunctioningProfile

collection_medium

string · collection-medium

The medium through which consent was collected: paper, electronic, verbal, or mixed. Paper is the dominant medium in humanitarian and rural social-pro…

Used by: ConsentRecord

collection_session_ref

string

Opaque correlation key for records produced in the same intake session. A 'CollectionSession' concept is planned in ADR-013 and will formalize this; i…

Used by: ConsentRecord

commodity_type

string

The type of commodity or goods being delivered or redeemable.

Used by: DeliveryItem

complaint_authority_contact

string

Contact details for the relevant data protection authority where the data subject can lodge a complaint (e.g., in EU jurisdictions, the national DPA).…

Used by: PrivacyNotice

conforms_to

uri · multiple

URIs of standards or specifications this record conforms to (ISO/IEC TS 27560, Kantara Consent Receipt, W3C DPV, etc.). Purely declarative; no validat…

Used by: ConsentRecord, PrivacyNotice

consent_expression

string · consent-expression

The form in which consent was expressed: explicit opt-in, signed opt-in, witnessed opt-in, biometric opt-in, opt-out, or implied. IMPORTANT cross-refe…

Used by: ConsentRecord

consent_record_type

string · consent-record-type

Whether this record is an internal storage record or an externally-issued consent receipt. Internal records are the controller's working state; receip…

Used by: ConsentRecord

controllers

concept:Organization · multiple

Organizations determining the purposes and means of processing. Cardinality multiple covers joint controllership (two or more organizations jointly re…

Used by: ConsentRecord, PrivacyNotice

cooking_fuel

string · cooking-fuel

The primary fuel used by the household for cooking.

Used by: SocioEconomicProfile

country

string · country

The country, expressed as an ISO 3166-1 alpha-2 code where possible.

Used by: Address

country_of_birth

string · country

The country where the person was born, expressed as an ISO 3166-1 code.

Used by: Person

created_at

datetime

System-generated timestamp marking when this record was persisted. This is the digitisation timestamp, not the consent-giving date. Distinct from 'sig…

Used by: ConsentRecord, PrivacyNotice

currency

string · currency

The ISO 4217 currency code for a monetary value.

Used by: sp/BenefitSchedule, sp/Entitlement, VoucherRedemption, Voucher

cutoff_score

decimal

The threshold score below or above which an applicant is considered eligible.

Used by: ScoringRule

data_sources

string · multiple

The administrative, survey, or collected data sources that feed into the assessment calculation.

Used by: HazardEvent, ScoringRule

data_subject

concept:Party

The natural person (or occasionally group) whose personal data is being processed under this record. Party is the abstract supertype covering Person a…

Used by: ConsentRecord

date_of_birth

date

The date on which the person was born.

Used by: Person

date_of_death

date

The date on which the person died.

Used by: Person

decision_basis

string

The scoring event, profile, score, or administrative rule that formed the basis for the decision.

Used by: sp/EligibilityDecision

decision_date

date

The date on which the eligibility decision was recorded.

Used by: sp/EligibilityDecision

delegation_type

string · delegation-type

The basis under which 'indicated_by' acts on behalf of 'data_subject'. The value 'self' indicates no delegation: the data subject indicated their own …

Used by: ConsentRecord

delivery_channel

string · delivery-channel

The mechanism through which the transfer reaches the beneficiary.

Used by: PaymentEvent

delivery_date

date

The date on which the goods or services were distributed to the beneficiary.

Used by: InKindDelivery

delivery_location

string

The location where the distribution took place, such as a distribution point, school, or health facility.

Used by: InKindDelivery

delivery_status

string · payment-status

The status of this in-kind delivery.

Used by: InKindDelivery

depression_frequency

string · cfm-symptom-frequency

How often the person feels depressed. Applies to adults (WG-ES DEP_1) and to children ages 5-17 (CFM CF24, phrased as 'seems very sad or depressed').

Used by: FunctioningProfile

depression_intensity

string · functional-intensity

The intensity of the person's last feeling of depression. Applies to adults (WG-ES DEP_3). Asked of respondents who reported feeling depressed at leas…

Used by: FunctioningProfile

depression_medication

boolean

Whether the person takes medication for depression. Applies to adults (WG-ES DEP_2). This filter is used to interpret depression_frequency answers, wh…

Used by: FunctioningProfile

description

string

A free-text summary describing the event, situation, or record.

Used by: DeliveryItem, HazardEvent

difficulty_accepting_change

string · functional-difficulty-severity

The degree of difficulty the child experiences accepting changes in routine. Applies to children ages 5-17 (CFM).

Used by: FunctioningProfile

difficulty_being_understood

string · functional-difficulty-severity

The degree of difficulty others have understanding the child when (name) speaks (expressive communication), compared to children of the same age. Appl…

Used by: FunctioningProfile

difficulty_being_understood_inside_household

string · functional-difficulty-severity

The degree of difficulty people inside the household have understanding the child when (name) speaks, compared to children of the same age. Applies to…

Used by: FunctioningProfile

difficulty_being_understood_outside_household

string · functional-difficulty-severity

The degree of difficulty people outside the household have understanding the child when (name) speaks, compared to children of the same age. Applies t…

Used by: FunctioningProfile

difficulty_climbing_steps

string · functional-difficulty-severity

The degree of difficulty the person experiences walking up or down 12 steps. Applies to adults (WG-ES MOB_6).

Used by: FunctioningProfile

difficulty_cognition

string · functional-difficulty-severity

The degree of difficulty the person experiences remembering or concentrating. Applies to adults (WG-SS); for children ages 5-17 see difficulty_remembe…

Used by: FunctioningProfile

difficulty_communication

string · functional-difficulty-severity

The degree of difficulty the person experiences communicating, for example understanding or being understood, using their usual language. Applies to a…

Used by: FunctioningProfile

difficulty_concentrating

string · functional-difficulty-severity

The degree of difficulty the child experiences concentrating on an activity they enjoy doing. Applies to children ages 5-17 (CFM). Paired with difficu…

Used by: FunctioningProfile

difficulty_controlling_behaviour

string · functional-difficulty-severity

The degree of difficulty the child has controlling their behaviour, compared to children of the same age. Applies to children ages 5-17 (CFM CF21).

Used by: FunctioningProfile

difficulty_dexterity

string · functional-difficulty-severity

The degree of difficulty the person experiences picking up a small object, such as a button or pencil, with their hand. For children ages 2-4 (CFM CF1…

Used by: FunctioningProfile

difficulty_disruptive_behaviour

string · comparative-behaviour-scale

How much the child kicks, bites, or hits other children or adults, compared to children of the same age. Applies to children ages 2-4 (CFM CF16).

Used by: FunctioningProfile

difficulty_hearing

string · functional-difficulty-severity

The degree of difficulty the person experiences hearing, even when using a hearing aid. Applies to adults (WG-SS) and to children ages 2-17 (CFM).

Used by: FunctioningProfile

difficulty_hearing_noisy_room

string · functional-difficulty-severity

The degree of difficulty the person experiences hearing what is said in a conversation with one other person in a noisier room, with their hearing aid…

Used by: FunctioningProfile

difficulty_hearing_quiet_room

string · functional-difficulty-severity

The degree of difficulty the person experiences hearing what is said in a conversation with one other person in a quiet room, with their hearing aid i…

Used by: FunctioningProfile

difficulty_learning

string · functional-difficulty-severity

The degree of difficulty the child experiences learning to do things, compared to children of the same age. Applies to children ages 2-17 (CFM).

Used by: FunctioningProfile

difficulty_making_friends

string · functional-difficulty-severity

The degree of difficulty the child experiences making friends. Applies to children ages 5-17 (CFM).

Used by: FunctioningProfile

difficulty_playing

string · functional-difficulty-severity

The degree of difficulty the child experiences playing, compared to children of the same age. Applies to children ages 2-4 (CFM).

Used by: FunctioningProfile

difficulty_remembering

string · functional-difficulty-severity

The degree of difficulty the child experiences remembering things. Applies to children ages 5-17 (CFM). Paired with difficulty_concentrating; the WG-S…

Used by: FunctioningProfile

difficulty_seeing

string · functional-difficulty-severity

The degree of difficulty the person experiences seeing, even when wearing glasses or contact lenses. Applies to adults (WG-SS) and to children ages 2-…

Used by: FunctioningProfile

difficulty_seeing_coin

string · functional-difficulty-severity

The degree of difficulty the person experiences seeing something held at arm's length, such as a coin in the palm of their hand, even when wearing gla…

Used by: FunctioningProfile

difficulty_seeing_face_across_room

string · functional-difficulty-severity

The degree of difficulty the person experiences seeing the face of someone across a room, even when wearing glasses if they use them. Applies to adult…

Used by: FunctioningProfile

difficulty_self_care

string · functional-difficulty-severity

The degree of difficulty the person experiences with self-care, such as washing all over or dressing. Applies to adults (WG-SS) and to children ages 5…

Used by: FunctioningProfile

difficulty_understanding_others

string · functional-difficulty-severity

The degree of difficulty the child has understanding others (receptive communication), compared to children of the same age. Applies to children ages …

Used by: FunctioningProfile

difficulty_upper_body_fine_motor

string · functional-difficulty-severity

The degree of difficulty the person experiences using their hands and fingers, such as picking up small objects (for example, a button or pencil) or o…

Used by: FunctioningProfile

difficulty_upper_body_reach

string · functional-difficulty-severity

The degree of difficulty the person experiences raising a 2-litre bottle of water from waist to eye level. Applies to adults (WG-ES UB_1).

Used by: FunctioningProfile

difficulty_walking

string · functional-difficulty-severity

The degree of difficulty the person experiences walking or climbing steps. Applies to adults (WG-SS) and to children ages 2-17 (CFM).

Used by: FunctioningProfile

difficulty_walking_100m

string · functional-difficulty-severity

The degree of difficulty the person experiences walking 100 metres (about the length of a football field) on level ground, without using any aid. Appl…

Used by: FunctioningProfile

difficulty_walking_500m

string · functional-difficulty-severity

The degree of difficulty the person experiences walking 500 metres (about a third of a mile) on level ground, without using any aid. Applies to adults…

Used by: FunctioningProfile

disability_domains_identified

string · multiple · wg-ss-domain

The WG-SS core domains in which the person reports 'a lot of difficulty' or 'cannot do at all'. Populated only when disability_identified is true. Val…

Used by: FunctioningProfile

disability_identified

boolean

Whether the person meets the WG recommended disability identifier: at least one of the six core domains (seeing, hearing, walking, cognition, self-car…

Used by: FunctioningProfile

displacement_status

string · displacement-status

The legal, administrative, or protection status of the person with respect to displacement and migration.

Used by: Person

document_type

string · document-type

The category of identity document (passport, national ID card, beneficiary card, etc.).

Used by: IdentityDocument

domicile

concept:Address

The place that the person treats as their permanent home, which may differ from the address of their current household.

Used by: Person

dpo_contact

string

Contact details (email, phone, postal) for the data protection officer or equivalent privacy-contact role of the controller(s). Free-form string; typi…

Used by: PrivacyNotice

dwelling_type

string · dwelling-type

The type of dwelling occupied by the household (e.g., permanent structure, temporary shelter, shared housing).

Used by: SocioEconomicProfile

education_level

string · education-level

The highest level of formal education completed by a person.

Used by: crvs/Person, Person

effective_date

date

The date on which this record or notice becomes operative. On a ConsentRecord, it may be later than signed_date (the day the data subject indicated co…

Used by: ConsentRecord, PrivacyNotice

electricity_access

boolean

Whether the household has access to electricity from any source.

Used by: SocioEconomicProfile

eligibility_status

string · sp/eligibility-status

The outcome of the eligibility determination.

Used by: sp/EligibilityDecision

email_address

string

An email address through which the person can be contacted.

Used by: Person

employment_status

string · employment-status

The labour force participation status of the person: whether they are employed, unemployed, or outside the labour force.

Used by: crvs/Person, Person

end_date

date

The date on which this ceased to be effective.

Used by: sp/BenefitSchedule, GroupMembership, HazardEvent, sp/Program, Relationship

enrollment_date

date

The date on which the enrollment became active and benefit delivery was authorized.

Used by: sp/Enrollment

enrollment_ref

uri

Reference to the enrollment to which this entitlement belongs.

Used by: sp/Entitlement, InKindDelivery, PaymentEvent

enrollment_status

string · sp/enrollment-status

The current lifecycle state of the enrollment.

Used by: sp/Enrollment

entitlement_ref

uri

Reference to the entitlement that this payment or voucher fulfills.

Used by: InKindDelivery, PaymentEvent, Voucher

ethnic_group

string

The ethnic or cultural group of the person, as self-identified. The UNSD recommends nationally defined categories based on self-identification; no int…

Used by: crvs/Person, Person

evaluation_date

date

The date on which a scoring rule was applied to produce a score or band.

Used by: ScoringEvent

evaluator

concept:Agent

The agent (field officer or agency) accountable for the scoring. Typically a Person or an Organization. When the computation was executed by software,…

Used by: ScoringEvent

evidence_ref

string · multiple

References to the evidence artefact(s) backing this record. Values are typically URIs (for example, a signed object-store URL) but a local identifier …

Used by: ConsentRecord

exception_reason

string · biometric-exception-reason

The reason a biometric sample could not be captured. When non-null, this record documents a capture exception rather than holding biometric data.

Used by: BiometricSample

exit_date

date

The date the enrollment ceased to be active, whether through closure or graduation. Does not apply to temporary suspension.

Used by: sp/Enrollment

exit_reason

string · sp/enrollment-exit-reason

The reason the enrollment was permanently closed. Applies when enrollment status is closed, not when graduated.

Used by: sp/Enrollment

expiry_date

date

The date on which this record or document expires or becomes invalid.

Used by: ConsentRecord, IdentityDocument, PrivacyNotice, Voucher

external_id

string · multiple

Identifiers assigned by external systems (CRM, case management, etc.). Multiple allowed because a record may carry identifiers from several systems.

Used by: ConsentRecord

facility_level

string · health-facility-level

The tier of care provided per national/WHO classification (primary, secondary, tertiary, quaternary).

Used by: HealthFacility

facility_type

string · health-facility-type

The functional category of a health facility per WHO SARA/HHFA (hospital, health center, health post, etc.).

Used by: HealthFacility

failure_reason

string

A description of why the payment failed, was returned, or was rejected.

Used by: PaymentEvent

family_name

string

The family (last) name or surname of the person.

Used by: Person

family_name_at_birth

string

The family name of the person at the time of birth, before any change due to marriage or other legal event.

Used by: Person

farm_area_hectares

decimal

The total area of the farm in hectares.

Used by: Farm

fatigue_duration

string · daily-duration

How much of the day the person felt tired or exhausted the last time they felt this way. Applies to adults (WG-ES TIRED_2). Asked of respondents who r…

Used by: FunctioningProfile

fatigue_frequency

string · symptom-period-frequency

How often the person has felt tired or exhausted during the past 3 months. Applies to adults (WG-ES TIRED_1).

Used by: FunctioningProfile

fatigue_intensity

string · functional-intensity

The intensity of the tiredness or exhaustion the person felt the last time they felt this way. Applies to adults (WG-ES TIRED_3). Asked of respondents…

Used by: FunctioningProfile

floor_material

string · floor-material

The primary material of the floor in the household's dwelling.

Used by: SocioEconomicProfile

food_security_level

string · food-security-level

A coarse current-state summary of the household's food insecurity, used by operational systems for targeting and referral queries. This is NOT the raw…

Used by: Household, SocioEconomicProfile

formation_date

date

The date on which this group was formed or registered.

Used by: Group

frequency

string · sp/benefit-frequency

How often the entitlement is delivered (monthly, quarterly, annual, one-time).

Used by: sp/BenefitSchedule

frequency_rule

string

An iCalendar recurrence rule (RFC 5545 RRULE) specifying a custom schedule. Used when the frequency property is set to 'custom'.

Used by: sp/BenefitSchedule

full_address

string

The complete address written as a single text string. Coexists with structured address components for systems that store addresses as free text.

Used by: Address

functioning_status

string · functional-difficulty-severity

A coarse current-state summary of the person's functioning difficulty, used by operational systems for targeting and eligibility queries. This is NOT …

Used by: Person

gender

string · gender-type

The gender of the person as recorded in a social protection registry or identity document.

Used by: Person

geocodes

concept:Identifier · multiple

Administrative or statistical codes that identify this area within a coding system (FIPS, P-code, postal code, etc.).

Used by: Location

geometry

geojson_geometry

The geographic boundary or shape, expressed as a GeoJSON Geometry object (Point, Polygon, MultiPolygon, etc.).

Used by: Location

given_name

string

The given (first) name of the person.

Used by: Person

given_name_at_birth

string

The given name of the person at the time of birth, before any legal name change.

Used by: Person

group

concept:Group

The group to which the person belongs.

Used by: GroupMembership

group_memberships

concept:GroupMembership · multiple

Group memberships held by this person, linking them to households, families, or other groups.

Used by: Person

group_type

string · group-type

An interoperability classifier for the category of group record being exchanged or exported. In native PublicSchema modeling, the concrete Group subty…

Used by: Group

hazard_type

string · hazard-type

The category of hazard or disruptive event.

Used by: HazardEvent

hearing_aid_use_frequency

string · aid-use-frequency

How often the person uses their hearing aid. Applies to adults (WG-ES HEAR_3, flagged OPTIONAL in the WG-ES instrument). Asked of respondents who repo…

Used by: FunctioningProfile

house_number

string

The house, building, or plot number within a street or road.

Used by: Address

household_assets

string · multiple · household-asset

Durable goods owned by the household, used as wealth proxy indicators in targeting and proxy means testing.

Used by: SocioEconomicProfile

ict_access

string · multiple · ict-access

Information and communication technology devices and services accessible to the household.

Used by: SocioEconomicProfile

identifier

string

A unique identifier for this record (e.g., a ULID, UUID, or program-assigned ID). Scoped to the record's namespace; not necessarily globally unique.

Used by: ConsentRecord, PrivacyNotice

identifier_scheme_id

string

A URI or code that identifies the scheme or system under which the identifier was assigned.

Used by: Identifier

identifier_scheme_name

string

The human-readable name of the identifier scheme, such as 'National Identity Number' or 'Social Security Number'.

Used by: Identifier

identifier_type

string · identifier-type

The category of identifier value (for example, national ID number, passport number, P-code).

Used by: Identifier

identifier_value

string

The alphanumeric value of the identifier as issued or recorded.

Used by: Identifier

identifiers

concept:Identifier · multiple

Identifiers carried by this entity, such as national ID numbers, program IDs, or identifiers asserted by an identity document.

Used by: crvs/CivilStatusRecord, ConsentRecord, Event, IdentityDocument, Organization, Party, PrivacyNotice, ServicePoint

identity_documents

concept:IdentityDocument · multiple

Identity documents held by this party, such as passports, national identity cards, civil registration certificates, and program-issued beneficiary car…

Used by: Party

impression_type

string · impression-type

The method by which a fingerprint biometric was captured (e.g., live scan plain, rolled, latent).

Used by: BiometricSample

income_source

string · income-source

The primary reported source of income for the household, used in targeting and proxy means testing.

Used by: SocioEconomicProfile

indicated_by

concept:Agent

The agent (usually a Person, sometimes a SoftwareAgent) who indicated the consent act. For self-consent, the same Person as 'data_subject'. For delega…

Used by: ConsentRecord

industry

string

The branch of economic activity in which the person works, classified according to the International Standard Industrial Classification (ISIC Rev.4). …

Used by: crvs/Person, Person

inputs

concept:Profile · multiple

The profile records that provided the data scored in this scoring event. A PMT scoring event typically takes a SocioEconomicProfile as input; a Washin…

Used by: ScoringEvent

instrument_used

concept:Instrument

Reference to the instrument (survey form, questionnaire, screening protocol, measurement procedure) administered in this profile record.

Used by: Profile

is_active

boolean

Whether the membership or relationship is currently in effect, as opposed to expired, suspended, or terminated.

Used by: GroupMembership

is_reconciled

boolean

Whether this payment has been matched and verified against financial system records.

Used by: PaymentEvent

issue_date

date

The date on which this record or document was issued.

Used by: crvs/Certificate, crvs/CivilStatusDocument, IdentityDocument, Voucher

issued_to

concept:Party

The party (person, household, or group) to whom the document, voucher, or credential is issued.

Used by: IdentityDocument, Voucher

issuing_authority

string

The organization or government body that issued the document or credential.

Used by: crvs/CivilStatusDocument, IdentityDocument

issuing_jurisdiction

string

The geographic jurisdiction under which the document or credential was issued, expressed as an ISO 3166-2 subdivision code or ISO 3166-1 country code.…

Used by: IdentityDocument

item_set

string · multiple

The property IDs that an instrument expects to be populated when administered in full. Declared once on the Instrument registry entry; individual Prof…

Used by: Instrument

items

concept:DeliveryItem · multiple

The list of commodity line items in this delivery or voucher.

Used by: InKindDelivery, VoucherRedemption, Voucher

items_asked

string · multiple

The PublicSchema property IDs that were actually asked during this administration. Lets adopters distinguish items that were asked and declined (answe…

Used by: Profile

joint_controller_arrangement_ref

string

Reference to the joint-controllership arrangement between the parties listed in `controllers` (GDPR Art 26). Typically a URI to a published arrangemen…

Used by: ConsentRecord

jurisdiction

string · country

ISO 3166-1 alpha-2 country code of the jurisdiction whose data protection law governs this record. Cardinality single: multi-jurisdictional records ar…

Used by: ConsentRecord, PrivacyNotice, RegistrationOffice

land_tenure

string · land-tenure

The legal or customary tenure arrangement under which the farm's land is held.

Used by: Farm

language_of_administration

string · multiple · language

The language(s) in which the instrument was administered to the subject. Washington Group analytical guidance notes that translation fidelity affects …

Used by: Instrument

latitude

decimal

The geographic latitude in decimal degrees (WGS84).

Used by: Location

legal_basis

string · multiple · legal-basis

The legal basis under GDPR Art 6(1) (or equivalent law) authorizing the processing. Cardinality multiple because a single record may rely on more than…

Used by: ConsentRecord, PrivacyNotice

legal_basis_reference

string · multiple

Jurisdiction-specific legal reference (e.g., a national act, article, or case citation) supporting `legal_basis`. Free-form string; use per-jurisdicti…

Used by: ConsentRecord

level_name

string

The country-specific name for this administrative tier (e.g., state, department, commune, ward).

Used by: Location

literacy

string · literacy

Whether the person can, with understanding, both read and write a short simple statement on everyday life.

Used by: crvs/Person, Person

livestock_type

string · multiple · livestock-type

Types of livestock kept by the agricultural holding.

Used by: Farm

located_at

concept:Location

The administrative or geographic location where this service point sits.

Used by: ServicePoint

location

concept:Location

The geographic location of the subject of this record, captured as coordinates or administrative area.

Used by: Address, Farm, Household, Organization

location_name

string

A human-readable place name for the location.

Used by: Location

longitude

decimal

The geographic longitude in decimal degrees (WGS84).

Used by: Location

managed_by

concept:Organization

The organization that operates or manages this service point (government agency, NGO, UN agency, private provider).

Used by: ServicePoint

marital_status

string · marital-status

The marital or civil status of a person as recorded in an administrative system.

Used by: crvs/Person, Person

matronymic_name

string

A name derived from the given name of the person's mother.

Used by: Person

member_count

integer

The total number of members in this household or group.

Used by: Group

memberships

concept:GroupMembership · multiple

The membership links connecting persons to this group, each carrying role and lifecycle dates.

Used by: Group

mobility_aid_types

string · multiple · mobility-aid-type

The specific types of mobility equipment or assistance the person uses, as recorded by the WG-ES MOB_3 multi-select checklist. Multiple values may be …

Used by: FunctioningProfile

name

string

The full display name of the record. Depending on the concept, this is a person's or group's name, or the title of a program, instrument, scoring rule…

Used by: Instrument, Organization, Party, PrivacyNotice, sp/Program, ScoringRule, ServicePoint, SoftwareAgent

nationality

string · country

The country of citizenship or nationality, expressed as an ISO 3166-1 alpha-2 code where possible.

Used by: crvs/Person, Person

notice_presentation_language

string · language

The ISO 639-3 language code in which the notice was presented to the data subject at the time of consent. Field-critical: populate even if the UI does…

Used by: ConsentRecord

notice_ref

concept:PrivacyNotice

The PrivacyNotice record that was presented to the data subject at the time of consent. Anchors the record to a specific notice version.

Used by: ConsentRecord

notice_version

string

Denormalized snapshot of the PrivacyNotice `version` at the time of consent. Pinned by design: if the PrivacyNotice is later corrected or reversioned,…

Used by: ConsentRecord

number_of_spouses

integer

The number of current spouses the person has. Captures polygamous or polyandrous union type separately from marital status, following the UN census fr…

Used by: Person

nutrition_status

string · acute-malnutrition-severity

A coarse current-state summary of the person's acute malnutrition status, used by operational systems for targeting and referral queries. This is NOT …

Used by: Person

object_person

concept:Person

The person to whom the subject person is related (the object of the relationship statement).

Used by: Relationship

observation_date

date

The date on which the profile data was collected (when the instrument was administered or the measurement taken).

Used by: Profile

occupation

string · occupation

The person's primary occupation, classified according to the ISCO-08 sub-major groups.

Used by: crvs/Person, Person

operational_status

string · facility-operational-status

Whether the service point is currently operational, partially operational, or non-functional.

Used by: ServicePoint

pain_frequency

string · symptom-period-frequency

How often the person has experienced pain during the past 3 months. Applies to adults (WG-ES PAIN_1).

Used by: FunctioningProfile

pain_intensity

string · functional-intensity

The intensity of the person's pain the last time they had pain. Applies to adults (WG-ES PAIN_2). Asked of respondents who reported pain at least some…

Used by: FunctioningProfile

parent_location

concept:Location

The parent location in the administrative hierarchy.

Used by: Location

patronymic_name

string

A name derived from the given name of the person's father or a paternal ancestor, used in naming conventions where patronymics are a distinct componen…

Used by: Person

payment_amount

decimal

The monetary value of this payment.

Used by: PaymentEvent

payment_currency

string · currency

The ISO 4217 currency code for this payment.

Used by: PaymentEvent

payment_date

date

The date on which the payment was made or processed.

Used by: PaymentEvent

payment_status

string · payment-status

The processing state of the payment.

Used by: PaymentEvent

performed_by

concept:Agent

The agent (enumerator, field officer, or agency) accountable for administering the instrument or taking the measurement. Typically a Person or an Orga…

Used by: Profile

person

concept:Person

A reference to the individual Person this record relates to.

Used by: BiometricSample, crvs/CivilStatusRecord, crvs/Person, GroupMembership

personal_data_categories

uri · multiple

Values are W3C DPV URIs, normatively subclasses of `dpv:PersonalData` (from the DPV core; the DPV-PD extension defines finer taxa). Cross-reference: t…

Used by: ConsentRecord, PrivacyNotice

phone_number

string

A contact phone number for the person, including country code.

Used by: Person

postal_code

string

The postal or zip code of the address.

Used by: Address

preferred_language

string · language

The preferred language of communication for a person, using ISO 639-3 codes.

Used by: Person

preferred_name

string

The name a person is commonly known by, when it differs from their legal name. Covers chosen names, professional names, and naming conventions where g…

Used by: Person

pregnancy_status

string · pregnancy-status

The current pregnancy status of the person.

Used by: Person

pregnant_or_lactating_count

integer

The number of pregnant or lactating women currently living in the household. Used by humanitarian programs to size nutrition, health, and protection i…

Used by: Household

primary_crop

string

The primary crop or agricultural activity of the farm.

Used by: Farm

processing_operations

uri · multiple

Values are W3C DPV URIs, normatively subclasses of `dpv:Processing` (e.g., `dpv:Collect`, `dpv:Store`, `dpv:Share`). Describes the operations being co…

Used by: ConsentRecord, PrivacyNotice

publication_url

uri

A canonical URL where the instrument, software agent, or scoring rule is published (typically a documentation page, a source repository, or a PDF host…

Used by: Instrument, ScoringRule, SoftwareAgent

publisher

concept:Agent

The agent that publishes or maintains the instrument, software agent, or scoring rule. Typically an Organization (for example, the Washington Group on…

Used by: Instrument, SoftwareAgent

purposes

uri · multiple

Values are W3C DPV URIs, normatively subclasses of `dpv:Purpose` (e.g., `dpv:ServiceProvision`, `dpv:ResearchAndDevelopment`). Each URI identifies a p…

Used by: ConsentRecord, PrivacyNotice

quality_algorithm

string

The algorithm or standard used to compute the quality score (e.g., NFIQ2, ISO_29794_4).

Used by: BiometricSample

quality_score

integer

A quality score for the biometric sample, on a 0-100 scale per ISO 29794-1. Higher values indicate better quality.

Used by: BiometricSample

quantity

decimal

The amount of a commodity in the specified unit of measure.

Used by: DeliveryItem

quantity_redeemed

decimal

The amount of this commodity that has been redeemed or collected so far.

Used by: DeliveryItem

raw_score

decimal

The numeric score produced by the assessment instrument.

Used by: ScoringEvent

receiving_program

string

Reference to the program or organization to which the referral is directed.

Used by: sp/Referral

recipient

concept:Party

The person or group that received or is intended to receive the payment. The recipient may differ from the enrolled beneficiary, for example when a gu…

Used by: InKindDelivery, PaymentEvent

recipient_categories

string · multiple · organization-type

Categories of recipients described to the data subject in the notice. PrivacyNotice-scoped: the notice describes categories; the ConsentRecord names s…

Used by: PrivacyNotice

recipient_role

string · multiple · recipient-role

The role each recipient plays: processor, joint-controller, independent-controller, or sub-processor. Known limitation: v1 uses positional alignment w…

Used by: ConsentRecord

recipients

concept:Organization · multiple

Organizations that receive the data or its derivatives. Includes processors, joint controllers, and independent controllers. See the parallel property…

Used by: ConsentRecord

recipients_described

string

Free-prose description of recipients used in the notice, complementing the coded 'recipient_categories'. Enables the notice to describe a recipient th…

Used by: PrivacyNotice

redeemable_by

concept:Party · multiple

The person or group authorized to redeem this voucher on behalf of the beneficiary.

Used by: Voucher

redeemed_by

concept:Person

The person who presented the voucher for redemption.

Used by: VoucherRedemption, Voucher

redemption_agent

string

The merchant, vendor, or agent who accepted the voucher for redemption.

Used by: VoucherRedemption, Voucher

redemption_date

date

The date on which the voucher was redeemed at a vendor or agent.

Used by: VoucherRedemption, Voucher

referral_date

date

The date on which the referral was made.

Used by: sp/Referral

referral_reason

string

A free-text explanation of why the person or household was referred from one program to another.

Used by: sp/Referral

referral_status

string · sp/referral-status

The current state of the referral (pending, accepted, declined, completed).

Used by: sp/Referral

referred_person

concept:Person

The person who is being referred.

Used by: sp/Referral

referring_program

string

Reference to the program or organization making the referral.

Used by: sp/Referral

refusal_reason

string

Free-form reason for refusal when the data subject declined to consent (status = refused). Distinct from withdrawal_reason, which applies after consen…

Used by: ConsentRecord

registration_office_type

string · registration-office-type

The functional category of a registration office (civil registration office, district branch, mobile unit, refugee registration center, or identity en…

Used by: RegistrationOffice

relationship_type

string · relationship-type

The nature of the relationship between two persons (e.g., spouse, parent, child, sibling, guardian, caregiver).

Used by: Relationship

religion

string

The religion, religious denomination, or sect of the person, as self-identified. No international classification exists; countries define their own va…

Used by: crvs/Person, Person

remembering_extent

string · cognition-remembering-extent

How much the person forgets: a few things, a lot of things, or almost everything. Applies to adults (WG-ES COG_4). Asked of respondents who reported r…

Used by: FunctioningProfile

remembering_frequency

string · symptom-chronicity

How often the person has difficulty remembering. Applies to adults (WG-ES COG_3). Asked of respondents who reported remembering difficulty.

Used by: FunctioningProfile

resolution_date

date

The date on which a resolution decision was issued for the grievance.

Used by: sp/Grievance

respondent

concept:Person

The person who provided the answers to the instrument, when different from the subject. Required whenever the administration mode is proxy or assisted…

Used by: Profile

respondent_relationship

string · relationship-type

The relationship of the respondent to the subject (parent, spouse, guardian, caregiver, etc.). Uses relationship-type because it describes a person-to…

Used by: Profile

retention_description

string

PrivacyNotice-only. Prose description of the retention period for personal data (GDPR Art 13(2)(a)). Use when the period cannot be expressed as a fixe…

Used by: PrivacyNotice

rights_description

string

PrivacyNotice-only. Prose description of the data subject's rights (access, rectification, erasure, objection, portability, restriction of processing,…

Used by: PrivacyNotice

role

string · group-role

The role recorded for the person within the group membership. Applicable values depend on the kind of group (for example head, spouse, child, owner, o…

Used by: GroupMembership

roof_material

string · roof-material

The primary material of the roof in the household's dwelling.

Used by: SocioEconomicProfile

rule_applied

concept:ScoringRule

Reference to the scoring rule that was applied in this scoring event.

Used by: ScoringEvent

sample_format

string

The MIME type of the biometric sample data (e.g., image/jp2, image/jpeg, application/octet-stream).

Used by: BiometricSample

sample_uri

string

A URI reference to the biometric sample data. The referenced resource contains the actual biometric data (image, audio, or other signal).

Used by: BiometricSample

sanitation_facility

string · sanitation-facility

The type of toilet or sanitation facility used by the household.

Used by: SocioEconomicProfile

sanitation_service_level

string · sanitation-service-level

The WHO/UNICEF JMP classification of the household's sanitation service. Derived from facility type and sharing status; not directly observed.

Used by: SocioEconomicProfile

sanitation_shared_households

integer

Number of households sharing the sanitation facility. Zero or null indicates an unshared (private) facility. Any value greater than zero indicates a s…

Used by: SocioEconomicProfile

schema_version

uri

Identifies the version of the PublicSchema (or other) consent record schema this instance conforms to. Enables forward migration tooling. Typically a …

Used by: ConsentRecord, PrivacyNotice

school_level_served

string · multiple · school-level

The ISCED 2011 education level(s) served by this school. A school covering multiple levels (e.g., combined primary and lower secondary) should list al…

Used by: School

school_type

string · school-type

The management and funding classification of a school (public, private, faith-based, or community), per UNESCO UIS categories.

Used by: School

scoring_method

string

The computational approach used to generate a welfare score from collected data.

Used by: ScoringRule

serial_number

string

A public identifier for the voucher, printed on the physical document or communicated via SMS or application.

Used by: Voucher

service_point_type

string · service-point-type

The category of service this point provides (health, education, distribution, WASH, etc.).

Used by: ServicePoint

settlement_type

string · settlement-type

The classification of the area where the household is located by degree of urbanization.

Used by: SocioEconomicProfile

severity

string · event-severity

The observed or expected severity of the event's impact.

Used by: HazardEvent

sex

string · sex

The biological sex of a person as recorded in an official register or identity document.

Used by: Person

signed_date

date

The day the data subject indicated consent. For paper workflows, the day the paper form was signed; for witnessed verbal, the day of the verbal indica…

Used by: ConsentRecord

software_used

concept:SoftwareAgent

The software that performed this step, recorded so the result can be reproduced or audited. Distinct from the accountable evaluator or performer (the …

Used by: sp/EligibilityDecision, Profile, ScoringEvent

source_of_data

string

PrivacyNotice-only. Prose description of the source(s) from which personal data is obtained when not collected directly from the data subject (GDPR Ar…

Used by: PrivacyNotice

special_category_basis

string · multiple · special-category-basis

When `personal_data_categories` includes a special category (GDPR Art 9 / `dpv:SpecialCategoryPersonalData`), this property identifies the Art 9(2) ba…

Used by: ConsentRecord, PrivacyNotice

start_date

date

The date on which this became effective.

Used by: sp/BenefitSchedule, GroupMembership, HazardEvent, sp/Program, Relationship

status

string · consent-status

The current lifecycle state of the record: requested, given, renewed, refused, withdrawn, revoked, expired, invalidated, or unknown. Transitions follo…

Used by: ConsentRecord

status_in_employment

string · status-in-employment

The type of employment relationship: whether the person is an employee, employer, own-account worker, contributing family worker, or cooperative membe…

Used by: crvs/Person, Person

storage_duration_days

integer

Planned storage duration for the personal data covered by this record, expressed in days. Drives retention logic in downstream systems. Zero means: do…

Used by: ConsentRecord, PrivacyNotice

street_address

string

The street name, number, and any apartment or building identifiers.

Used by: Address

subject

concept:Party

The person or group that the profile or scoring event is about. Ranged at Party (not Agent) because Profiles observe receivers: persons and organised …

Used by: Profile, ScoringEvent

subject_person

concept:Person

The person who holds the described relationship (the subject of the relationship statement).

Used by: Relationship

submission_date

date

The date on which the grievance was submitted or registered.

Used by: sp/Grievance

supersedes_ref

concept:PrivacyNotice

PrivacyNotice-only. The prior notice version that this notice replaces. Enables tracing the notice evolution chain. A re-consent campaign is triggered…

Used by: PrivacyNotice

transfer_description

string

PrivacyNotice-only. Prose description of international or third-country data transfers (GDPR Chapter V). Free-form; should name destination countries,…

Used by: PrivacyNotice

unit_of_measure

string · unit-of-measure

The unit in which the quantity is expressed.

Used by: DeliveryItem

uses_glasses

boolean

Whether the person wears glasses or contact lenses. Applies to adults (WG-ES VIS_1) and to children (CFM CF1). This filter is used to interpret diffic…

Used by: FunctioningProfile

uses_hearing_aid

boolean

Whether the person uses a hearing aid. Applies to adults (WG-ES HEAR_1) and to children (CFM CF4). This filter is used to interpret difficulty_hearing…

Used by: FunctioningProfile

uses_mobility_aid

boolean

Whether the person uses equipment or receives assistance for getting around, such as a cane, walker, wheelchair, or help from another person. Applies …

Used by: FunctioningProfile

uses_sign_language

boolean

Whether the person uses sign language as a communication method. Applies to adults (WG-ES COM_2). This filter captures the communication modality used…

Used by: FunctioningProfile

valid_until

date

The date until which the eligibility decision remains valid.

Used by: sp/EligibilityDecision

verified_by

concept:Person

Person who verified the consent record (for example, a case worker reviewing a scanned paper form, or an auditor confirming a sample of records). Dist…

Used by: ConsentRecord

verified_date

date

Date of the verification act performed by verified_by. Typically after signed_date.

Used by: ConsentRecord

version

string

The version identifier of an artefact such as an instrument, software agent, scoring rule, or privacy notice (for example, a release date such as 2022…

Used by: Instrument, PrivacyNotice, SoftwareAgent

voucher_format

string · voucher-format

The physical or digital form of the voucher.

Used by: Voucher

voucher_ref

concept:Voucher

A reference to the voucher that this record relates to.

Used by: VoucherRedemption

voucher_status

string · voucher-status

The lifecycle state of the voucher.

Used by: Voucher

wall_material

string · wall-material

The primary material of the exterior walls in the household's dwelling.

Used by: SocioEconomicProfile

water_collection_time_minutes

integer

Round-trip time in minutes to the household's main drinking water source, including queuing. JMP classifies an improved source with collection time of…

Used by: SocioEconomicProfile

water_point_type

string · water-point-type

The physical type of this water access point per the WHO/UNICEF JMP improved-source typology (borehole, protected dug well, public tap, etc.). The wat…

Used by: WaterPoint

water_service_level

string · water-service-level

The WHO/UNICEF JMP classification of the household's drinking water service. Derived from water source type and collection time; not directly observed…

Used by: SocioEconomicProfile, WaterPoint

water_source

string · water-source

The main source of drinking water used by the household.

Used by: SocioEconomicProfile

withdrawal_channel

string · withdrawal-channel

The channel through which the data subject withdrew consent: web, mobile, api, paper, verbal, in-person-office, community-worker, or other. Recorded w…

Used by: ConsentRecord

withdrawal_description

string

PrivacyNotice-only. Prose description of how the data subject can withdraw consent. Should reference withdrawal_uri if available, and describe any pap…

Used by: PrivacyNotice

withdrawal_reason

string

Free-form reason for withdrawal, if disclosed by the data subject. The data subject is not required to give a reason; this field exists for when they …

Used by: ConsentRecord

withdrawal_uri

uri

URI exposed to the data subject for self-service withdrawal of consent. Required by GDPR Art 7(3) ('it shall be as easy to withdraw as to give consent…

Used by: ConsentRecord

witnessed_by

concept:Person · multiple

Persons who witnessed the data subject's indication of consent. Field-critical for verbal consent ('collection_medium = verbal') and for biometric-as-…

Used by: ConsentRecord

benefit_description

string

A free-text description of the specific benefit.

Used by: sp/BenefitSchedule, sp/Entitlement

benefit_modality

string · multiple · sp/benefit-modality

The form of benefit the entitlement specifies (cash, voucher, in-kind, service, fee waiver).

Used by: sp/BenefitSchedule, sp/Entitlement

complainant

concept:Person

The person who submitted the grievance. The complainant need not be the enrolled beneficiary; community members, rejected applicants, or caretakers ma…

Used by: sp/Grievance

conditionality_type

string · sp/conditionality-type

Whether the program requires beneficiaries to meet behavioral conditions to receive benefits (unconditional, conditional, soft conditional, labelled).…

Used by: sp/Program

coverage_area

concept:Location

The geographic or administrative scope of program coverage.

Used by: sp/Program

coverage_period_end

date

The end date of the period this entitlement covers.

Used by: sp/Entitlement

coverage_period_start

date

The start date of the period this entitlement covers.

Used by: sp/Entitlement

document_expiry_date

date

The date on which the document or credential representing the entitlement expires, which may differ from the entitlement period itself.

Used by: sp/Entitlement

eligibility_decision_ref

uri

Reference to the eligibility decision that authorized this enrollment.

Used by: sp/Enrollment

entitlement_status

string · sp/entitlement-status

The lifecycle state of this entitlement instance.

Used by: sp/Entitlement

governing_jurisdiction

string

The country or subdivision whose legislation governs this enrollment. Implicit in domestic programs, but must be explicit in cross-border or federated…

Used by: sp/Enrollment

grievance_status

string · sp/grievance-status

The current processing state of the grievance.

Used by: sp/Grievance

grievance_subject

string

The identifier, URI, or local reference for the person, enrollment, payment event, or other record that the grievance concerns.

Used by: sp/Grievance

grievance_type

string · sp/grievance-type

The primary category of issue recorded for the grievance, such as an appeal, payment complaint, correction request, or misconduct allegation.

Used by: sp/Grievance

implementing_agency

string

The government ministry or organization responsible for program administration.

Used by: sp/Program

is_enrolled

boolean

Whether the person is currently enrolled in a program. Designed for verifiable credentials where enrollment status must be disclosed without revealing…

Used by: sp/Enrollment

program_ref

uri

A link to the program under which this enrollment, entitlement, eligibility decision, or benefit schedule exists.

Used by: sp/BenefitSchedule, sp/EligibilityDecision, sp/Enrollment

schedule_ref

uri

Reference to the benefit schedule that this entitlement corresponds to.

Used by: sp/Entitlement

targeting_approach

string · sp/targeting-approach

The method used to identify eligible beneficiaries.

Used by: sp/Program

adoptee

concept:crvs/Person

The person being adopted in an adoption event. Typically a minor, but adult adoption exists in some jurisdictions.

Used by: crvs/Adoption

adoption_type

string · crvs/adoption-type

Whether the adoption is full (biological filiation is entirely replaced) or simple (biological filiation is preserved alongside the new parental link)…

Used by: crvs/Adoption

adoptive_parents

concept:crvs/Parent · multiple

The parents who acquire parental rights through the adoption, each captured as a Parent link entity with parental_role set to adoptive.

Used by: crvs/Adoption

age_at_event

integer

The stated age of the person at the time of the vital event. Used in low-completeness settings where date of birth is unknown and stated age is the on…

Used by: crvs/Person

annotating_authority

concept:Location

The civil registration office that added the annotation to the record. May differ from the office that issued the original record if the person has mo…

Used by: crvs/CivilStatusAnnotation

annotation_date

date

The date on which the annotation was added to the civil status record. Typically after the originating record was created, reflecting a later vital ev…

Used by: crvs/CivilStatusAnnotation

annotation_text

string

The full text of the marginal annotation as recorded on the civil status record. Preserves the exact wording used by the registration authority.

Used by: crvs/CivilStatusAnnotation

annotation_type

string · crvs/annotation-type

The category of annotation: a court-ordered correction, a nationality change, or similar administrative modifications to the record's meaning.

Used by: crvs/CivilStatusAnnotation

annotations

concept:crvs/CivilStatusAnnotation · multiple

Marginal annotations (mentions marginales) added to a civil status record over time as subsequent vital events occur, such as a marriage noted on a bi…

Used by: crvs/CivilStatusRecord

attendant_at_birth

string · crvs/birth-attendant

The type of person who attended the delivery (physician, midwife, nurse, traditional birth attendant, other, or none). Used as a proxy for safe delive…

Used by: crvs/Birth, crvs/FetalDeath

birth_order

integer

For multiple births, the sequence number of this infant among the siblings born in the same delivery (1 for first-born, 2 for second-born, etc.).

Used by: crvs/Birth

birth_ref

concept:crvs/Birth

A reference to the Birth record of the child whose parentage is being recognized, legitimized, or otherwise modified. Links the current event back to …

Used by: crvs/Legitimation, crvs/PaternityRecognition

birth_type

string · crvs/birth-type

Whether the birth was single, twin, triplet, or higher-order multiple. Captured at the level of the delivery, not per infant.

Used by: crvs/Birth

cause_of_death

string

A free-text description of the underlying cause of death as stated on the death certificate. Captured alongside a coded cause_of_death_code when class…

Used by: crvs/Death

cause_of_death_code

string

The coded underlying cause of death, typically an ICD-10 or ICD-11 code. The coding scheme in use is specified by cause_of_death_coding_system.

Used by: crvs/Death

cause_of_death_coding_system

string

The classification system used to code the cause of death (for example ICD-10, ICD-11, or a national variant). Required when comparing coded causes ac…

Used by: crvs/Death

cause_of_death_method

string · crvs/cause-of-death-method

The method used to ascertain the cause of death: physician certified, verbal autopsy, coroner, lay reporting, or other. Important for judging data qua…

Used by: crvs/Death

cause_of_fetal_death

string

A free-text description of the cause of a fetal death. Captured alongside cause_of_fetal_death_code when an ICD-PM or equivalent code is assigned.

Used by: crvs/FetalDeath

cause_of_fetal_death_code

string

The coded cause of a fetal death, typically an ICD-PM (Perinatal Mortality) code. The coding system is specified by cause_of_fetal_death_coding_system…

Used by: crvs/FetalDeath

cause_of_fetal_death_coding_system

string

The classification system used to code the cause of a fetal death (for example ICD-PM, ICD-10, or a national variant).

Used by: crvs/FetalDeath

certificate_document_type

string · crvs/certificate-document-type

The type of event the certificate attests to (birth, death, marriage, divorce, adoption). Describes what the document is about, orthogonal to its form…

Used by: crvs/Certificate

certificate_format

string · crvs/certificate-format

The format of the certificate: full copy (reproducing the acte including marginal annotations), extract (summary only), or a multilingual extract for …

Used by: crvs/Certificate

certificate_label

string

A free-text field carrying the role label as it must appear on the printed legal certificate. Jurisdictions that require gendered designations (for ex…

Used by: crvs/Parent

certificate_number

string

The number printed on the issued certificate. Distinct from the registration number of the underlying event or record, since multiple certificates can…

Used by: crvs/Certificate

child

concept:crvs/Person

The child whose birth, adoption, or legitimation is recorded in this event.

Used by: crvs/Birth, crvs/Legitimation, crvs/PaternityRecognition

civil_status_record

concept:crvs/CivilStatusRecord

A reference to a CivilStatusRecord. Used on annotations to point to the record being annotated, and on certificates to point to the record from which …

Used by: crvs/Certificate, crvs/CivilStatusAnnotation

court

string

The court that issued the judgment for a divorce, annulment, adoption, paternity recognition, or other court-ordered vital event.

Used by: crvs/Adoption, crvs/Legitimation, crvs/MarriageTermination, crvs/PaternityRecognition

creation_date

date

The date on which the family register was created, typically at marriage, at the birth of the first child, or when a new household is administratively…

Used by: crvs/FamilyRegister

deceased

concept:crvs/Person

The person whose death is recorded. Remains a Person entity so that existing identifiers and attributes can still be referenced after death.

Used by: crvs/Death

establishment_basis

string · crvs/parent-establishment-basis

The legal route by which the parent's parentage was established: marital presumption, voluntary recognition, judicial declaration, adoption order, or …

Used by: crvs/Parent

event_date

date

The date on which the vital event (birth, death, marriage, etc.) occurred. Distinct from the registration date, which is when the event was recorded b…

Used by: crvs/VitalEvent

event_date_estimated

boolean

Whether the event date is an estimate rather than a known exact date. Common for late-registered births or deaths where the precise date is not docume…

Used by: crvs/VitalEvent

event_location

concept:Location

The specific place where the vital event occurred (for example, the hospital of birth or the place of death). Distinct from the registration location,…

Used by: crvs/VitalEvent

family

concept:Group

The family group tracked by a family register. Modeled as a Group so that household-level and family-level concepts can share structure.

Used by: crvs/FamilyRegister

family_register_status

string · crvs/family-register-status

The lifecycle status of the family register: active, closed, split into multiple registers, or merged with another. Tracks how vital events reshape th…

Used by: crvs/FamilyRegister

gestational_age

integer

The completed weeks of gestation at the time of the event. Used for fetal death and birth records to distinguish viability and to apply the ICD-PM mor…

Used by: crvs/FetalDeath

head_of_household

concept:crvs/Person

The person designated as head of the family register, around whom the register is organized. Terminology and legal significance vary (koseki hittosha …

Used by: crvs/FamilyRegister

informant

concept:crvs/Person

The person who declares the vital event to the civil registration authority. Typically a parent for births, a relative or medical professional for dea…

Used by: crvs/VitalEvent

issuing_authority_location

concept:Location

The civil registration office that issued the record, modeled as a Location. Distinct from the string-valued issuing_authority property used on generi…

Used by: crvs/CivilStatusRecord

issuing_office

concept:Location

The civil registration or judicial office that issued the certificate. May differ from the office that holds the underlying record, for example when a…

Used by: crvs/Certificate

judgment_date

date

The date of the court judgment that granted a divorce, annulment, adoption, paternity recognition, or other court-ordered vital event. Distinct from t…

Used by: crvs/Adoption, crvs/Legitimation, crvs/MarriageTermination, crvs/PaternityRecognition

judgment_reference

string

The case number or other identifier of the court judgment that ordered this vital event. Enables retrieval of the underlying judicial record.

Used by: crvs/Adoption, crvs/Legitimation, crvs/MarriageTermination, crvs/PaternityRecognition

manner_of_death

string · crvs/manner-of-death

The circumstances under which the death occurred: natural, accident, intentional self-harm, assault, legal intervention, war, pending investigation, o…

Used by: crvs/Death

marriage_ref

concept:crvs/Marriage

A reference to the Marriage record that this termination (divorce or annulment) dissolves. Links the end of the union back to its formation.

Used by: crvs/MarriageTermination

medical_certifier

concept:crvs/Person

The medical practitioner who certified the cause of death. Distinct from the registrar, who records the death with the civil registration authority.

Used by: crvs/Death, crvs/FetalDeath

mother

concept:crvs/Parent

A convenience reference to the Parent instance whose parental_role is gestational (or, where no gestational parent is recorded, whose certificate_labe…

Used by: crvs/PaternityRecognition

nationality_at_birth

string · country

The nationality acquired by the child at the time of birth, typically derived from parentage (jus sanguinis) or place of birth (jus soli) according to…

Used by: crvs/Birth

originating_event

concept:crvs/VitalEvent

The vital event that this civil status record attests to (the birth behind a birth record, the marriage behind a marriage record, etc.). Anchors the r…

Used by: crvs/CivilStatusRecord

parental_role

string · crvs/parental-role

The role-nature of the parent relationship (biological, gestational, legal, or adoptive), decoupled from gender. Makes the nature of parentage explici…

Used by: crvs/Parent

parents

concept:crvs/Parent · multiple

The parents of the child, each captured as a Parent link entity that combines a Person with a parental role-nature (biological, gestational, legal, or…

Used by: crvs/Birth, crvs/FetalDeath, crvs/Legitimation

party_1

concept:crvs/Person

One of the two parties to a marriage, divorce, or annulment. Ordering between party_1 and party_2 is arbitrary and does not imply a role or precedence…

Used by: crvs/MarriageTermination, crvs/Marriage

party_2

concept:crvs/Person

The second of the two parties to a marriage, divorce, or annulment. Ordering between party_1 and party_2 is arbitrary and does not imply a role or pre…

Used by: crvs/MarriageTermination, crvs/Marriage

place_of_usual_residence

concept:Location

The usual place of residence of the person at the time of the vital event. Used by national statistics offices to allocate vital events to the place w…

Used by: crvs/Person

place_type

string · crvs/place-type

The category of place where the vital event occurred (health facility, home, en route, etc.). Complements the specific Location by describing what kin…

Used by: crvs/Birth, crvs/Death, crvs/FetalDeath

previous_parents

concept:crvs/Parent · multiple

The parents whose legal relationship with the adoptee is modified or terminated by the adoption. Present in full adoption (where biological parental r…

Used by: crvs/Adoption

recognizing_parent

concept:crvs/Parent

The parent who is formally recognizing parentage of a child, for example a person acknowledging a child born outside marriage. Captured as a Parent li…

Used by: crvs/PaternityRecognition

record_type

string · crvs/civil-status-record-type

The type of civil status record: birth, marriage, death, paternity recognition, supplementary judgment (jugement supplétif), or a court-ordered substi…

Used by: crvs/CivilStatusRecord

register_authority

concept:Location

The authority that maintains the family register. Typically a municipal or ward-level civil registration office.

Used by: crvs/FamilyRegister

register_number

string

The unique number that identifies the family register within its issuing jurisdiction.

Used by: crvs/FamilyRegister

registrar

concept:crvs/Person

The civil registration officer who recorded the event. In many jurisdictions this is the officer whose signature appears on the acte.

Used by: crvs/VitalEvent

registration_date

date

The date on which the vital event was officially registered with the civil registration authority. May be later than the event date, especially for la…

Used by: crvs/VitalEvent

registration_location

concept:Location

The civil registration office where the vital event was registered. Often a municipal or district-level registry distinct from the place of occurrence…

Used by: crvs/VitalEvent

registration_status

string · crvs/registration-status

The lifecycle state of the registration process for this vital event: whether it is declared, pending validation, registered, rejected, cancelled, or …

Used by: crvs/VitalEvent

registration_type

string · crvs/registration-type

The regime under which the registration was processed: current (within the legal window), late, court-ordered, or reconstruction of a lost record. Aff…

Used by: crvs/VitalEvent

sex_at_birth

string · sex

The sex of the child as observed and recorded at the time of birth. Distinct from any later legal or administrative sex marker.

Used by: crvs/Birth

termination_type

string · crvs/marriage-termination-type

Whether the marriage was terminated by divorce (dissolution of a valid marriage) or by annulment (declaration that the marriage was void from its ince…

Used by: crvs/MarriageTermination

triggering_vital_event

concept:crvs/VitalEvent

The vital event that triggered this record. On CivilStatusAnnotation the referenced VitalEvent identifies the later marriage, divorce, death, paternit…

Used by: crvs/CivilStatusAnnotation

type_of_marriage

string · crvs/marriage-type

The legal regime under which the marriage was contracted: civil, religious, customary, or common law. Determines which authority registered or recogni…

Used by: crvs/Marriage

vital_event

concept:crvs/VitalEvent

The vital event that this certificate attests to. Used on certificates issued directly from a vital event record rather than from a stored civil statu…

Used by: crvs/Certificate

weight

decimal

The weight of the fetus at the time of a fetal death, recorded in grams. Combined with gestational age, used to classify viability and stillbirth type…

Used by: crvs/FetalDeath

weight_at_birth

decimal

The weight of the child at birth, recorded in grams. A core UN Principles and Recommendations vital statistics variable used to identify low birth wei…

Used by: crvs/Birth

witnesses

concept:crvs/Person · multiple

People who witnessed the vital event and attested to it at the time of registration. Witness requirements vary by jurisdiction and event type (marriag…

Used by: crvs/Marriage