Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Expand
titleVersiegeschiedenis...


VersieDatumStatusWijzigingen
x.x.x





Beschrijving

Voor Koppeltaal maken we gebruik van verschillende resource types. De verschillende resource types gebruiken verschillende elementen om aan te geven of de resource content daadwerkelijk gebruikt en wat de status binnen de levenscyclus is. Dit laatste is extra van belang binnen koppeltaal omdat er gebruik wordt gemaakt van soft-deletes; resources worden in normaal gebruik nooit echt verwijderd, maar door middel van status worden ze op inactief gezet. Hiervoor wordt het element active of het element status gebruikt. Het element active is van het type 'boolean' en het element status heeft een lijstje van kiesbare enumeratie waarden. Elk resource in Koppeltaal heeft een active of status veld, en het veld heeft daadwerkelijk een betekenis. Als aanbieder en afnemer van de FHIR resources is het van belang de status van de resource goed te verwerken.

Overwegingen

Semantiek

De resources binnen FHIR hebben in sommige gevallen een active veld met een boolean waarde, en in andere resources is er een status veld met een lijst aan mogelijkheden. Aangezien Koppeltaal gebruik maakt van soft-deletes worden deze velden gebruikt om de levenscyclus van de FHIR resources aan te geven. We zijn ons ervan bewust dat hier het venijn in de details zit; enige vorm van misinterpretatie van de status tussen systemen binnen en/of tussen domeinen kan tot verwarring, fouten en mogelijk conflicten leiden. De kernvraag die steeds geldt is welk gedrag er bij welke status hoort. Mag een inactieve gebruiker inloggen? Mag een voltooide taak gestart worden? Waar mogelijk proberen we daar antwoord op te geven. Om zoveel mogelijk bij de bestaande standaarden en semantiek aan te sluiten werken we in de volgende volgorde:

  • Wat Koppeltaal specificeert.
  • Wat de FHIR specificatie zegt.

    Soft en Hard Delete

    In Koppeltaal wordt in normaal gebruik geen gebruik gemaakt van de delete functionaliteit, er wordt door middel van de status of active vlag aangegeven wat de huidige status van de levenscyclus van het FHIR object is. Echter, het gebruik van de delete blijft bestaan binnen koppeltaal in specifieke situaties zoals migraties en beheersscenario's, zoals de use case definitief verwijderen persoonsgegevens. Hoewel nog niet duidelijk is om welke situaties het exact gaat, voorzien we dat er in de toekomst gebruik gemaakt gaat worden van deze functionaliteit.

    Toepassing, restricties en eisen

    De FHIR specificatie

    Het volgende tabel is een lijstje van situaties per resource en de daarbij behorende element en waarde. Alle onderstaande waardes zijn ook terug te vinden via het profiel van iedere resource.

    Resource elementWaardeBetekenis
    ActivityDefinitionstatusdraftThis resource is still under development and is not yet considered to be ready for normal use.


    activeThis resource is ready for normal use.


    retiredThis resource has been withdrawn or superseded and should no longer be used.


    unknownThe authoring system does not know which of the status values currently applies for this resource. Note: This concept is not to be used for "other" - one of the listed statuses is presumed to apply, it's just not known which one.
    EndpointstatusactiveThis endpoint is expected to be active and can be used.


    suspendedThis endpoint is temporarily unavailable.


    errorThis endpoint has exceeded connectivity thresholds and is considered in an error state and should no longer be attempted to connect to until corrective action is taken.


    offThis endpoint is no longer to be used.


    entered-in-errorThis instance should not have been part of this patient's medical record.


    testThis endpoint is not intended for production usage.
    DevicestatusactiveThe device is available for use.


    inactiveThe device is no longer available for use.


    entered-in-error The device was entered in error and voided.


    unknownThe status of the device has not been determined.
    Taskstatuszie: statussen van een task
    PatientactivetrueThe patients record is in active use


    false

    The patients record is not in active use

    • Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules.
    • It is often used to filter patient lists to exclude inactive patients
    • Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.

    Requirements

    Need to be able to mark a patient record as not to be used because it was created in error.


    Comments

    If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient.

    PractitioneractivetrueThe practitioner's record is in active use.


    false

    The practitioner's record is not in active use.


    Requirements

    Need to be able to mark a practitioner record as not to be used because it was created in error.

    CareTeamstatusproposedThe care team has been drafted and proposed, but not yet participating in the coordination and delivery of patient care.


    activeThe care team is currently participating in the coordination and delivery of care.


    suspendedThe care team is temporarily on hold or suspended and not participating in the coordination and delivery of care.


    inactiveThe care team was, but is no longer, participating in the coordination and delivery of care.


    entered-in-errorThe care team should have never existed.
    OrganizationactivetrueThe organization's record is in active use.


    false

    The organization's record is not in active use.


    Requirement

    Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI.

    Comment

    This element is labeled as a modifier because it may be used to mark that the resource was created in error.

    SubscriptionstatusrequestedThe client has requested the subscription, and the server has not yet set it up.


    activeThe subscription is active.


    errorThe server has an error executing the notification.


    offToo many errors have occurred or the subscription has expired.



    Anchor
    statussen_task
    statussen_task
    Statussen van een task

    FHIR kent standaard een aantal mogelijke statussen voor een task. In de onderstaande tabel worden die aan Koppeltaal use cases gebonden, waaronder ook de launch.

    De onderstaande tabel is overgenomen uit business use case: Toewijzen en volgen taak. De behandelaar kan van iedere statuswijziging een notificatie ontvangen en op die manier de voortgang van uitvoering blijven volgen.

    Stap
    Taak statusBetekenis
    Taak aanmaken

    Een behandelaar kiest een interventie voor een patient en maakt daarmee een taak voor de patiënt.


    draftDe taak is nog niet klaar om te worden uitgevoerd
    Een behandelaar komt erachter dat de taak foutief aangemaakt is.entered-in-errorDe taak is foutief ingevoerd en mag niet uitgevoerd worden
    Taak vrijgeven

    De behandelaar besluit dat de taak uitgevoerd mag gaan worden door de patiënt en geeft deze vrij.

    readyDe taak is klaar om te worden uitgevoerd, maar er is nog geen actie ondernomen.
    Uitvoeren taak


    De patiënt start met het uitvoeren van de taak

    in-progressDe taak is gestart, maar is nog niet voltooid.

    Er kan iets mis gaan tijdens de uitvoering van de taak

    cancelled

    De taak is geannuleerd; afgesloten maar niet afgerond.
    on-holdDe taak is gestart, maar het uitvoeren is gepauzeerd.
    failedDe taak is geprobeerd, maar kon vanwege een fout niet worden voltooid.

    De taak is succesvol afgerond

    completedDe taak is voltooid.
    Inzien taak

    Zowel de behandelaar als de patiënt kunnen beide de taak inzien. Ieder vanuit hun eigen portaal.


    completed

    De taak is voltooid.


    Overige statussen van een task

    Bovenstaande tabel beschrijft de voornaamste statussen die gebruikt zullen worden binnen Koppeltaal. Een taak kent echter ook een status-flow waarbij een taak-toekenning wordt beoordeel. De status "ready" wordt gebruikt wanneer de taak-toekenning een gegeven is. Binnen de GGZ is dit laatste bijna altijd het geval. Wanneer dit echter wel gebruikt wordt, dient de status als volgt behandeld te worden:

    StapTaak statusBetekenis
    Taak-toekenning wordt beoordeeld door de patiëntrequestedDe taak is klaar. De taak-toekenning moet eerst beoordeeld worden door de patiënt
    receivedDe taak-toekenning wordt beoordeeld door de patiënt
    acceptedDe taak-toekenning is geaccepteerd door de patiënt. De taak is klaar om uitgevoerd te worden
    rejectedDe taak-toekenning is afgekeurd. De taak zal niet uitgevoerd worden zonder aanpassingen

    Hard Delete

    Indien men gebruik maakt van de FHIR DELETE operatie wordt er een “logische” verwijdering uitgevoerd. Dat wil zeggen dat men niet meer bij de inhoud van de resource kan komen, en dus ook niet de status van de resource kan bekijken. Belangrijk hierbij is dat de gegevens niet fysiek uit de FHIR datastore (database) worden verwijderd.

    Stel dat er een Patient resource met id 123 wordt aangemaakt (via HTTP POST /Patient) en vervolgens wordt deze Patient id=123 verwijderd (via HTTP DELETE Patient/123). De Patient resource krijgt hiermee een tweede versie van Patient/123 met versie Patient/123/_history/2 die gemarkeerd wordt als ‘deleted’.

    Deze patiënt verschijnt niet langer in de zoekresultaten en pogingen om deze resource Patient/123 te lezen (met behulp van een HTTP GET Patient/123) zullen falen met een "HTTP 410 Gone" melding met een Location header die een URL bevat met resource id en versie id:

    Location: http://example.org/fhir/Patient/123/_history/2

    Het mooie is dat de originele resource inhoud niet wordt verwijderd. Men kan de geschiedenis van de resource nog steeds opvragen op de volgende manieren:

    GET Patient/123/_history/1 

    Warning
    titleRecht op vergetelheid

    In een aantal gevallen mag een gebruiker aan een organisatie vragen om alle (historische) gegevens, van die gebruiker, uit hun systeem te verwijderen.

    Voor het fysiek verwijderen van resources hebben sommige FHIR Resource Providers een $expunge functionaliteit geïmplementeerd. Deze functie verwijdert alle versies van een resource uit de FHIR Store.

    De $expunge operatie is echter GEEN STANDAARD (FHIR RESTfull) operatie, en moet apart geïmplementeerd worden voor de FHIR Store. Deze operatie mag alleen op instance-level aangeroepen worden.


    Voorbeelden

    Zie simplifier

    ...