Handleiding ART-DECOR documentatie: verschil tussen versies

Uit informatiestandaarden
Ga naar: navigatie, zoeken
(Nieuwe pagina aangemaakt met '=Handleiding ART-DECOR documentatie= De volgende onderdelen worden in ART-DECOR uitgewerkt: dataset, dataelementen, terminologie, scenario’s, transactiegroepen e...')
 
Regel 1: Regel 1:
=Handleiding ART-DECOR documentatie=
 
 
 
De volgende onderdelen worden in ART-DECOR uitgewerkt: dataset, dataelementen, terminologie, scenario’s, transactiegroepen en transacties en technische specificaties (templates). DECOR is een methodologie om de gegevensbehoefte van zorgverleners vast te leggen en deze te gebruiken om diverse artefacten te genereren, ART is de user interface voor DECOR om DECOR bestanden te maken, te bewerken en de benodigde artefacten er uit te genereren. Een uitgebreide toelichting op ART-DECOR is te vinden op de [http://decor.nictiz.nl/wiki/index.php/Documentatie_DECOR ART-DECOR Wiki].
 
De volgende onderdelen worden in ART-DECOR uitgewerkt: dataset, dataelementen, terminologie, scenario’s, transactiegroepen en transacties en technische specificaties (templates). DECOR is een methodologie om de gegevensbehoefte van zorgverleners vast te leggen en deze te gebruiken om diverse artefacten te genereren, ART is de user interface voor DECOR om DECOR bestanden te maken, te bewerken en de benodigde artefacten er uit te genereren. Een uitgebreide toelichting op ART-DECOR is te vinden op de [http://decor.nictiz.nl/wiki/index.php/Documentatie_DECOR ART-DECOR Wiki].
  
 
Enkele extra toelichtingen zijn hieronder in dit document te vinden.
 
Enkele extra toelichtingen zijn hieronder in dit document te vinden.
  
==DECOR met "twee gezichten"==
+
=DECOR met "twee gezichten"=
  
 
De informatie die DECOR documenteert kan op twee manieren ingezien worden: met een statische HTML versie en met een interactieve versie.
 
De informatie die DECOR documenteert kan op twee manieren ingezien worden: met een statische HTML versie en met een interactieve versie.
Regel 17: Regel 15:
 
Voor extra uitleg zie: [http://vimeo.com/54511848 deze film].
 
Voor extra uitleg zie: [http://vimeo.com/54511848 deze film].
  
==DECOR tabbladen==
+
=DECOR tabbladen=
  
===Tabblad Voorblad===
+
==Tabblad Voorblad==
  
 
Bevat algemene projectinformatie: onder andere op welk moment (datum en tijd) de set is aangemaakt en welke organisaties betrokken zijn geweest bij het samenstellen.
 
Bevat algemene projectinformatie: onder andere op welk moment (datum en tijd) de set is aangemaakt en welke organisaties betrokken zijn geweest bij het samenstellen.
  
===Tabblad Projectinformatie===
+
==Tabblad Projectinformatie==
  
 
Bevat algemene projectinformatie over het project en versiehistorie.
 
Bevat algemene projectinformatie over het project en versiehistorie.
  
===Tabblad Datasets===
+
==Tabblad Datasets==
  
 
Bevat [http://decor.nictiz.nl/wiki/index.php/Datasets_(DECOR) Datasets].
 
Bevat [http://decor.nictiz.nl/wiki/index.php/Datasets_(DECOR) Datasets].
  
===Tabblad Scenarios===
+
==Tabblad Scenarios==
 
Bevat scenario's en transacties.
 
Bevat scenario's en transacties.
  
Regel 40: Regel 38:
 
Dit tabblad toont voor iedere transactie de bijbehorende datasetconcepten.
 
Dit tabblad toont voor iedere transactie de bijbehorende datasetconcepten.
  
===Tabblad Identificaties===
+
==Tabblad Identificaties==
  
 
Op dit tabblad is een overzicht gegeven van de gebruikte OID's.
 
Op dit tabblad is een overzicht gegeven van de gebruikte OID's.
  
===Tabblad Terminologie===
+
==Tabblad Terminologie==
  
 
Bevat value sets (waardenlijsten), deze hebben een naam en een versie datum. De templates specificeren welke waarden een bepaald xml element of attribuut mag hebben door links op te nemen naar valuesets.
 
Bevat value sets (waardenlijsten), deze hebben een naam en een versie datum. De templates specificeren welke waarden een bepaald xml element of attribuut mag hebben door links op te nemen naar valuesets.
Regel 61: Regel 59:
 
Value sets downloaden kan met behulp van [http://decor.nictiz.nl/wiki/index.php/URIs REST-gebaseerde services van ART-DECOR], zie de [http://decor.nictiz.nl/decor/services/ValueSetIndex Valueset index].
 
Value sets downloaden kan met behulp van [http://decor.nictiz.nl/wiki/index.php/URIs REST-gebaseerde services van ART-DECOR], zie de [http://decor.nictiz.nl/decor/services/ValueSetIndex Valueset index].
  
===Tabblad Regels===
+
==Tabblad Regels==
  
 
De HL7v3-inhoud van de templates is op dit tabblad vastgelegd. De elementen in de template worden beschreven in de volgorde waarin zij voorkomen in een bericht (XML).
 
De HL7v3-inhoud van de templates is op dit tabblad vastgelegd. De elementen in de template worden beschreven in de volgorde waarin zij voorkomen in een bericht (XML).

Versie van 16 okt 2015 om 12:39

De volgende onderdelen worden in ART-DECOR uitgewerkt: dataset, dataelementen, terminologie, scenario’s, transactiegroepen en transacties en technische specificaties (templates). DECOR is een methodologie om de gegevensbehoefte van zorgverleners vast te leggen en deze te gebruiken om diverse artefacten te genereren, ART is de user interface voor DECOR om DECOR bestanden te maken, te bewerken en de benodigde artefacten er uit te genereren. Een uitgebreide toelichting op ART-DECOR is te vinden op de ART-DECOR Wiki.

Enkele extra toelichtingen zijn hieronder in dit document te vinden.

DECOR met "twee gezichten"

De informatie die DECOR documenteert kan op twee manieren ingezien worden: met een statische HTML versie en met een interactieve versie.

De HTML versie bevat een statische, “bevroren” versie van de DECOR bestanden op een bepaald tijdstip: een DECOR publicatie (publicatie datum). De HTML versie is niet interactief, dat wil zeggen dat er geen wijzigingen kunnen worden gemaakt. Wel kan men de verschillende aspecten (zichten) van DECOR inzien met de verschillende tabbladen. De versie-informatie is te zien op het voorblad (tevens ook de aanmaakdatum van het HTML uittreksel).

Ten tweede is een interactieve versie beschikbaar met een gebruikers-interface, ART (Advanced Requirements Tooling) genoemd, om naast het inzien van DECOR gegevens ook wijzigingen door te voeren en DECOR te beheren.

Voor extra uitleg zie: deze film.

DECOR tabbladen

Tabblad Voorblad

Bevat algemene projectinformatie: onder andere op welk moment (datum en tijd) de set is aangemaakt en welke organisaties betrokken zijn geweest bij het samenstellen.

Tabblad Projectinformatie

Bevat algemene projectinformatie over het project en versiehistorie.

Tabblad Datasets

Bevat Datasets.

Tabblad Scenarios

Bevat scenario's en transacties.

Scenario's vertegenwoordigen gebruiksscenario's, ook wel bekend als use cases waarin één of meerdere actoren met elkaar in een (deel)proces zitten en processtappen doorlopen op basis van één of meer transacties.

Transacties zijn vrijwel altijd een vorm van (berichtgebaseerde) communicatie, zoals een HL7v3-interactie. Transacties hebben meestal een gedefinieerde (keuze van) reactie. Iedere transactie gebruikt een deelverzameling van de concepten uit de dataset. Transacties en, indien van toepassing, hun reacties worden gebundeld in een transactiegroep.

Dit tabblad toont voor iedere transactie de bijbehorende datasetconcepten.

Tabblad Identificaties

Op dit tabblad is een overzicht gegeven van de gebruikte OID's.

Tabblad Terminologie

Bevat value sets (waardenlijsten), deze hebben een naam en een versie datum. De templates specificeren welke waarden een bepaald xml element of attribuut mag hebben door links op te nemen naar valuesets.

Van sommige value sets zijn meerdere versies beschikbaar.

Screenshot terminologie.png
Figuur 1 Decor template met meta informatie, elementen en attributen plus de weergave van de inperkingen.

Een dynamische binding van een value set gebruikt altijd de meest recente versie. Een statische binding van een value set vermeldt welke versie van toepassing is.

Value sets downloaden kan met behulp van REST-gebaseerde services van ART-DECOR, zie de Valueset index.

Tabblad Regels

De HL7v3-inhoud van de templates is op dit tabblad vastgelegd. De elementen in de template worden beschreven in de volgorde waarin zij voorkomen in een bericht (XML). Elke template kan de volgende onderdelen bevatten:

  • Naam
  • Identificatie (OID)
  • Omschrijving
  • Versie
  • XML-voorbeeld
  • Eén of meerdere HL7v3-elementen

Elk HL7v3-element kan de volgende onderdelen bevatten:

  • Elementnaam
  • Omschrijving
  • Kardinaliteit
  • Conformanceregel(s)
  • XML-voorbeeld
  • Nul of meerdere HL7v3-elementen

Vervolgens wordt een toelichting op de belangrijkste begrippen gegeven.

Element - een XML-element van een interactie, een „context node‟ zoals die in de XML-structuur van de interactie voorkomt. Element komt in het model (D-MIM / R-MIM) overeen met een klasse (Role, RoleLink, Entity, Act, ActRelationship, Participation</blue>).

XML-attribuut - onderdeel van het element dat beschreven wordt. Een onderdeel kan in XML een attribuut of een element zijn. Onderdelen die beginnen met een @ zijn een XML-attribuut; de overige onderdelen zijn een XML-element.

Data type - Indien van toepassing wordt hier de data type van een element weergegeven (voorbeelden zijn “TS” timestamp, “CE” coded element enz.)

Kardinaliteit - De kardinaliteit bepaalt het aantal keer dat het onderdeel mag/moet voorkomen. Hierbij wordt ook aangegeven of het onderdeel mandatory (vereist), required (verplicht ondersteunen eventueel met nullFlavor)of optioneel (niet verplicht; is de standaard waarde) is. Conditioneel verplichting is in de conformanceregels opgenomen.

Decor template.png
Figuur 2 Decor template: een XML element "medicationDispenseEvent" (in de HL7 namespace), een attribuut @classCode met de vaste waarde "SPLY" en een @moodCode met de vaste waarde "EVN".

Conformanceregel - beschrijft de regels waaraan het onderdeel moet voldoen. Hierin worden verplichte of standaard waarden voorgeschreven.

Decor template2.png
Figuur 3 Decor template: een XML element “code” (in de HL7 namespace), met data type “CE” (code), required aan te geven (1..1 R) met de beschreven de @code en @codeSystem;


Tabblad Issues

Issues

Tabblad Compilatie

Kan - in de runtime-versie - problemen en waarschuwingen bevatten.

Tabblad Colofon

Bevat het Colofon.

Uitgangspunten

Artefacten versionering

Data elementen, value sets, scenario's en regels die in DECOR zijn gedefinieerd hebben een aantal attributen voor versiebeheer. Belangrijkste eigenschappen zijn

  • een identificatie (OID) en
  • een naam een begin- en einddatum van geldigheid en
  • een status (nieuw, geldig, niet meer te gebruiken).

In het kopje van de desbetreffende artefacten is de naam en de id samen met de versiedatum te zien. Bovendien is de status van het element met een kleuren balletje aangegeven.

De status is weergeven met een kleur, groen voor “actief”, rood hier als voorbeeld voor “niet meer gebruiken” en geel/oranje voor “in ontwikkeling” (draft).

Er zijn strikte regels voor het toekennen van OID's aan "nieuwe" versies van objecten.