Page History
| Navitabs | ||||
|---|---|---|---|---|
| ||||
| Table of Contents |
|---|
Introduction
Introduktion
Dette dokument beskriver formatet til This document describes the format of the Healthcare Service User Identification (HSUID) header. The HSUID header is designed to maintain information about a user of health care services, whether the user is a citizen or health professional.
...
HSUID-headeren er designet til at vedligeholde oplysninger om en bruger af sundhedstjenester, uanset om brugeren er borger eller sundhedsfaglig.
Dokument historik
| Version | Date | Responsible | Beskrivelse |
|---|---|---|---|
0.9 | 14.5.2012 | Systematic | Initial version. |
1.0 | 29.6.2012 | Systematic | Version for release |
1.1 | 14.1.2013 | Systematic | Added nsi:CitizenCivilRegistrationNumber Incremented hsuid version number |
1.2 | 28.11.2014 | Systematic | Component renamed to HSUID |
1.3 | 24.08.2016 | Systematic | Added nsi:CitizenUserRelation Incremented schema version number to 2016/08 |
1.4 | 09.09.2016 | Systematic | Changed nsi:skscode to nsi:skskode and nsi:sorcode to nsi:sor to fit XML schema |
1.5 | 13.06.2018 | Systematic | Migrated to NSPOP SVN |
| 22.10.2018 | KIT | Document moved from Word to Confluence. Original document name was: IFS0018 Healthcare Service User Identification Header.docx | |
| 17.11.2020 | KIT | Oversat til dansk |
Format
...
af Healthcare Service User Identification Header
The Healthcare Service User Identification header consists of a HsuidHeader element containing a består af et HsuidHeader-element, der indeholder en Security Assertion Markup Language-like assertion, that itself contains a single AttributeStatement lignende påstand, der i sig selv indeholder et enkelt AttributeStatement-element.
| Code Block | ||
|---|---|---|
| ||
<hsuid:HsuidHeader xmlns:hsuid="http://www.nsi.dk/hsuid/2016/08/hsuid-1.1.xsd">
<hsuid:Assertion IssueInstant=Insert time of call here Version="2.0" id="HSUID">
<hsuid:Issuer>Mit anvendersystem</hsuid:Issuer>
<hsuid:AttributeStatement id="HSUIDdata">
<hsuid:Attribute Name=Insert attribute name here
NameFormat=Insert possible format here>
<hsuid:AttributeValue>Insert attribute value here</hsuid:AttributeValue>
</hsuid:Attribute>
Insert additional attributes and attribute values here
</hsuid:AttributeStatement>
</hsuid:Assertion>
</hsuid:HsuidHeader> |
In AttributeStatement, information about the user is held as attributes described below.
Note that which and how many occurrences of the individual attributes are allowed, depends on the specific context in which the HSUID header is used.
...
I AttributeStatement findes oplysninger om brugeren som attributter beskrevet nedenfor.
Bemærk, at hvilke og hvor mange forekomster af de enkelte attributter, der er tilladt, afhænger af den specifikke kontekst, hvor HSUID-headeren anvendes.
Attributter i HSUID-headeren
The attributes that can and may be used in HSUID header in calls to the individual health care services must be specified appears from the interface description for the service. Below is the list of established attributes.
...
De attributter, der kan og skal bruges i HSUID-header i kald til de enkelte sundhedstjenester, skal specificeres af snitfladebeskrivelsen for tjenesten. Nedenfor er listen over etablerede attributter.
Attributten nsi:UserType
The attribute nsi:UserType indicates whether user is citizen or health professional.
Name XML-attribut | nsi:UserType |
NameFormat XML-attribut | Not used |
Occurrence | Required |
Set of values | nsi:Citizen indicates citizen, nsi:HealthcareProfessional indicates health professional. |
Example | <hsuid:Attribute Name="nsi:UserType"> <hsuid:AttributeValue>nsi:Citizen</hsuid:AttributeValue> </hsuid:Attribute> |
The attribute nsi:ActingUserCivilRegistrationNumber
The attribute nsi:ActingUserCivilRegistrationNumber identifies the user by social security number.
Name XML-attribute | nsi:ActingUserCivilRegistrationNumber |
NameFormat XML-attribute | Not used |
Occurrence | Required |
Set of values | Social security number |
Example | <hsuid:Attribute Name="nsi:ActingUserCivilRegistrationNumber"> <hsuid:AttributeValue>1212124321</hsuid:AttributeValue> </hsuid:Attribute> |
The attribute nsi:OrgUsingID
The attribute nsi:OrgUsingID describes the identification of the organization for which a user who is a health professional is affiliated at the time of usage.
Name XML-attribute | nsi:OrgUsingID |
NameFormat XML-attribute | nsi:sor indicates organization identification by SOR-code, nsi:skskode indicates organization identification by SHAK-code, nsi:ynumber indicates organization identification by Healthcare Provider Number (Danish: ydernummer) |
Occurrence | Only if user is health professional |
Set of values | Depends on classifications system provided in the NameFormat-attribute |
Example | <hsuid:Attribute Name="nsi:OrgUsingID" NameFormat="nsi:sor"> <hsuid:AttributeValue>440081000016006</hsuid:AttributeValue> </hsuid:Attribute> |
The attribute nsi:ResponsibleUserCivilRegistrationNumber
The attribute nsi:ResponsibleUserCivilRegistrationNumber identifies the health person under whose responsibility the user acts.
...
nsi:ActingUser CivilRegistration Number | nsi:ResponsibleUser CivilRegistration Number | nsi:ResponsibleUser AuthorizationCode | |
Secretary (Health professional without Danish authorization) | The secretary’s own social security number | Social security number for the health professional under whose responsibility action is taken | Authorization number for the health professional under whose responsibility action is taken |
Physician (Health professional with Danish authorization under own responsibility) | The physician’s own social security number | The physician’s own social security number | The physician’s authorization number |
Health professional with authority given by the administration (c.f. §42a subsection 4 in Health law) | The health professional’s own social security number | The health professional’s own social security number | - |
The attribute nsi:ResponsibleUserAuthorizationCode
The attribute nsi:ResponsibleUserAuthorizationCode indicates the authorization number recorded in Danish Health and Medicines Authority’s authorization register for the health professional under whose responsibility the user acts.
...
If the user acts under another health professional’s responsibility, then the other health professional must possess an authorization number registered in Danish Health and Medicines Authority’s authorization register.
The attribute nsi:ConsentOverride
The attribute nsi:ConsentOverride indicates whether safeguarding is used or not. If the attribute is omitted, it means that safeguarding has not been performed.
Name XML-attribute | nsi:ConsentOverride |
NameFormat XML-attribute | Not used |
Occurrence | Only if user is health professional. Optional |
Set of values | True indicates use of safe guarding, false indicates that safeguarding is not used |
Example | <hsuid:Attribute Name="nsi:ConsentOverride"> <hsuid:AttributeValue>true</hsuid:AttributeValue> </hsuid:Attribute> |
The attribute nsi:SystemOwnerName
The attribute nsi:SystemOwnerName indicates name of the system owner of the user system.
Name XML-attribute | nsi:SystemOwnerName |
NameFormat XML-attribute | Not used |
Occurrence | Required |
Set of values | Sample space is dictated by system owner |
Example | <hsuid:Attribute Name="nsi:SystemOwnerName"> <hsuid:AttributeValue>Region Midt</hsuid:AttributeValue> </hsuid:Attribute> |
The attribute nsi:SystemName
The attribute nsi:SystemName indicates name of the user system.
Name XML-attribute | nsi:SystemName |
NameFormat XML-attribute | Not used |
Occurrence | Required |
Set of values | Sample space is dictated by system owner/provider of user system |
Example | <hsuid:Attribute Name="nsi:SystemName"> <hsuid:AttributeValue>MidtEPJ</hsuid:AttributeValue> </hsuid:Attribute> |
The attribute nsi:SystemVersion
The attribute nsi:SystemVersion indicates version of the user system.
Name XML-attribute | nsi:SystemVersion |
NameFormat XML-attribute | Not used |
Occurrence | Required |
Set of values | Sample space is dictated by system owner/provider of user system |
Example | <hsuid:Attribute Name="nsi:SystemVersion"> <hsuid:AttributeValue>9</hsuid:AttributeValue> </hsuid:Attribute> |
The attribute nsi:OrgResponsibleName
The attribute nsi:OrgResponsibleName indicates name of the organization responsible for operation of the IT-system.
Name XML-attribute | nsi:OrgResponsibleName |
NameFormat XML-attribute | Not used |
Occurrence | Required |
Set of values | Sample space is dictated by the responsible organization |
Example | <hsuid:Attribute Name="nsi:OrgResponsibleName"> <hsuid:AttributeValue>Driftsafdeling Vest</hsuid:AttributeValue> </hsuid:Attribute> |
The attribute nsi:CitizenCivilRegistrationNumber
The attribute nsi:CitizenCivilRegistrationNumber indicates the social security number of the patient.
Name XML-attribute | nsi:CitizenCivilRegistrationNumber |
NameFormat XML-attribute | Not used |
Occurrence | Optional |
Set of values | Social security number |
Example | <hsuid:Attribute Name="nsi:CitizenCivilRegistrationNumber"> <hsuid:AttributeValue>1212124321</hsuid:AttributeValue> </hsuid:Attribute> |
The attribute nsi:CitizenUserRelation
The attribute nsi:CitizenCivilUserRelation indicates the relation between the user and the patient. Presence of this attribute does not mandate presence of the attribute nsi:CitizenCivilRegistrationNumber.
Name XML-attribute | nsi:CitizenUserRelation |
NameFormat XML-attribute | Not used |
Occurrence | Optional |
Set of values | nsi:Citizen indicates user is the patient, nsi:ChildCustodyHolder indicates the user has custody of the patient (in Danish: forældremyndighedsindehaver), nsi:Guardian indicates the user is legal guardian of the patient (in Danish: værge for patienten), nsi:ProxyHolder indicates the user has been granted the right to act on behalf of the patient (in Danish: fuldmagtshaver). |
Example | <hsuid:Attribute Name="nsi:CitizenUserRelation"> <hsuid:AttributeValue>nsi:ChildCustodyHolder</hsuid:AttributeValue> </hsuid:Attribute> |
Example
The following is an example of a HSUID header for a user that:
...