person code types (CBSS/national registry)

[pvdbosch]

OpenAPI YAML extract below has draft data types for CBSS registry and national registry related code types (the ones with names ending on "Id")

Goal is to align these with FedVoc, and add them to belgif-person-openapi data types where useful.

FedVoc entries with related OpenAPI/Swagger entries and documentation: HouseholdRelationType - HouseholdRelationTypeId - doc CivilState (draft) - CivilStateId - doc Register (draft) - SubregisterId - doc

Is there an interest to include other code types as well?

    BirthActTypeId:
      type: integer
      minimum: 0
      maximum: 99
      description: The code of the birth act type, as assigned by the National Register
    CivilStateId:
      type: integer
      minimum: 1
      maximum: 99
      description: The civil state code, as assigned by the National Register
    CohousingTypeId:
      type: integer
      minimum: 0
      maximum: 99
      description: The code of the type of cohousing, as assigned by the National Register
    ContactAddressTypeId:
      type: integer
      minimum: 1
      maximum: 99
      description: The code of the type of contact address, as assigned by the Crossroads Bank of Social Security
    HouseholdRelationId:
      type: integer
      minimum: 1
      maximum: 99
      description: The code of the household relation, as assigned by the National Register
    LegalCohabitationTerminationTypeId:
      type: integer
      minimum: 1
      maximum: 99
      description: The code of the legal cohabitation termination type, as assigned by the National Register
    NobilityTitleId:
      type: integer
      minimum: 1
      maximum: 99
      description: The code of the nobility title, as assigned by the National Register
    SubregisterId:
      type: integer
      minimum: 1
      maximum: 99
      description: The code for the (sub)register as part of the National Register

[MarcBruyland]

why don't we define a ConceptScheme for this, rather than defining different properties ?

[AnnVanCamp]

Hello Peter, I don't know if this comment is relevant for you, but two properties I miss are the nationality and the domicile, which may differ from the contact address. For legal deposit, those are the current criteria to determine whether an author published abroad is obliged to deposit his/her work or not.

[pvdbosch]

@MarcBruyland : The OpenAPI types can map to ConceptSchemes, but in FedVoc, but even though their format is similar, the meaning of each concept (represented as numeric value) depends on the context in which it occurs. So IMO still needs different ConceptSchemes. Though it might not be worthwhile to standardize each one of them in FedVoc.

We'd also need properties to link the ConceptScheme to a Person.

[pvdbosch]

Hello @AnnVanCamp , nationality has been defined as a property of Person in the draft sheet of the vocabularies Excel.

For the value of a nationality, one of the CountryXYZCode Concept Schemes can be used (some in Standard, some in Draft), depending on context. The most used of these have also been published as reusable Swagger/OpenAPI types in openapi-location: CountryNisCode, CountryIsoCode and CountryWithHistoricIsoCode. BOSA is designing a REST API for the list of country codes (see issue #15).

domicile is included as "residenceAddress" in the Excel sheet, though still in Draft.

[pvdbosch]

During WG meeting decided to:

• remove (sub)register from FedVoc draft (specific to RRN, no widespread usage)
• add CivilStateId and HouseholdRelationTypeId to new drafts of belgif-person-openapi. After validation by both WG, they can be marked as "inSwagger" in FedVoc

[pvdbosch]

the new codes in https://github.com/belgif/openapi-person/blob/master/src/main/openapi/person/v2/person-v2-beta.yaml can be reviewed next WG

[smals-vea]

@MarcBruyland , il faut encore adapter FedVoc pour les 2 Conceptscheme:

• CivilStateCode
• HouseholdRelationTypeCode