Dit document beschrijft een implementatiemodel, in dit geval AIM Object. Een implementatiemodel is een toepassing van vocabularia voor een concreet doel. Het beschrijft in alle detail (zoals kardinaliteiten, codelijsten, datatypes, ...) de gewenste datastructuur.
Samenvatting
Dit is een implementatiemodel op bestaande vocabularia m.b.t. (weg)aanhorigheden waaronder:
-
Dit implementatiemodel maakt deel uit van de volledige set aan implementatiemodellen die horen bij de OTL data-aanleveringen.
In dit implementatiemodel wordt getoond hoe de onderdelen en installaties verrijkt worden in het kader van AIM-datauitwisselingen.
Het implementatiemodel legt ook vast welke codelijsten moeten worden gebruikt. De keuzeopties in deze lijsten worden evenwel buiten de OTL beheerd.
Status van dit document
Dit implementatiemodel dient om het specifieke gebruik van de entiteiten relevant voor de beschreven applicatie te verduidelijken.
Feedback, een vraag of een melding van een probleem op deze specificatie kan gegeven worden via ons contactformulier.
Licentie
Deze specificatie van Informatie Vlaanderen is gepubliceerd onder de "Modellicentie Gratis Hergebruik - v1.0".
Conformiteit
Een implementatiemodel is een specificatie voor gegevensuitwisseling dat bijkomende beperkingen introduceert voor het toepassen van vocabularia. Dergelijke bijkomende beperkingen kunnen de volgende elementen bevatten:
- verfijning van de terminologie (klassen en eigenschappen) consistent met de semantiek uit de betreffende specificaties met een welbepaald gebruik als doel;
- externe terminologie (klassen en eigenschappen) gebruikt voor nieuwe/extra termen die niet in de bestaande vocabularia voorkomen.
Om conform te zijn met dit implementatiemodel, geldt voor een implementatie dat ze:
- MOET Voor elke klasse steeds de eigenschappen bevatten die als minimum kardinaliteit 1 hebben.
- MAG NIET meer dan 1 instantie bevatten van eigenschappen die 1 als maximum kardinaliteit hebben.
- MAG terminologie (klassen en eigenschappen) gebruiken op een manier die consistent is met haar semantiek (definitie, gebruik, domein en bereik).
- MAG NIET terminologie van andere gecontroleerde vocabularia gebruiken dan diegene die gedefinieerd wordt in dit implementatiemodel.
- MAG uitgebreid worden met klassen en eigenschappen van andere datamodellen (vocabularia) die niet overlappen met terminologie uit dit implementatiemodel.
Overzicht
In dit document wordt correct gebruik van de volgende entiteiten toegelicht:
|
Agent |
AIM databank status |
AIM naam object |
AIM object |
AIM Toestand |
Bevestiging |
Derdenobject |
heeft betrokkene |
Ligt op |
Naampad object |
Sluit aan op |
Sturing |
Voedt |
In dit document worden de volgende datatypes toegelicht:
|
Adres |
Bestandsbijlage |
Boolean |
Contactinfo |
Datum |
Identificator |
Openingsurenspecificatie |
String |
Tekstblok |
Tijd |
URI |
Entiteiten
Agent
- Beschrijving
- Iemand die of iets dat kan handelen of een effect kan teweeg brengen.
- Eigenschappen
- Voor deze entiteit zijn de volgende eigenschappen gedefinieerd: agent identificatie, Contactinfo, heeft betrokkene, naam.
Eigenschap | Verwacht Type | Kardinaliteit | Beschrijving | Gebruik | Codelijst |
---|---|---|---|---|---|
agent identificatie
|
Identificator | 1 | Identificatie van de agent volgens een bepaalde bron. | ||
Contactinfo
|
Contactinfo | 1..* | Algemene contactgegevens voor de agent. | ||
heeft betrokkene
|
Agent | Koppelt een natuurlijk persoon,rechtspersoon of een hoedanigheid (een functie eerder dan de persoon die de functie uitoefent) aan een object in een bepaalde rol. | |||
naam
|
String | 1 | De naam waarmee de agent doorgaans benoemd wordt. |
AIM databank status
- Beschrijving
- Voegt een attribuut toe aan de subklasse dat aangeeft of de asset zichtbaar is in de databank of (zacht) verwijderd is.
- Eigenschappen
- Voor deze entiteit zijn de volgende eigenschappen gedefinieerd: is actief.
AIM naam object
- Beschrijving
- Abstracte als de basisklasse voor elk OTL object dat benoemd wordt met een mensleesbare identificator.
- Subklasse van
- AIM object
- Eigenschappen
- Voor deze entiteit zijn de volgende eigenschappen gedefinieerd: naam.
Eigenschap | Verwacht Type | Kardinaliteit | Beschrijving | Gebruik | Codelijst |
---|---|---|---|---|---|
naam
|
String | 1 | De mensleesbare naam van een asset zoals dit bv. ook terug te vinden is op een etiket op het object zelf. De assetbeheerder kent deze naam toe of geeft de opdracht om deze toe te kennen. Indien een object een algemeen gangbare naam heeft zoals bv. bij een waterloop dan wordt deze gebruikt. |
AIM object
- Beschrijving
- Abstracte als de basisklasse voor alle uniek geïdentificeerde OTL objecten met de basiseigenschappen die elk OTL object minstens heeft.
- Subklasse van
- AIM Toestand, AIM databank status
- Eigenschappen
- Voor deze entiteit zijn de volgende eigenschappen gedefinieerd: asset-id, bestekpostnummer, bevestiging, datum oprichting object, heeft betrokkene, ligt op, notitie, sluit aan op, standaardbestekpostnummer, sturing, type URI, voedt.
Eigenschap | Verwacht Type | Kardinaliteit | Beschrijving | Gebruik | Codelijst |
---|---|---|---|---|---|
asset-id
|
Identificator | 1 | Unieke identificatie van de asset zoals toegekend door de assetbeheerder of n.a.v. eerste aanlevering door de leverancier. | ||
bestekpostnummer
|
String | 1..* | Een verwijzing naar een postnummer uit het specifieke bestek waar het object mee verband houdt. | ||
bevestiging
|
Derdenobject | Deze relatie geeft aan dat twee onderdelen direct fysiek op elkaar bevestigd zijn. Dit kan zowel aan de buitenkant als aan de binnenkant zijn zoals bv. een camera aan een paal of een laagspanningsbord in een kast. Deze relatie heeft geen richting. | |||
datum oprichting object
|
Datum | 1 | Datum van de oprichting van het object. | ||
heeft betrokkene
|
Agent | Koppelt een natuurlijk persoon,rechtspersoon of een hoedanigheid (een functie eerder dan de persoon die de functie uitoefent) aan een object in een bepaalde rol. | |||
ligt op
|
Derdenobject | Deze relatie geeft aan dat 2 onderdelen direct fysiek op elkaar liggen. Deze relatie heeft een richting en gaat van het bovenste naar het onderste onderdeel. | |||
notitie
|
String | 1 | Extra notitie voor het object. | ||
sluit aan op
|
Derdenobject | Deze relatie geeft aan hoe 2 onderdelen in horizontale zin elkaar opvolgen. Dit wordt gebruikt om een topologische netwerk op te bouwen. Enkel in gebruik bij afschermende constructies en riolering/waterlopen. Deze relatie heeft steeds een richting van het opwaartse naar het afwaartse onderdeel. | |||
standaardbestekpostnummer
|
String | 1..* | Een verwijzing naar een postnummer uit het standaardbestek waar het object mee verband houdt. De notatie van het postnummer moet overeenkomen met de notatie die gebruikt is in de catalogi van standaardbestekken, bijvoorbeeld postnummer 0701.20404G. | ||
sturing
|
Derdenobject | Deze relatie geeft aan of er een of andere vorm van dataverkeer is tussen 2 onderdelen. Een wegverlichtingstoestel dat aan staat wordt ook als sturing beschouwd, in dit geval is het een lang ononderbroken elektrisch aan-signaal. Deze relatie heeft geen richting. | |||
type URI
|
URI | 1 | De URI van het object volgens https://www.w3.org/2001/XMLSchema#anyURI . | ||
voedt
|
Derdenobject | Deze relatie wordt enkel gelegd naar onderdelen die permanent onder spanning staan in normaal bedrijf. Aan deze relatie wordt steeds een richting toegekend van de voedinggever naar de ontvanger. |
AIM Toestand
- Beschrijving
- Voegt een attribuut toe aan de subklasse dat de huidige stand in de levenscyclus van het object aangeeft.
- Eigenschappen
- Voor deze entiteit zijn de volgende eigenschappen gedefinieerd: toestand.
Eigenschap | Verwacht Type | Kardinaliteit | Beschrijving | Gebruik | Codelijst |
---|---|---|---|---|---|
toestand
|
AIM toestand | 1 | Geeft de actuele stand in de levenscyclus van het object. | Link |
Bevestiging
- Beschrijving
- Deze relatie geeft aan dat twee onderdelen direct fysiek op elkaar bevestigd zijn. Dit kan zowel aan de buitenkant als aan de binnenkant zijn zoals bv. een camera aan een paal of een laagspanningsbord in een kast. Deze relatie heeft geen richting.
- Subklasse van
- Niet-directionele relatie
- Eigenschappen
- Voor deze entiteit zijn geen eigenschappen gedefinieerd.
Derdenobject
- Beschrijving
- Object niet in eigendom van de assetbeheerder dat zonder verdere typering bewaard wordt om relaties met getypeerde assets te kunnen beheren.
- Subklasse van
- AIM Toestand, AIM databank status
- Eigenschappen
- Voor deze entiteit zijn de volgende eigenschappen gedefinieerd: asset-id, bevestiging, contactgegevens, foto, heeft aansluitkast geïntegreerd, heeft betrokkene, ligt op, omschrijving, sluit aan op, sturing, type URI, voedt.
Eigenschap | Verwacht Type | Kardinaliteit | Beschrijving | Gebruik | Codelijst |
---|---|---|---|---|---|
asset-id
|
Identificator | 1 | Unieke identificatie van de asset zoals toegekend door de assetbeheerder of n.a.v. eerste aanlevering door de leverancier. | ||
bevestiging
|
AIM object | Deze relatie geeft aan dat twee onderdelen direct fysiek op elkaar bevestigd zijn. Dit kan zowel aan de buitenkant als aan de binnenkant zijn zoals bv. een camera aan een paal of een laagspanningsbord in een kast. Deze relatie heeft geen richting. | |||
contactgegevens
|
String | 1 | Naam, voornaam, telefoonnummer en/of e-mailadres van de contactpersoon. | ||
foto
|
Bestandsbijlage | 1..* | Een foto van het derdenobject die eventuele detailinformatie weergeeft | Enkel bestanden die een foto zijn. | |
heeft aansluitkast geïntegreerd
|
Boolean | 1 | Aanduiding of de aansluitkast geïntegreerd is. | ||
heeft betrokkene
|
Agent | Koppelt een natuurlijk persoon,rechtspersoon of een hoedanigheid (een functie eerder dan de persoon die de functie uitoefent) aan een object in een bepaalde rol. | |||
ligt op
|
AIM object | Deze relatie geeft aan dat 2 onderdelen direct fysiek op elkaar liggen. Deze relatie heeft een richting en gaat van het bovenste naar het onderste onderdeel. | |||
omschrijving
|
String | 1 | Omschrijving van het derdenobject | ||
sluit aan op
|
AIM object | Deze relatie geeft aan hoe 2 onderdelen in horizontale zin elkaar opvolgen. Dit wordt gebruikt om een topologische netwerk op te bouwen. Enkel in gebruik bij afschermende constructies en riolering/waterlopen. Deze relatie heeft steeds een richting van het opwaartse naar het afwaartse onderdeel. | |||
sturing
|
AIM object | Deze relatie geeft aan of er een of andere vorm van dataverkeer is tussen 2 onderdelen. Een wegverlichtingstoestel dat aan staat wordt ook als sturing beschouwd, in dit geval is het een lang ononderbroken elektrisch aan-signaal. Deze relatie heeft geen richting. | |||
type URI
|
URI | 1 | De URI van het object volgens https://www.w3.org/2001/XMLSchema#anyURI . | ||
voedt
|
AIM object | Deze relatie wordt enkel gelegd naar onderdelen die permanent onder spanning staan in normaal bedrijf. Aan deze relatie wordt steeds een richting toegekend van de voedinggever naar de ontvanger. |
heeft betrokkene
- Beschrijving
- Koppelt een natuurlijk persoon,rechtspersoon of een hoedanigheid (een functie eerder dan de persoon die de functie uitoefent) aan een object in een bepaalde rol.
- Subklasse van
- Directionele relatie
- Eigenschappen
- Voor deze entiteit zijn de volgende eigenschappen gedefinieerd: rol, specifieke contactinfo.
Eigenschap | Verwacht Type | Kardinaliteit | Beschrijving | Gebruik | Codelijst |
---|---|---|---|---|---|
rol
|
Betrokkenheid rol | 1 | Type voor de manier waarop een agent betrokken is bij een object. | Link | |
specifieke contactinfo
|
Contactinfo | 0..* | Specifieke contactgegevens van de betrokken agent met betrekking tot het gekoppelde object. |
Ligt op
- Beschrijving
- Deze relatie geeft aan dat 2 onderdelen direct fysiek op elkaar liggen. Deze relatie heeft een richting en gaat van het bovenste naar het onderste onderdeel.
- Subklasse van
- Directionele relatie
- Eigenschappen
- Voor deze entiteit zijn geen eigenschappen gedefinieerd.
Naampad object
- Beschrijving
- Abstracte als de basisklasse voor elk OTL object dat gebruik maakt van een naampad.
- Subklasse van
- AIM naam object
- Eigenschappen
- Voor deze entiteit zijn de volgende eigenschappen gedefinieerd: naampad.
Sluit aan op
- Beschrijving
- Deze relatie geeft aan hoe 2 onderdelen in horizontale zin elkaar opvolgen. Dit wordt gebruikt om een topologische netwerk op te bouwen. Enkel in gebruik bij afschermende constructies en riolering/waterlopen. Deze relatie heeft steeds een richting van het opwaartse naar het afwaartse onderdeel.
- Subklasse van
- Directionele relatie
- Eigenschappen
- Voor deze entiteit zijn geen eigenschappen gedefinieerd.
Sturing
- Beschrijving
- Deze relatie geeft aan of er een of andere vorm van dataverkeer is tussen 2 onderdelen. Een wegverlichtingstoestel dat aan staat wordt ook als sturing beschouwd, in dit geval is het een lang ononderbroken elektrisch aan-signaal. Deze relatie heeft geen richting.
- Subklasse van
- Niet-directionele relatie
- Eigenschappen
- Voor deze entiteit zijn geen eigenschappen gedefinieerd.
Voedt
- Beschrijving
- Deze relatie wordt enkel gelegd naar onderdelen die permanent onder spanning staan in normaal bedrijf. Aan deze relatie wordt steeds een richting toegekend van de voedinggever naar de ontvanger.
- Subklasse van
- Directionele relatie
- Eigenschappen
- Voor deze entiteit zijn de volgende eigenschappen gedefinieerd: aansluitvermogen.
Eigenschap | Verwacht Type | Kardinaliteit | Beschrijving | Gebruik | Codelijst |
---|---|---|---|---|---|
aansluitvermogen
|
KwantWrdInVolt | 1 | Vermogen van de aansluiting, dit wordt enkel ingevuld op voedingsrelaties voorbij de hoofdschakelaar. |
Datatypes
Adres
- Beschrijving
- Complex datatype voor de aanduiding van een bepaalde locatie,doorgaans van een huis,woning,gebouw of faciliteit,op de aarde.
- Eigenschappen
- Voor dit datatype zijn de volgende eigenschappen gedefinieerd: bus, gemeente, huisnummer, postcode, provincie, straatnaam.
Eigenschap | Verwacht Type | Kardinaliteit | Beschrijving | Gebruik | Codelijst |
---|---|---|---|---|---|
bus
|
String | 1 | Een nummer dat de postbus aanduidt. | ||
gemeente
|
Gemeente | 1 | De bestuurlijke eenheid waarin het adres gelegen is. | Link | |
huisnummer
|
String | 1 | Een nummer dat door de gemeente aan bv. een huis wordt toegekend. | ||
postcode
|
String | 1 | Een korte reeks tekens die in het postadres wordt opgenomen. | ||
provincie
|
Provincie | 1 | Het deelgebied waarin het adres gelegen is. | Link | |
straatnaam
|
String | 1 | De naam van de straat. |
Bestandsbijlage
- Beschrijving
- Complex datatype voor alle bestandsbijlages
- Eigenschappen
- Voor dit datatype zijn de volgende eigenschappen gedefinieerd: bestandsnaam, mime-type, omschrijving, uri.
Eigenschap | Verwacht Type | Kardinaliteit | Beschrijving | Gebruik | Codelijst |
---|---|---|---|---|---|
bestandsnaam
|
String | 1 | De naam van het Document inclusief de bestandsextensie, van de naam gescheiden door een punt. | ||
mime-type
|
Mimetype | 1 | Het MIME type van het document. | Link | |
omschrijving
|
Tekstblok | 1 | Een korte toelichting over waar het document juist voor dient. | ||
uri
|
URI | 1 | De verwijzing naar de bestandslocatie via een link. Bij lokale bestanden kan dit eventueel ook een pad zijn. |
Boolean
- Beschrijving
- Beschrijft een boolean volgens http://www.w3.org/2001/XMLSchema#boolean
- Gebruik
- https://www.w3.org/TR/xmlschema-2/#boolean
- Eigenschappen
- Voor dit datatype zijn geen eigenschappen gedefinieerd.
Contactinfo
- Beschrijving
- Complex datatype voor de informatie zoals email,telefoon,adres die toelaat om iemand of iets te contacteren.
- Eigenschappen
- Voor dit datatype zijn de volgende eigenschappen gedefinieerd: adres, beschikbaarheid, contactnaam, email, fax, opmerkingen, telefoon, website.
Eigenschap | Verwacht Type | Kardinaliteit | Beschrijving | Gebruik | Codelijst |
---|---|---|---|---|---|
adres
|
Adres | 0..1 | Adres dat men kan aanschrijven of bezoeken. | ||
beschikbaarheid
|
Openingsurenspecificatie | 0..* | Periode waarin contact kan worden opgenomen. | ||
contactnaam
|
String | 0..1 | Naam van bv. de persoon die men kan contacteren. | ||
email
|
String | 0..1 | Email-adres waarnaar men kan mailen. | ||
fax
|
String | 0..1 | Faxnummer waarnaar men kan faxen. | ||
opmerkingen
|
String | 0..1 | Bijkomende informatie met betrekking tot het gebruik van de contactgegevens. | ||
telefoon
|
String | 0..1 | Telefoonnummer waarop men kan bellen. | ||
website
|
String | 0..1 | Website waarnaar men kan surfen. |
Datum
- Beschrijving
- Beschrijft een datum volgens http://www.w3.org/2001/XMLSchema#date
- Gebruik
- https://www.w3.org/TR/xmlschema-2/#date
- Eigenschappen
- Voor dit datatype zijn geen eigenschappen gedefinieerd.
Identificator
- Beschrijving
- Complex datatype voor de identificator van een AIM object volgens de bron van de identificator.
- Eigenschappen
- Voor dit datatype zijn de volgende eigenschappen gedefinieerd: identificator, toegekend door.
Eigenschap | Verwacht Type | Kardinaliteit | Beschrijving | Gebruik | Codelijst |
---|---|---|---|---|---|
identificator
|
String | 1 | Een groep van tekens om een AIM object te identificeren of te benoemen. | ||
toegekend door
|
String | 1 | Gegevens van de organisatie die de toekenning deed. |
Openingsurenspecificatie
- Beschrijving
- Complex datatype dat de openingsuren volgens https://schema.org/OpeningHoursSpecification specifieert.
- Eigenschappen
- Voor dit datatype zijn de volgende eigenschappen gedefinieerd: openingstijd, sluitingstijd, weekdag.
Eigenschap | Verwacht Type | Kardinaliteit | Beschrijving | Gebruik | Codelijst |
---|---|---|---|---|---|
openingstijd
|
Tijd | 1 | Het tijdsstip waarop de opening plaatsvindt. | ||
sluitingstijd
|
Tijd | 1 | Het tijdsstip waarop de sluiting plaatsvindt. | ||
weekdag
|
Weekdagen | 1 | Een dag uit de week incl. weekenddagen. | Link |
String
- Beschrijving
- Beschrijft een tekstregel volgens http://www.w3.org/2001/XMLSchema#string
- Gebruik
- https://www.w3.org/TR/xmlschema-2/#string
- Eigenschappen
- Voor dit datatype zijn geen eigenschappen gedefinieerd.
Tekstblok
- Beschrijving
- Een tekst welke uit meerdere zinnen bestaat,en ook regeleindes kan bevatten. Een tekstblok bevat maximaal 65.000 karakters.
- Eigenschappen
- Voor dit datatype zijn de volgende eigenschappen gedefinieerd: waarde.
Tijd
- Beschrijving
- Beschrijft een tijd volgens http://www.w3.org/2001/XMLSchema#time
- Gebruik
- https://www.w3.org/TR/xmlschema-2/#time
- Eigenschappen
- Voor dit datatype zijn geen eigenschappen gedefinieerd.
URI
- Beschrijving
- Een tekstwaarde die een verwijzing naar meer informatie van het element bevat volgens http://www.w3.org/2001/XMLSchema#anyURI .
- Gebruik
- https://www.w3.org/TR/xmlschema-2/#anyURI
- Eigenschappen
- Voor dit datatype zijn geen eigenschappen gedefinieerd.
SQLite download
Een herbruikbare SQLite database van alle implementatiemodellen is terug te vinden op: SQLite download
JSON-LD context
(niet normatief)Een herbruikbare JSON-LD context definitie voor dit implementatiemodel is terug te vinden op: /doc/implementatiemodel/aim-object/ontwerpdocument/1.0.0/context/aim-object.jsonld
SHACL template
(niet normatief)Een herbruikbare SHACL template definitie voor dit implementatiemodel is terug te vinden op: /doc/implementatiemodel/aim-object/ontwerpdocument/1.0.0/context/aim-object-SHACL.ttl
Auteurs en medewerkers
- Auteurs
- Medewerkers