Difference between revisions of "Pension Means of Living Canonical Evidence"

From DE4A
Jump to navigation Jump to search
(Created page with "==Description== This evidence contains elements related to the Domicile Deregistration Evidence. The Canonical Evidence in Use Case "Request Address Change" (MA UC1). ==...")
 
(Added MA canonical evidence types information)
 
Line 1: Line 1:
 
==Description==
 
==Description==
−
This evidence contains elements related to the Domicile Deregistration Evidence. The Canonical Evidence in [[Use Case "Request Address Change" (MA UC1)]].
+
This evidence contains elements related to the Pension Means of Living Evidence. The Canonical Evidence in [[Use Case "Request Pension Information - Claim Pension" (MA UC3)]].
  
−
== XSD ==
+
== XSD==
 
XSD files can be found on the [https://github.com/de4a-wp3/moving_abroad GitHub repository].
 
XSD files can be found on the [https://github.com/de4a-wp3/moving_abroad GitHub repository].
  
 
==Diagram==
 
==Diagram==
−
[[File:DomicileDeregistrationEvidence-UML-1.7.drawio.png|alt=|center]]
+
[[File:PensionMeansOfLivingEvidence-0.1.png|alt=|center|842x842px|Pension Means of Linving Canonical Evidence_ UML diagram]]
  
 
==Attribute Specification==
 
==Attribute Specification==
 
{| class="wikitable"
 
{| class="wikitable"
−
|+
+
!DE4A name
−
!DE4A name
 
 
!Property type
 
!Property type
 
!Cardinality
 
!Cardinality
 
!Data type
 
!Data type
−
!Related Vocabulary
+
!Related vocabulary
−
!Controlled vocabulary
+
!Controlled Vocabulary
 
!Definition
 
!Definition
 
|-
 
|-
−
|'''DomicileRegistrationEvidence'''
+
|'''PensionMeansOfLivingEvidence'''
 
|'''Class'''
 
|'''Class'''
−
|  
+
|
−
|  
+
|
−
|  
+
|
−
|  
+
|
−
|'''This  class contains elements related to the Domicile Registration Evidence.'''
+
|
 
|-
 
|-
 
|Identifier
 
|Identifier
Line 33: Line 32:
 
|cva:Cvidentifier
 
|cva:Cvidentifier
 
|
 
|
−
|An unambiguous reference to the Domicile Registration Evidence.
+
|An unambiguous reference to the Pension Means of Living Evidence
 
|-
 
|-
 
|IssueDate
 
|IssueDate
Line 41: Line 40:
 
|udt:Date
 
|udt:Date
 
|
 
|
−
|The most recent date on which the  Domicile  Registration Evidence instance was issued.
+
|The most recent date on which the Pension Means of Living Evidence instance was issued.
 
|-
 
|-
 
|IssuingAuthority
 
|IssuingAuthority
Line 49: Line 48:
 
|
 
|
 
|
 
|
−
|A Public Organisation with official authority in charge of issuing the  Domicile Registration Evidence.
+
|A Public Organisation with official authority in charge of issuing the Pension Means of Living Evidence.
 
|-
 
|-
−
|IssuingPlace
+
|Certifies
 
|Object
 
|Object
 
|[1..1]
 
|[1..1]
−
|LocationAddress
+
|PensionMeansOfLivingInfo
 
|
 
|
 
|
 
|
−
|The  location address where the  Domicile  Registration Evidence was issued.
+
|Attesting in a formal way that the pension data is true.
 
|-
 
|-
−
|CertifiesDomicile
+
|'''PublicOrganisation'''
−
|Object
+
|'''Class'''
−
|[1..1]
+
|
−
|Domicile
+
|
 
|
 
|
 
|
 
|
−
|Attesting  in a formal way that the Domicile is true.
+
|'''Any organisation that is defined as being part of the public sector by a legal framework at any level.'''
−
|-
 
−
|'''PublicOrganisation'''
 
−
|'''Class'''
 
−
|
 
−
|
 
−
|
 
−
|
 
−
|'''Any organisation that is defined as being part of the public sector by a legal framework at any level.'''
 
 
|-
 
|-
 
|Identifier
 
|Identifier
Line 81: Line 72:
 
|cva:Cvidentifier
 
|cva:Cvidentifier
 
|
 
|
−
|Many organisations are referred to by an acronym or some other identifier. For example, among the EU institutions, the ECB is the identifier for the European Central Bank, OLAF for the European Anti-Fraud Office, and so on. These are formally recognised by the European Commission which provides a list of such acronyms. Analogous lists should be used in other contexts.
+
|Many organisations are referred to by an acronym or some other identifier. For example, among the EU institutions, the ECB is the identifier for the European Central Bank, OLAF for the European AntiN/AFraud Office, and so on. These are formally recognised by the European Commission which provides a list of such acronyms. Analogous lists should be used in other contexts.
 
|-
 
|-
 
|PrefLabel
 
|PrefLabel
Line 89: Line 80:
 
|udt:Text
 
|udt:Text
 
|
 
|
−
|As defined in the ORG Ontology, a preferred label is used to provide the primary, legally recognised name of the organisation. An organisation may only have one such name in any given language. Primary names may be provided in multiple languages with multiple instances of the preferred label property.
+
|As defined in the ORG Ontology, a preferred label is used to provide the primary, legally recognised name of the organisation. An organisation may only have one such name in any given language. Primary names may be provided in multiple languages with multiple instances of the preferred label property.
 
|-
 
|-
−
|'''Domicile'''
+
|'''PensionMeansOfLivingInfo'''
 
|'''Class'''
 
|'''Class'''
−
|  
+
|
−
|  
+
|
−
|  
+
|
−
|  
+
|
−
|'''This  class contains elements related to the domicile'''
+
|'''Information on different pension benefits'''
 
|-
 
|-
−
|Inhabitant
+
|DataSubject
 
|Object
 
|Object
 
|[1..1]
 
|[1..1]
Line 105: Line 96:
 
|
 
|
 
|
 
|
−
|Person,  living in the residence or domicile
+
|The person who is subject to this information
 
|-
 
|-
−
|Domicile
+
|PensionList
 
|Object
 
|Object
−
|[1..1]
+
|[0..1]
−
|ConstrainedLocationAddress
+
|PensionList
 
|
 
|
 
|
 
|
−
|Current  domicile inhabited by person
+
|List of pensions and benefits. Contains information on the pensions of the person for whom the query was made.
 
|-
 
|-
−
|'''Person'''
+
|PensionList
−
|'''Class'''
+
|Class
−
|  
+
|
−
|  
+
|
−
|  
+
|
−
|  
+
|
−
|'''An  individual natural person who may be dead or alive, but not imaginary.'''
+
|
 
|-
 
|-
−
|PersonName
+
|Pension
 
|Object
 
|Object
−
|[1..1]
+
|[1..*]
−
|Name
+
|Pension
 
|
 
|
 
|
 
|
−
|The  family name and given name of a Person. At least one of the two must exist.
+
|Contains detailed data about each specific pension.
 
|-
 
|-
−
|Identifier
+
|'''Pension'''
−
|Object
+
|'''Class'''
−
|[0..*]
+
|
−
|Identifier
+
|
−
|cva:Cvidentifier
 
 
|
 
|
−
|The  identifier relation is used to link a Person to any formally issued  Identifier for that Person.
 
−
|-
 
−
|DateOfBirth
 
−
|Object
 
−
|[0..1]
 
−
|DateObject
 
 
|
 
|
 
|
 
|
−
|The  day on which the person was born.
 
 
|-
 
|-
−
|Gender
+
|PensionCategory
 
|Datatype
 
|Datatype
−
|[0..1]
+
|[1..1]
−
|Code
+
|PensionCategoryEnum
−
|udt:Code
+
|
−
|Human  Sex
+
|
−
|The chromosomal state, and reproductive organs and structures of a Person that  allows them to be distinguished as female or male or not applicable, not  known or not stated.
+
|Literals of the specific codes of the Spanish pension system. The possible values are listed in tab "Pensions".
 
|-
 
|-
−
|MaritalStatus
+
|Status
 
|Datatype
 
|Datatype
−
|[0..1]
+
|[1..1]
−
|Code
+
|StatusTypeEnum
−
|udt:Code
+
|
−
|Marital  Status
+
|
−
|An indicator of the marital status
+
|Status of the benefit.
 +
The possible values are:
 +
• ACTIVE: the citizen is receiving the unemployment benefit
 +
• NON-ACTIVE: the citizen is not receiving the unemployment benefit
 +
• NON-ACTIVE due to APRE (APRE: "Cumulative and early payment of contributory unemployment benefit to foreign workers returning to their country of origin")
 +
• NON-ACTIVE when the benefit has been capitalised
 
|-
 
|-
−
|PlaceOfBirth
+
|GrossAmount
 
|Object
 
|Object
 
|[0..1]
 
|[0..1]
−
|LocationAddress
+
|MonetaryAmount
 
|
 
|
 
|
 
|
−
|The Location where the person was born
+
|It corresponds to the amount of the benefit, including the amounts of possible deductions plus the amount of Personal Income Tax (if applicable). There may be benefits with a gross amount equal to zero.
 +
For all social public benefits, the monthly amount of the benefit as at the date of consultation will be returned.
 +
For M6 or P6 direct payment benefits, the gross amount will be the amount that will be paid for the whole benefit even if it has not yet been paid.
 +
For temporary disability (direct payment benefit I6 or I7), the gross amount will be the amount that has been paid up to the time of the consultation.
 +
If there are confirmation statements captured but not paid, the payment will be calculated and included in the gross amount.
 +
Amount in euro cents.
 +
The Format is NNNNNNN
 
|-
 
|-
−
|Citizenship
+
|NetAmount
 
|Object
 
|Object
−
|[0..*]
+
|[0..1]
−
|Jurisdiction
+
|MonetaryAmount
 
|
 
|
 
|
 
|
−
|The  citizenship relationship links a Person to a Jurisdiction that has conferred  citizenship rights on the individual such as the right to vote, to receive  certain protection from the community or the issuance of a passport.
+
|It corresponds to the amount of the benefit after the possible deductions have been applied, plus the amount of Personal Income Tax (if applicable). There may be benefits with a net amount equal to zero, either because it is based on a gross amount of zero, or because it is zero after applying the corresponding deductions.
 +
In all benefits outside the Social Security System, the net amount will coincide with the gross amount, since there is no available data on possible deductions.
 +
Amount in euro cents.
 +
The Format is NNNNNNN
 
|-
 
|-
−
|'''Jurisdiction'''
+
|NumberPaymentsYear
−
|'''Class'''
+
|Datatype
−
|  
+
|[0..1]
−
|  
+
|Numeric
−
|  
+
|
−
|  
+
|
−
|'''The  authority that an official organisation has, to make legal decisions about  somebody/something.'''
+
|It refers to the number of payments corresponding to that benefit in the period of one year. Unless there is an error, this field will always be returned within the benefits of the Registry of Public Social Benefits.
 
|-
 
|-
−
|Identifier
+
|PeriodOfTime
 
|Object
 
|Object
 
|[0..1]
 
|[0..1]
−
|Identifier
+
|PeriodOfTime
−
|cvb:JurisdictionID
 
 
|
 
|
−
|The  value for the id property is a URI for that Jurisdiction.
 
−
|-
 
−
|Name
 
−
|Datatype
 
−
|[1..*]
 
−
|Text
 
−
|cbc:Name
 
 
|
 
|
−
|The name is simply a string that identifies the Jurisdiction, typically a  country, with or without a language tag.
+
|Effect date: It corresponds to the date of economic effects of the benefit. It will be returned in all cases, except for Temporary Disability benefits (I6 or I7), either the provision in Direct Payment or Delegated Payment. The format is YYYYMMDD
 +
ExpectedEndDate: Corresponds to the date on which the benefit ends. No data will be returned for the benefits of the Registry of Public Social Benefits
 +
In the case of maternity or paternity, it will correspond to the expiration date of the subsidy. In the case of temporary disability, the end date is the date of the last payment made or the last confirmation part noted. In temporary disability, the delegated payment will not be completed.
 
|-
 
|-
−
|'''ConstrainedLocationAddress'''
+
|'''PeriodOfTime'''
 
|'''Class'''
 
|'''Class'''
−
|  
+
|
−
|  
+
|
−
|  
+
|
−
|  
+
|
−
|'''The  Address of a location based on the INSPIRE Address representation. It is  subclass of the class Address.'''
+
|'''Period of time'''
−
|-
 
−
|AdminUnitL2
 
−
|Datatype
 
−
|[1..1]
 
−
|Text
 
−
|cvb:AdminunitSecondline
 
−
|NUTS/LAU
 
−
|The  region of the address, usually a county, state or other such area that  typically encompasses several localities.
 
−
|-
 
−
|AdminUnitL1
 
−
|Datatype
 
−
|[1..1]
 
−
|Text
 
−
|cvb:AdminunitFirstline
 
−
|Country
 
−
|The  uppermost administrative unit for the address, almost always a country. Best  practice is to use the ISO 3166-1 code.
 
−
|-
 
−
|'''LocationAddress'''
 
−
|'''Class'''
 
−
|
 
−
|
 
−
|
 
−
|
 
−
|'''The  Address of the place of birth based on the INSPIRE Address representation. It  is subclass of the class Address.'''
 
 
|-
 
|-
−
|AdminUnitL2
+
|StartDate
 
|Datatype
 
|Datatype
 
|[0..1]
 
|[0..1]
−
|Text
+
|Date
−
|cvb:AdminunitSecondline
+
|udt:Date
 
|
 
|
−
|The  region of the address, usually a county, state or other such area that  typically encompasses several localities.
+
|Effective start date of a period time. The format is YYYY-MM-DD
 
|-
 
|-
−
|AdminUnitL1
+
|EndDate
 
|Datatype
 
|Datatype
 
|[0..1]
 
|[0..1]
−
|Text
+
|Date
−
|cvb:AdminunitFirstline
+
|udt:Date
−
|Country
+
|
−
|The uppermost administrative unit for the address, almost always a country. Best  practice is to use the ISO 3166-1 code.
+
|Expected end date or effective end date in case of suspension/cancellation/finish. The format is YYYY-MM-DD
 
|-
 
|-
−
|'''Address'''
+
|'''MonetaryAmount'''
 
|'''Class'''
 
|'''Class'''
−
|  
+
|
−
|  
+
|
−
|  
+
|
−
|  
+
|
−
|'''Representation  of address based on the INSPIRE Address Representation.'''
+
|'''A monetary value.'''
 
|-
 
|-
−
|PoBox
+
|currency
 
|Datatype
 
|Datatype
−
|[0..1]
+
|[0..*]
−
|Text
+
|Code
−
|cvb:PoBox
 
 
|
 
|
−
|The Post Office Box number. INSPIRE's name for this is  "postalDeliveryIdentifier" for which it uses the locator designator  property with a type attribute of that name. This vocabulary separates out  the Post Office Box for greater independence of technology.
+
|Currency
 +
|The currency in which the Monetary Amount is expressed.
 
|-
 
|-
−
|Thoroughfare
+
|amount
 
|Datatype
 
|Datatype
−
|[0..1]
+
|[1..1]
−
|Text
+
|Numeric
−
|cvb:Thoroughfare
+
|
 
|
 
|
−
|Quoting  from the INSPIRE guidelines, a thoroughfare is: "an address component  that represents the name of a passage or way through from one location to  another. A thoroughfare is not necessarily a road, it might be a waterway or  some other feature.
+
|The quantitative value of the Monetary Amount.
 
|-
 
|-
−
|LocatorDesignator
+
|'''Person'''
−
|Datatype
+
|'''Class'''
−
|[0..1]
+
|
−
|Text
+
|
−
|cvb:LocatorDesignator
+
|
 
|
 
|
−
|The  locator designator is defined by the INSPIRE guidelines as "a number or a sequence of characters that uniquely identifies the locator within the  relevant scope(s). The full identification of the locator could include one  or more locator designators." In simpler terms, this is the building  number, apartment number, etc. For an address such as "Flat 3, 17 Bridge  Street", the locator is "flat 3, 17."
+
|'''An individual natural person who may be dead or alive, but not imaginary.'''
 
|-
 
|-
−
|LocatorName
+
|Identifier
−
|Datatype
+
|Object
−
|[0..1]
+
|[0..*]
−
|Text
+
|Identifier
−
|cvb:LocatorName
+
|cva:Cvidentifier
 
|
 
|
−
|Based  on the INSPIRE guidelines, locator name is defined as: "Proper noun(s)  applied to the real world entity identified by the locator. The locator name  could be the name of the property or complex, of the building or part of the  building, or it could be the name of a room inside a building. The key  difference between a locator and a locator name is that the latter is a  proper name and is unlikely to include digits. For example, "Shumann,  Berlaymont" is a meeting room within the European Commission  headquarters for which locator name is more appropriate than locator.
+
|The identifier relation is used to link a Person to any formally issued Identifier for that Person.
 
|-
 
|-
−
|AddressArea
+
|SocialSecurityNumber
 
|Datatype
 
|Datatype
−
|[0..1]
+
|[1..*]
−
|Text
+
|Identifier
−
|cvb:CvaddressArea
+
|cva:Cvidentifier
 
|
 
|
−
|Taking  the definition from INSPIRE, the address area is: the name or names of a  geographic area or locality that groups a number of addressable objects for  addressing purposes, without being an administrative unit." This would  typically be part of a city, a neighbourhood or village.
+
|Social Security numbers of the consulted citizen. Up to 10 numbers can be returned, althoug citizens usually have only one Social Security number, but there are also cases with multiple social security numbers.
 
|-
 
|-
−
|PostName
+
|PersonName
−
|Datatype
+
|Object
−
|[0..1]
+
|[1..1]
−
|Text
+
|Name
−
|cvb:PostName
 
 
|
 
|
−
|The  key postal division of the address, usually the city. (INSPIRE's definition  is "One or more names created and maintained for postal purposes to  identify a subdivision of addresses and postal delivery points.)
 
−
|-
 
−
|PostCode
 
−
|Datatype
 
−
|[0..1]
 
−
|Text
 
−
|cvb:PostCode
 
 
|
 
|
−
|The post code (a.k.a postal code, zip code etc.). Post codes are common elements  in many countries' postal address systems.
+
|The family name and given name of a Person. At least one of the two must exist.
 
|-
 
|-
−
|'''Name'''
+
|DateOfBirth
−
|'''Class'''
+
|Object
−
|
+
|[1..1]
−
|
+
|DateObject
−
|
 
−
|
 
−
|'''A  name of a person that includes the family and given name.'''
 
−
|-
 
−
|FamilyName
 
−
|Datatype
 
−
|[0..*]
 
−
|Text
 
−
|cbc:FamilyName
 
 
|
 
|
−
|A  family name is usually shared by members of a family. This attribute also  carries prefixes or suffixes which are part of the family name, e.g. "de  Boer", "van de Putte", "von und zu Orlow". Multiple  family names, such as are commonly found in Hispanic countries, are recorded  in the single family name field so that, for example, Miguel de Cervantes  Saavedra's Family Name would be recorded as "de Cervantes  Saavedra".
 
−
|-
 
−
|GivenName
 
−
|Datatype
 
−
|[0..*]
 
−
|Text
 
−
|cvb:GivenName
 
 
|
 
|
−
|A  given name, or multiple given names, are the denominator(s) that identify an  individual within a family. These are given to a Person by his or her parents  at birth or may be legally recognised as 'given names' through a formal  process. All given names are ordered in one field so that, for example, the  given name for Johann Sebastian Bach is 'Johann Sebastian'.
+
|The day on which the Person was born.
 
|-
 
|-
 
|'''DateObject'''
 
|'''DateObject'''
 
|'''Class'''
 
|'''Class'''
−
|  
+
|
−
|  
+
|
−
|  
+
|
−
|  
+
|
−
|'''Structured representation of date with year, month and day of the month.'''
+
|'''Structured representation of date with year, month and day of the month.'''
 
|-
 
|-
 
|Year
 
|Year
Line 353: Line 296:
 
|xsd:gYear
 
|xsd:gYear
 
|
 
|
−
|A gregorian calendar year. The value space of Year is the set of Gregorian calendar years as defined in § 5.2.1 of ISO 8601. Specifically, it is a set of one-year long, non-periodic instances e.g. lexical 1999 to represent the whole year 1999, independent of how many months and days this year has.
+
|A gregorian calendar year. The value space of Year is the set of Gregorian calendar years as defined in § 5.2.1 of ISO 8601. Specifically, it is a set of one-year long, non-periodic instances e.g. lexical 1999 to represent the whole year 1999, independent of how many months and days this year has.
 
|-
 
|-
 
|Month
 
|Month
Line 361: Line 304:
 
|xsd:gMonth
 
|xsd:gMonth
 
|
 
|
−
|A gregorian month that recurs every year. The value space of Month is the space of a set of calendar months as defined in § 3 of ISO 8601. Specifically, it is a set of one-month long, yearly periodic instances.
+
|A gregorian month that recurs every year. The value space of Month is the space of a set of calendar months as defined in § 3 of ISO 8601. Specifically, it is a set of one-month long, yearly periodic instances.
 
|-
 
|-
 
|Day
 
|Day
Line 369: Line 312:
 
|xsd:gDay
 
|xsd:gDay
 
|
 
|
−
|A gregorian day that recurs, specifically a day of the month such as the 5th of the month. The value space of Day is the space of a set of calendar dates as defined in § 3 of ISO 8601. Specifically, it is a set of one-day long, monthly periodic instances.
+
|A gregorian day that recurs, specifically a day of the month such as the 5th of the month. The value space of Day is the space of a set of calendar dates as defined in § 3 of ISO 8601. Specifically, it is a set of one-day long, monthly periodic instances.
 +
|-
 +
|'''Name'''
 +
|'''Class'''
 +
|
 +
|
 +
|
 +
|
 +
|'''A name of a person that includes the family and given name.'''
 +
|-
 +
|FamilyName
 +
|Datatype
 +
|[0..*]
 +
|Text
 +
|cbc:FamilyName
 +
|
 +
|A family name is usually shared by members of a family. This attribute also carries prefixes or suffixes which are part of the family name, e.g. "de Boer", "van de Putte", "von und zu Orlow". Multiple family names, such as are commonly found in Hispanic countries, are recorded in the single family name field so that, for example, Miguel de Cervantes Saavedra's Family Name would be recorded as "de Cervantes Saavedra".
 +
|-
 +
|GivenName
 +
|Datatype
 +
|[0..*]
 +
|Text
 +
|cvb:GivenName
 +
|
 +
|A given name, or multiple given names, are the denominator(s) that identify an individual within a family. These are given to a Person by his or her parents at birth or may be legally recognised as 'given names' through a formal process. All given names are ordered in one field so that, for example, the given name for Johann Sebastian Bach is 'Johann Sebastian'.
 
|}
 
|}

Latest revision as of 22:54, 19 January 2023

Description

This evidence contains elements related to the Pension Means of Living Evidence. The Canonical Evidence in Use Case "Request Pension Information - Claim Pension" (MA UC3).

XSD

XSD files can be found on the GitHub repository.

Diagram

Attribute Specification

DE4A name Property type Cardinality Data type Related vocabulary Controlled Vocabulary Definition
PensionMeansOfLivingEvidence Class
Identifier Object [0..1] Identifier cva:Cvidentifier An unambiguous reference to the Pension Means of Living Evidence
IssueDate Datatype [1..1] Date udt:Date The most recent date on which the Pension Means of Living Evidence instance was issued.
IssuingAuthority Object [1..1] PublicOrganisation A Public Organisation with official authority in charge of issuing the Pension Means of Living Evidence.
Certifies Object [1..1] PensionMeansOfLivingInfo Attesting in a formal way that the pension data is true.
PublicOrganisation Class Any organisation that is defined as being part of the public sector by a legal framework at any level.
Identifier Object [0..*] Identifier cva:Cvidentifier Many organisations are referred to by an acronym or some other identifier. For example, among the EU institutions, the ECB is the identifier for the European Central Bank, OLAF for the European AntiN/AFraud Office, and so on. These are formally recognised by the European Commission which provides a list of such acronyms. Analogous lists should be used in other contexts.
PrefLabel Datatype [1..*] Text udt:Text As defined in the ORG Ontology, a preferred label is used to provide the primary, legally recognised name of the organisation. An organisation may only have one such name in any given language. Primary names may be provided in multiple languages with multiple instances of the preferred label property.
PensionMeansOfLivingInfo Class Information on different pension benefits
DataSubject Object [1..1] Person The person who is subject to this information
PensionList Object [0..1] PensionList List of pensions and benefits. Contains information on the pensions of the person for whom the query was made.
PensionList Class
Pension Object [1..*] Pension Contains detailed data about each specific pension.
Pension Class
PensionCategory Datatype [1..1] PensionCategoryEnum Literals of the specific codes of the Spanish pension system. The possible values are listed in tab "Pensions".
Status Datatype [1..1] StatusTypeEnum Status of the benefit.

The possible values are: • ACTIVE: the citizen is receiving the unemployment benefit • NON-ACTIVE: the citizen is not receiving the unemployment benefit • NON-ACTIVE due to APRE (APRE: "Cumulative and early payment of contributory unemployment benefit to foreign workers returning to their country of origin") • NON-ACTIVE when the benefit has been capitalised

GrossAmount Object [0..1] MonetaryAmount It corresponds to the amount of the benefit, including the amounts of possible deductions plus the amount of Personal Income Tax (if applicable). There may be benefits with a gross amount equal to zero.

For all social public benefits, the monthly amount of the benefit as at the date of consultation will be returned. For M6 or P6 direct payment benefits, the gross amount will be the amount that will be paid for the whole benefit even if it has not yet been paid. For temporary disability (direct payment benefit I6 or I7), the gross amount will be the amount that has been paid up to the time of the consultation. If there are confirmation statements captured but not paid, the payment will be calculated and included in the gross amount. Amount in euro cents. The Format is NNNNNNN

NetAmount Object [0..1] MonetaryAmount It corresponds to the amount of the benefit after the possible deductions have been applied, plus the amount of Personal Income Tax (if applicable). There may be benefits with a net amount equal to zero, either because it is based on a gross amount of zero, or because it is zero after applying the corresponding deductions.

In all benefits outside the Social Security System, the net amount will coincide with the gross amount, since there is no available data on possible deductions. Amount in euro cents. The Format is NNNNNNN

NumberPaymentsYear Datatype [0..1] Numeric It refers to the number of payments corresponding to that benefit in the period of one year. Unless there is an error, this field will always be returned within the benefits of the Registry of Public Social Benefits.
PeriodOfTime Object [0..1] PeriodOfTime Effect date: It corresponds to the date of economic effects of the benefit. It will be returned in all cases, except for Temporary Disability benefits (I6 or I7), either the provision in Direct Payment or Delegated Payment. The format is YYYYMMDD

ExpectedEndDate: Corresponds to the date on which the benefit ends. No data will be returned for the benefits of the Registry of Public Social Benefits In the case of maternity or paternity, it will correspond to the expiration date of the subsidy. In the case of temporary disability, the end date is the date of the last payment made or the last confirmation part noted. In temporary disability, the delegated payment will not be completed.

PeriodOfTime Class Period of time
StartDate Datatype [0..1] Date udt:Date Effective start date of a period time. The format is YYYY-MM-DD
EndDate Datatype [0..1] Date udt:Date Expected end date or effective end date in case of suspension/cancellation/finish. The format is YYYY-MM-DD
MonetaryAmount Class A monetary value.
currency Datatype [0..*] Code Currency The currency in which the Monetary Amount is expressed.
amount Datatype [1..1] Numeric The quantitative value of the Monetary Amount.
Person Class An individual natural person who may be dead or alive, but not imaginary.
Identifier Object [0..*] Identifier cva:Cvidentifier The identifier relation is used to link a Person to any formally issued Identifier for that Person.
SocialSecurityNumber Datatype [1..*] Identifier cva:Cvidentifier Social Security numbers of the consulted citizen. Up to 10 numbers can be returned, althoug citizens usually have only one Social Security number, but there are also cases with multiple social security numbers.
PersonName Object [1..1] Name The family name and given name of a Person. At least one of the two must exist.
DateOfBirth Object [1..1] DateObject The day on which the Person was born.
DateObject Class Structured representation of date with year, month and day of the month.
Year Datatype [0..1] Year xsd:gYear A gregorian calendar year. The value space of Year is the set of Gregorian calendar years as defined in § 5.2.1 of ISO 8601. Specifically, it is a set of one-year long, non-periodic instances e.g. lexical 1999 to represent the whole year 1999, independent of how many months and days this year has.
Month Datatype [0..1] Month xsd:gMonth A gregorian month that recurs every year. The value space of Month is the space of a set of calendar months as defined in § 3 of ISO 8601. Specifically, it is a set of one-month long, yearly periodic instances.
Day Datatype [0..1] Day xsd:gDay A gregorian day that recurs, specifically a day of the month such as the 5th of the month. The value space of Day is the space of a set of calendar dates as defined in § 3 of ISO 8601. Specifically, it is a set of one-day long, monthly periodic instances.
Name Class A name of a person that includes the family and given name.
FamilyName Datatype [0..*] Text cbc:FamilyName A family name is usually shared by members of a family. This attribute also carries prefixes or suffixes which are part of the family name, e.g. "de Boer", "van de Putte", "von und zu Orlow". Multiple family names, such as are commonly found in Hispanic countries, are recorded in the single family name field so that, for example, Miguel de Cervantes Saavedra's Family Name would be recorded as "de Cervantes Saavedra".
GivenName Datatype [0..*] Text cvb:GivenName A given name, or multiple given names, are the denominator(s) that identify an individual within a family. These are given to a Person by his or her parents at birth or may be legally recognised as 'given names' through a formal process. All given names are ordered in one field so that, for example, the given name for Johann Sebastian Bach is 'Johann Sebastian'.
Retrieved from ‘https://wiki.de4a.eu/index.php?title=Pension_Means_of_Living_Canonical_Evidence&oldid=5799’