Page History
| Table of Contents |
|---|
Introduction
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.
Document History
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
The purpose of this section is to provide an overview of the definitions and references to other documents used in this document.
Definition | Description |
NSI | National eHealth Authority |
NSP | National Service Platform (within health care) |
SOR | National Health Organisation Register (Danish: Sundhedsvæsenets Organisationsregister). |
Alias | Description |
Behov | National samtykkeservice, v1.1 (behovsbeskrivelse for Samtykke 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. | Mandatory |
validTo | Timestamp | Date and time where the consent expires. Null = no expiration date. | |
creationTimestamp | Timestamp | Time of creation of consent. | 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 |
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. | |
referralEnd | Timestamp | The consent concerns information on activities pertaining to the citizen before or on the stated timestamp. Null = no bounding end time. |
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 |
Examples
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].
Desired Consent | consentItem | whatItem | whoItem | ||||||||||||||
Status | Neg./ Pos. | What | Whom | consentType | whatItem | whoItem | validFrom | validTo | organization Identifier | IncludeSubOrgs | referralStart | referralEnd | health ProfessionalCpr | organizational Identifier | include SubOrgs | foreignHealth Professionals | |
Active | Negative | Everything | Everybody | 0 | null | null | TS | null | |||||||||
Active | Negative | Everything | Individual | 0 | null | FK to who Item | TS | null | CPR number | null | true | false | |||||
Active | Negative | Organization | Everybody | 0 | FK to what Item | null | TS | null | SOR code | false | TS1 | TS2 | |||||
Active | Negative | Organization with all subordinates | Everybody | 0 | FK to what Item | null | TS | null | SOR code | true | TS1 | TS2 | |||||
Active | Negative | All organizations | Everybody | 0 | FK to what Item | null | TS | null | null | true | TS1 | TS2 | |||||
Expired | Negative | Everything | Everybody | 0 | null | null | TS1 | TS2 < now | |||||||||
Expired | Negative | Everything | Individual | 0 | null | FK to who Item | TS1 | TS2 < now | CPR number | null | true | false | |||||
Expired | Negative | Organization | Everybody | 0 | FK to what Item | null | TS1 | TS2 < now | SOR code | false | TS1 | TS2 | |||||
Expired | Negative | Organization with all subordinates | Everybody | 0 | FK to what Item | null | TS1 | TS2 < now | SOR code | true | TS1 | TS2 | |||||
Expired | Negative | All organizations | Everybody | 0 | FK to what Item | null | TS1 | TS2 < now | null | true | TS1 | TS2 | |||||
Positive | Everything | Individual | 1 | null | FK to who Item | TS1 | TS2 | CPR number | null | true | false | ||||||
Positive | Everything | Organization | 1 | null | FK to who Item | TS1 | TS2 | null | SOR code | false | false | ||||||
Positive | Everything | Organization with all subordinates | 1 | null | FK to who Item | TS1 | TS2 | null | SOR code | true | false | ||||||
Positive | Organization | Individual | 1 | FK to what Item | FK to who Item | TS1 | TS2 | SOR code | false | TS1 | TS2 | CPR number | null | true | false | ||
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 | ||
Positive | All organizations | Individual | 1 | FK to what Item | FK to who Item | TS1 | TS2 | null | true | TS1 | TS2 | CPR number | null | true | false | ||
Positive | Organization | Organization | 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 | Organization | 1 | FK to what Item | FK to who Item | TS1 | TS2 | SOR code | true | TS1 | TS2 | null | SOR code | false | false | ||
Positive | All organizations | Organization | 1 | FK to what Item | FK to who Item | TS1 | TS2 | null | true | TS1 | TS2 | null | SOR code | false | false | ||
Positive | Organization | Organization with all subordinates | 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 | Organization with all subordinates | 1 | FK to what Item | FK to who Item | TS1 | TS2 | SOR code | true | TS1 | TS2 | null | SOR code | true | false | ||
Positive | All organizations | Organization with all subordinates | 1 | FK to what Item | FK to who Item | TS1 | TS2 | null | true | TS1 | TS2 | null | SOR code | true | false | ||
Positive | epSOS pt summary, ePrescription | Foreign healh care professional | 1 | null | FK to who Item | TS1 | TS2 | null | null | null | true | ||||||
Conceptual Model for Consent Verification
Consent verification uses the same data model as consent administration.