Page History
Navitabs | ||||
---|---|---|---|---|
| ||||
Table of Contents |
---|
...
Introduktion
Purpose
The purpose of the present document is to provide documentation of the data model for the consent services. The consent services consist of the consent administration service and the consent verification service.
The document contains an overview of tables that must be defined for the consent services, including the meaning of the individual fields in addition to how the tables are connected. Additionally, examples are provided on how the possible types of consent specifically are represented in the model.
...
Formål
Formålet med dette dokument er at tilvejebringe dokumentation for datamodellen for Samtykkeservicen . Samtykkeservicen består af services til administration og verifikation.
Dokumentet indeholder en oversigt over tabeller, der skal defineres for Samtykkeservicen , herunder betydningen af de enkelte felter ud over, hvordan tabellerne er forbundet. Derudover gives eksempler på, hvordan de mulige typer samtykke specifikt er repræsenteret i modellen.
Dokument historik
Version | Date | Responsible | Description |
1.0 | 29.06.2012 | Systematic | Initial version |
1.1 | 28.11.2014 | Systematic | References to National Patient Index (NPI) has been removed |
1.2 | 29.03.2016 | Systematic | Corrected version footer |
1.3 | 07.09.2016 | Systematic | Corrected header |
1.4 | 13.06.2018 | Systematic | Migrated to NSPOP SVN |
22.10.2018 | KIT | Document moved from Word to Confluence. Original document name was: DDD0003 Consent Services Data Model.docx |
Definitions and References
16.11.2020 | KIT | Oversat til Dansk |
Deifinitioner og referencer
Formålet med dette afsnit er give et overblik over de definitioner og referencer der anvendes i dette dokumentThe purpose of this section is to provide an overview of the definitions and references to other documents used in this document.
Definition | DescriptionBeskrivelse |
NSI | National eHealth AuthoritySundheds IT |
NSP | National Service Platform (within health care) |
SOR | National Health Organisation Register (Danish: Sundhedsvæsenets Organisationsregister). |
Alias | DescriptionBeskrivelse |
Behov | National samtykkeserviceconsentservice, v1.1 (behovsbeskrivelse for Samtykke Min Spærring Service *1). Available in Danish only |
*1 Nyt navn for servicen er "Min Spæring
Consent Services Data Model
In this section, the data model for the consent services is described.
Conceptual Model for Consent Administration
A consent is registered as a ConsentItem. Given a ConsentItem, any attached WhatItem and/or WhoItem can be identified.
Table consentitem
Holds information concerning consent, cf.[Behov].
...
Field
...
Type
...
Use
...
Optionality
...
citizenCpr
...
String
...
Identity of the citizen (social security number) the consent concerns.
...
Mandatory
...
consentType
...
Integer
...
Type of consent, 0=negative, other than zero=positive.
...
Mandatory
...
whatItem
...
Foreign key
...
Reference to whatItem table. Null = all
...
whoItem
...
Foreign key
...
Reference to whoItem table. Null = all
...
validFrom
...
Timestamp
...
Time from which the consent is applicable.
Saved as UTC-timestamp.
...
Mandatory
...
validTo
...
Timestamp
...
Date and time where the consent expires.
Null = no expiration date.
Saved as UTC-timestamp.
...
creationTimestamp
...
Timestamp
...
Time of creation of consent.
Saved as UTC-Timestamp.
...
Mandatory
...
creatingSystemName
...
String
...
Name of the system through which the consent was created (as recorded in the HSUID-header on the Web service-call to the consent administration service)
...
Mandatory
...
createdBy
...
String
...
Identity of the user that created the consent (as recorded in the HSUID-header on the Web service call to consent service)
...
Mandatory
) |
Samtykkeservicen Datamodel
I denne sektion er datamodellen for Samtykkeservicen beskrevet.
Konceptuel model til Samtykkeservicen Administration
En registrering i Samtykkeservicen er registreret som et ConsentItem. For et givent ConsentItem kantilknyttet WhatItem og/eller WhoItem identificteres.
Tabel consentitem
Indeholder information om samtykke eller spærring.
Felt | Type | Brug | Optionelt |
citizenCpr | Tekst | Identificerer borger (CPR) som registrering berører. | Krævet |
consentType | Tal | Type af registrering, 0=spærring, andet=samtykke. | Krævet |
whatItem | Fremmednøgle | Reference til whatItem tabellen. Null = alle | |
whoItem | Fremmednøgle | Reference til whoItem tabellen. Null = alle | |
validFrom | Tidsstempel | Tidspunkt for hvornår registrering er gældende. Gemt som UTC-tidsstempel. | Krævet |
validTo | Tidsstempel | Tidspunkt for hvornår registrering udløber. Null = ingen udløbsdato. | |
creationTimestamp | Tidsstempel | Tidspunkt for oprettelse af registrering. Gemt som UTC-tidsstempel. | Krævet |
creatingSystemName | Tekst | Navnet på det system, gennem hvilket registreringen blev oprettet (som registreret i HSUID-headeren på kaldet til Samtykkeservicen Administration.) | Krævet |
createdBy | Tekst | Identiteten på den bruger, der oprettede registreringen (som registreret i HSUID-headeren på kaldet til Samtykkeservicen Administration) | Krævet |
modifyTimestamp | Tidsstempel | Det tidspunkt, hvor registreringen senest blev ændret. Gemt som UTC-tidsstempel. | |
modifyingSystemName | Tekst | Navnet på det system, hvorigennem registreringen sidst blev ændret (som registreret i HSUID-headeren på kaldet til Samtykkeservicen Administration.) | |
modifiedBy | Tekst | Identitet for den bruger, der sidst ændrede registreringen (som registreret i HSUID-headeren på kaldet til Samtykkeservicen Administration) |
Tabel whatItem
Indeholder information om hvad registreringen dækker.
Felt | Type | Brug | Optionelt |
organizationIdentifier | Tekst | Identifikation på den organisation (angivet som SOR-koden for organisationen), hvorfra oplysningerne stammer. Null = alle organisationer | |
includeSubOrgs | Tal | Angiver, om registreringen vedrører oplysninger, der stammer fra den bestemte organisation (med værdien 0) eller den bestemte organisation og alle organisationer, der er underordnet den (med værdien 1). | Krævet |
referralStart | Tidsstempel | Registreringen vedrører oplysninger om aktiviteter, der vedrører borgeren på eller senere end den angivne tidsstempel. Null = Ingen start tid | |
referralEnd | Tidsstempel | Registreringen vedrører oplysninger om aktiviteter vedrørende borgeren før det registrerede tidsstempel. Null = Ingen slut tid. |
Tabel whoItem
Indeholder information om hvem samtykket / spærringen er giver til / i mod.
Felt | Type | Use | Optionelt |
healthProfessionalCpr | Tekst | Identiteten på den sundhedsfaglige person (CPR), som registreringen gælder for. En værdi på null betyder, at samtykke gælder for enhver sundhedsfaglig. | |
organizationIdentifier | Tekst | Identiteten på den organisation (SOR-koden) som registreringen gælder for. En værdi på null betyder alle organisationer. | |
includeSubOrgs | Tal | Angiver, om samtykke gælder for den bestemte organisation (med værdien 0) eller den bestemte organisation og alle organisationer, der er underordnet den (med værdien 1). | |
foreignHealthProfessionals | Tal | Angiver, om registreringen gælder sundhedsfaglige, der fungerer uden for dansk område. En værdi på 1 angiver, at registreringen gælder for udenlandsk sundhedspersonale, mens en værdi på nul angiver, at det ikke gælder. En registrering af consentType=1, der er forbundet med et whoItem med foreignHealthProfessionals sat til 1 angiver registreringen givet for epSos til at videregive sundhedsoplysninger til udenlandske sundhedspersonale. Hvilke oplysninger, der skal afsløres, bestemmes af epSos. | Krævet |
Eksempler
...
modifyTimestamp
...
Timestamp
...
Time at which the consent was most recently modified. Saved as UTC-timestamp.
...
modifyingSystemName
...
String
...
Name of the system through which the consent last was modified (as recorded in the HSUID-header on the Web service-call to consent service)
...
modifiedBy
...
String
...
Identity of the user that last modified the consent (as recorded in the HSUID-header on the Web service-call to consent service)
Table whatItem
Holds information concerning what the consent covers, cf. [Behov].
...
Field
...
Type
...
Use
...
Optionality
...
organizationIdentifier
...
String
...
Identity of the organisation (given as the SOR-code of the organisation) from which the information originated. Null = all organisations.
...
includeSubOrgs
...
Integer
...
Indicates whether the consent concerns information originating from the particular organisation (with the value 0) or the particular organisation and all organisations transitively subordinate to it (with the value 1).
...
Mandatory
...
referralStart
...
Timestamp
...
The consent concerns information on activities pertaining to the citizen on or later than the stated timestamp.
Null = no bounding start time.
Saved as UTC-timestamp.
...
referralEnd
...
Timestamp
...
The consent concerns information on activities pertaining to the citizen before or on the stated timestamp.
Null = no bounding end time.
Saved as UTC-timestamp.
Tabel whoItem
Holds information about whom a consent is given to / against, cf. [Behov].
...
Field
...
Type
...
Use
...
Optionality
...
healthProfessionalCpr
...
String
...
Identity of the health professional (social security number) for whom the consent applies to. A value of null means that the consent applies to any health professional.
...
organizationIdentifier
...
String
...
Identity of the organisation (the SOR-code) for which the consent applies to. A value of null means any organisation.
...
includeSubOrgs
...
Integer
...
Indicates whether the consent applies to the particular organisation (with the value 0) or the particular organisation and all organisations transitively subordinate to it (with the value 1).
...
foreignHealthProfessionals
...
Integer
...
States whether the consent applies to health professionals functioning outside Danish territory.
A value of 1 indicates that the consent applies to foreign health professionals, while a value of zero indicates that it does not apply.
A consentitem of consentType 1 associated with at whoItem with foreignHealthProfessionals set to 1 indicates consent provided for epSos to disclose health information to foreign health professionals. Which information to be disclosed is determined by epSos.
...
Mandatory
...
Below, examples are given on how selected fields in the table are filled-in for the possible combinations of consent specification, as specified in [Behov].
Nedenfor gives eksempler på, hvordan udvalgte felter i tabellen udfyldes for de mulige kombinationer af samtykke/spærring-specifikation.
Ønsket indholdDesired Consent | consentItem | whatItem | whoItem | |||||||||||||||||
Status | Neg.Spærring/Pos. SamtykkeWhat | Hvad | WhomHvem | consentType | whatItem | whoItem | validFrom | validTo | organization Identifier | IncludeSubOrgs | referralStart | referralEnd | health ProfessionalCpr | organizational Identifier | include SubOrgs | foreignHealth Professionals | ||||
ActiveAktiv | NegativeSpærringEverything | Alt | EverybodyAlle | 0 | null | null | TS | null | ||||||||||||
ActiveAktiv | NegativeSpærring | EverythingAlt | IndividualIndividuel | 0 | null | FK to who Item | TS | null | CPR number | null | true | false | ||||||||
ActiveAktiv | NegativeSpærring | OrganizationOrganisation | EverybodyAlle | 0 | FK to what Item | null | TS | null | SOR code | false | TS1 | TS2 | ||||||||
ActiveAktiv | Negative | Organization with all subordinates | Spærring | Organisation og alle underorganisationer | AlleEverybody | 0 | FK to what Item | null | TS | null | SOR code | true | TS1 | TS2 | ||||||
ActiveAktiv | NegativeSpærring | All organizationsAlle Organisationer | EverybodyAlle | 0 | FK to what Item | null | TS | null | null | true | TS1 | TS2 | ||||||||
ExpiredUdløbet | NegativeSpærring | EverythingAlt | EverybodyAlle | 0 | null | null | TS1 | TS2 < now | ||||||||||||
ExpiredUdløbet | NegativeSpærring | EverythingAlt | IndividualIndividuel | 0 | null | FK to who Item | TS1 | TS2 < now | CPR number | null | true | false | ||||||||
ExpiredUdløbet | NegativeSpærring | OrganizationOrganisation | EverybodyAlle | 0 | FK to what Item | null | TS1 | TS2 < now | SOR code | false | TS1 | TS2 | ||||||||
ExpiredUdløbet | Negative | Organization with all subordinates | Spærring | Organisation og alle underorganisationer | AlleEverybody | 0 | FK to what Item | null | TS1 | TS2 < now | SOR code | true | TS1 | TS2 | ||||||
ExpiredUdløbetNegative | Spærring | All organizationsAlle Organisationer | EverybodyAlle | 0 | FK to what Item | null | TS1 | TS2 < now | null | true | TS1 | TS2 | ||||||||
PositiveSamtykke | EverythingAlt | IndividualIndividuel | 1 | null | FK to who Item | TS1 | TS2 | CPR number | null | true | false | |||||||||
PositiveSamtykke | EverythingAlt | OrganizationOrganisation | 1 | null | FK to who Item | TS1 | TS2 | null | SOR code | false | false | |||||||||
PositiveSamtykke | Everything | Alt | Organisation og alle underorganisationerOrganization with all subordinates | 1 | null | FK to who Item | TS1 | TS2 | null | SOR code | true | false | ||||||||
PositiveSamtykke | OrganizationOrganisation | Individual | 1 | FK to what Item | FK to who Item | TS1 | TS2 | SOR code | false | TS1 | TS2 | CPR number | null | true | false | |||||
Samtykke | Organisation og alle underorganisationer | Positive | Organization with all subordinates | Individual | 1 | FK to what Item | FK to who Item | TS1 | TS2 | SOR code | true | TS1 | TS2 | CPR number | null | true | false | |||
PositiveSamtykke | All organizationsAlle Organisationer | Individual | 1 | FK to what Item | FK to who Item | TS1 | TS2 | null | true | TS1 | TS2 | CPR number | null | true | false | |||||
PositiveSamtykke | OrganizationOrganisationOrganization | Organisation | 1 | FK to what Item | FK to who Item | TS1 | TS2 | SOR code | false | TS1 | TS2 | null | SOR code | false | false | Positive | Organization with all subordinates | |||
Samtykke | Organisation og alle underorganisationer | OrganisationOrganization | 1 | FK to what Item | FK to who Item | TS1 | TS2 | SOR code | true | TS1 | TS2 | null | SOR code | false | falsePositive | |||||
Samtykke | All organizationsAlle Organisationer | OrganizationOrganisation | 1 | FK to what Item | FK to who Item | TS1 | TS2 | null | true | TS1 | TS2 | null | SOR code | false | false | |||||
PositiveSamtykke | Organization | Organisation | Organization with all subordinatesOrganisation og alle underorganisationer | 1 | FK to what Item | FK to who Item | TS1 | TS2 | SOR code | false | TS1 | TS2 | null | SOR code | true | false | Positive | Organization with all subordinates | ||
Samtykke | Organisation og alle underorganisationer | Organisation og alle underorganisationerOrganization with all subordinates | 1 | FK to what Item | FK to who Item | TS1 | TS2 | SOR code | true | TS1 | TS2 | null | SOR code | true | false | |||||
PositiveSamtykke | All organizations | Alle Organisationer | Organisation og alle underorganisationerOrganization with all subordinates | 1 | FK to what Item | FK to who Item | TS1 | TS2 | null | true | TS1 | TS2 | null | SOR code | true | falsePositive | ||||
Samtykke | epSOS pt summary, ePrescriptionForeign healh care professional | Sundhedsfaglig i udlandet (epSos) | 1 | null | FK to who Item | TS1 | TS2 | null | null | null | true |
Conceptual Model for Consent Verification
Konceptuel model til Samtykkeservicen Verifikation
Samtykkeservicen Verifikation anvender den samme model som Samtykkeservicen AdministrationConsent verification uses the same data model as consent administration.