Element validity

Element validity

Informatie over de geldigheid wordt opgenomen in het verplichte element validity. Geldigheid is hierbij gedefinieerd als “het situatieonderdeel is actief, is vindbaar op de weg, etc.”. Bij aangekondigde wegwerkzaamheden valt bijvoorbeeld af te leiden wanneer de werkzaamheden zijn.

Opbouw van het element ziet er als volgt uit:

../../_images/element_validity.png
Type Verplicht
nvt Ja

Subelementen

The validityStatus element

Dit element beschrijft hoe de geldigheid van het situatie onderdeel wordt beschreven. Binnen het Nederlands profiel DATEX II is afgesproken dat de geldigheid altijd afgeleid wordt uit de inhoud van validityTimeSpecification.

This element describes how the validity of the situation component should be described.

Notitie

Agreements have been made within the Dutch DATEX II Profile that the validity is always derived from the content of the validityTimeSpecification.

Type: Verplicht Domein
ValidityStatusEnum Ja definedByValidityTimeSpec

Element overrunning

Het element geeft aan dat een onderdeel nog geldig/actief is, terwijl een eerder aangekondigd eindtijdstip al is gepasseerd. Dit element dient verplicht, en anders niet, gebruikt te worden.

Type: Verplicht Domein
Boolean Ja of niet gebruikt true

Element validityTimeSpecification

Met het element validityTimeSpecification wordt de periode waarin het betreffende situatie-onderdeel geldig is aangegeven. Dit wordt gedaan aan de hand van een aantal subelementen.

Elementen

Element overallStartTime

Dit element beschrijft het eerste tijdstip dat het gehele situatie-onderdeel geldig wordt of geworden is.

Type: Verplicht Domein
DateTime Ja Datum en tijd in UTC (Zulu notatie)
Element overallEndTime

Met het element overallEndTime wordt het laatste tijdstip aangegeven dat het situatie-onderdeel ongeldig wordt. Als het element wordt weggelaten is de eindtijd onbekend.

Notitie

Bij een aantal leveranciers wordt hier bij een gebeurtenis de overallEndTime standaard 24 uur na de overallStartTime gezet.

Type: Verplicht Domein
DateTime Nee Datum en tijd in UTC (Zulu notatie)
Element validPeriod

Het situatie-onderdeel hoeft niet de gehele periode tussen overallStartTime en overallEndTime geldig te zijn. Bij zich herhalende werkzaamheden bijvoorbeeld, vallen alle perioden waarin de werkzaamheden daadwerkelijk plaatsvinden in die periode. In een dergelijk geval worden één of meer validPeriod elementen gebruikt om de geldigheidsperiode in te perken. In de praktijk wordt dit weinig gebruikt op deze wijze, maar is theoretisch mogelijk.

De elementen validPeriod en exceptionPeriod mogen niet door elkaar gebruikt worden. Hierdoor zal altijd maar één van de twee voorkomen. Sommige van de subelementen zijn verplicht. Het element validPeriod dient tenminste één van de subelementen te bevatten.

Elementen
Element startOfPeriod

Dit element beschrijft de start van een periode waarop het situatieonderdeel geldig wordt of is geworden (validPeriod) of de start van de periode dat het situatieonderdeel is uitgesloten (exceptionPeriod). Indien dit element wordt weggelaten dan geldt de waarde van overallStartTime als starttijd voor de periode die met deze validPeriod wordt beschreven.

Dit element is verplicht, behalve voor een validPeriod die de enige periode beschrijft binnen overallTime of als het aanleverende systeem niet in staat is om de periode in gedefinieerde tijdstippen uit te drukken.

Type: Verplicht Domein
DateTime Nee Datum en tijd in UTC (Zulu notatie)
Element EndOfPeriod

Dit element beschrijft het einde van een periode waarop het situatieonderdeel geldig wordt of is geworden (validPeriod) of het einde van de periode dat het situatieonderdeel is uitgesloten (exceptionPeriod). Indien dit element is weggelaten eindigt deze periode op het in overallEndTime gespecificeerde tijdstip. Indien ook dit tijdstip niet is gespecificeerd is de eindtijd onbekend. Dit kan niet bij een exceptionPeriod daarbij moet een eindtijd bekend zijn.

Dit element is verplicht, behalve voor een validPeriod die de enige periode beschrijft binnen overallTime of als het aanleverende systeem niet in staat is om de periode in gedefinieerde tijdstippen uit te drukken.

Type: Verplicht Domein
DateTime Zie hierboven Datum en tijd in UTC (Zulu notatie)
Element periodName

Indien systemen niet in staat zijn om de periode in gedefinieerde tijdstippen uit te drukken kan gebruik gemaakt worden van tekstuele beschrijvingen. Gebruik van dit element wordt ontmoedigd aangezien het niet automatisch verwerkt kan worden.

Type: Verplicht Domein
MultilingualString Nee nvt

Binnen validPeriod en exceptionPeriod is het ook mogelijke om vaste terugkeerpatronen vast te leggen.

Element exceptionPeriod

Het situatie-onderdeel hoeft niet de gehele periode tussen overallStartTime en overallEndTime geldig te zijn. Met behulp van het element exceptionPeriod kunnen één of meer perioden tussen overallStartTime en overallEndTime worden uitgesloten.

Waarschuwing

Het gebruik van exceptionPeriod is ongewenst. De semantische betekenis is dat in het tijdsinterval dat binnen de exceptionPeriod valt de status in rust/inactief is.

De elementen exceptionPeriod en validPeriod mogen niet door elkaar gebruikt worden. Hierdoor zal altijd maar één van de twee voorkomen.

De gebruikte elementen zijn identiek aan die onder validPeriod

Voorbeeld

<validity>
  <validityStatus>definedByValidityTimeSpec</validityStatus>
  <validityTimeSpecification>
    <overallStartTime>2017-07-11T18:00:00Z</overallStartTime>
    <overallEndTime>2017-07-12T20:00:00Z</overallEndTime>
    <validPeriod>
      <startOfPeriod>2017-07-11T18:00:00Z</startOfPeriod>
      <endOfPeriod>2017-07-11T20:00:00Z</endOfPeriod>
      <periodName>
        <values>
          <value lang="nl">Blokkade 1</value>
        </values>
      </periodName>
    </validPeriod>
    <validPeriod>
      <startOfPeriod>2017-07-12T18:00:00Z</startOfPeriod>
      <endOfPeriod>2017-07-12T20:00:00Z</endOfPeriod>
      <periodName>
        <values>
          <value lang="nl">Blokkade 1</value>
        </values>
      </periodName>
    </validPeriod>
  </validityTimeSpecification>
</validity>