BelgIF OpenAPI common data types

Beschrijving
Een verbetering voorstellen

Een werkgroep, bestaande uit functionelen van FOD BOSA, eHealth, KSZ, FOD Financiën en Smals, heeft de meest gangbare bedrijfsontologieën (Person, Organization, Location, Temporal, Generic...) gestandaardiseerd.

Deze samenwerking resulteerde in

enerzijds, de publicatie van een terminologielijst van klassen en eigenschappen, met hun URI's, die door de federale overheid als standaardterminologie wordt aanvaard (Belgif vocabularies). Deze terminologie is afkomstig uit drie bronnen: federale overheidsdiensten, Vlaanderen en EU-standaarden. Elk element van de lijst heeft een numerieke identificator (zonder betekenis), een naam (in het Engels, camelCase) en een definitie
anderzijds, libraries van gemeenschappelijke data types (Belgif OpenAPI schemas) in overeenstemming met de Belgif vocabularies en de Belgif REST guidelines

BelgIF-OpenAPI definieert data types in de volgende domeinen:

organization-identifier
employment-identifier
person-identifier
person
location
time
money
problem
common (common technical data types)

Alle types zijn beschikbaar in de OpenAPI 2.0 (Swagger) en OpenAPI 3.0 formaten.

Er kan vanuit andere OpenAPI-documenten naar de data types worden verwezen:

“$ref”: “./belgif/person/identifier/v1/person-identifier-v1.yaml#/components/schemas/Ssin”

Gebruikersgroepen

De libraries BelgIF-OpenAPI common data types kunnen gebruikt worden door iedereen die een REST API ontwikkelt, waarbij de interoperabiliteit tussen alle gebruikte API's wordt verbeterd.

Als je wenst bij te dragen door opmerkingen te formuleren over de standaarden, ze mee vorm te geven of er intern/extern over te communiceren, dan kan je een issue openen op het geschikte project (belgif-openapi, FedVoc, REST guide), of een mail sturen naar fsp@gcloud.belgium.be.

Integratievoorwaarden

De libraries BelgIF-OpenAPI common data types zijn als open source gepubliceerd onder de licentie 2.0 van Apache en gratis te downloaden op GitHub of als maven-artifacts op Maven Central.

Contact: ReuseOperational@smals.be

Documentatie

Sommige van de onderstaande links werken mogelijk niet omwille van beveiligingsbeperkingen.

Wenst u deze informatie te verkrijgen, neem dan contact op met het verantwoordelijke team via het e-mailadres hierboven vermeld in de paragraaf Integratievoorwaarden.