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.
Attributes in HSUID-header
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.
The attribute nsi:UserType
The attribute nsi:UserType indicates whether user is citizen or health professional.
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
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
Attributten nsi:UserType angiver, om brugeren er statsborger eller sundhedsprofessionel.
XMl-attribut Name | nsi:UserType |
XML-attribut NameFormat | Ikke brugt |
Påkrævet | Ja |
Værdisæt | nsi:Citizen betyder borger, nsi:HealthcareProfessional betyder sundhedsfaglig |
Eksempel | |
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> |
...
Attributten nsi:ActingUserCivilRegistrationNumber
The attribute Attributten nsi:ActingUserCivilRegistrationNumber identifies the user by social security numberidentificerer brugeren udfra personnummer.
XMl-attribut Name XML-attribute | nsi:ActingUserCivilRegistrationNumber |
NameFormat XML-attribute | Not used |
Occurrence | Required |
Set of values | Social security number |
attribut NameFormat | Ikke brugt |
Påkrævet | Ja |
Værdisæt | CPR-nummer |
EksempelExample | <hsuid:Attribute Name="nsi:ActingUserCivilRegistrationNumber"> <hsuid:AttributeValue>1212124321</hsuid:AttributeValue> </hsuid:Attribute> |
...
Attributten 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.
Attributten nsi:OrgUsingID beskriver identifikationen af den organisation, som en bruger, der er sundhedsfaglig er tilknyttet på brugstidspunktet.
XMl-attribut NameName XML-attribute | nsi:OrgUsingID |
NameFormat XML-attributeattribut NameFormat | nsi:sor indicates organization identification by SOR-code,indikerer at organisationen er identificeret via en SOR-kode. nsi:skskode indicates organization identification by SHAK-code,indikerer at organisationen er identificeret via en SHAK-kode. 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 |
indikerer at organisationen er identificeret via ydernummer. | |
Påkrævet | Kun hvis bruger er sundhedsfaglig. |
Værdisæt | Afhænger af klassifikationssystemet anvendt i NameFormat attributten. |
EksempelExample | <hsuid:Attribute Name="nsi:OrgUsingID" NameFormat="nsi:sor"> <hsuid:AttributeValue>440081000016006</hsuid:AttributeValue> </hsuid:Attribute> |
...
Attributten nsi:ResponsibleUserCivilRegistrationNumber
...
Attributten nsi:ResponsibleUserCivilRegistrationNumber
...
identificerer den sundhedsfagligeperson under hvis ansvar brugeren handler.
Hvis brugeren handler under en anden sundhedsfagligs ansvar, skal sidstnævnte have en dansk autorisation i sundhedsmyndighedens autorisationsregister. Dette autorisationsnummer skal angives i attributten nsi: ResponsibleUserAuthorizationCode.
Hvis brugeren ikke handler under en anden sundhedsprofessionals ansvar, skal den samme værdi angives i attributterne nsi: ActingUserCivilRegistrationNumber og nsi:ResponsibleUserCivilRegistrationNumber.
XMl-attribut Name |
...
If the user acts under the responsibility of another health professional, the latter must possess a Danish authorization in Health Authority’s authorization register. This health professional’s authorization number has to be provided in the attribute nsi:ResponsibleUserAuthorizationCode.
If the user is not acting under the responsibility of another health professional, then the same value must be provided in the attributes nsi:ActingUserCivilRegistrationNumber and nsi:ResponsibleUserCivilRegistrationNumber.
Name XML-attribute | nsi:ResponsibleUserCivilRegistrationNumber |
NameFormat XML-attribute | Not used |
Occurrence | Only if user is health professional |
Set of values | Social security number |
attribut NameFormat | Ikke brugt |
Påkrævet | Kun hvis bruger er sundhedsfaglig. |
Værdisæt | CPR-nummer |
EksempelExample | <hsuid:Attribute Name="nsi:ResponsibleUserCivilRegistrationNumber"> <hsuid:AttributeValue>1111112222</hsuid:AttributeValue> </hsuid:Attribute> |
Examples of usage are provided in the table belowEksempler på brug er vidst i nedenstående tabel:
nsi: |
ActingUserCivilRegistrationNumber |
Number
nsi: |
CivilRegistration
NumberResponsibleUserCivilRegistrationNumber | nsi: |
ResponsibleUserAuthorizationCode |
AuthorizationCode
SecretarySekretær ( |
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.
Sundhedsfaglig uden dansk autorisation) | Sekretærens eget CPR-nummer | CPR-nummer på sundhedsfaglig der arbejdes på vegne af. | Autorisationsnummer på sundhedsfaglig der arbejdes på vegne af. |
Læge (Sundhedsfaglig med eget autorsiationsnummer der ikke arbejder på vegne af anden) | Læges eget CPR-nummerr | Læges eget CPR-nummer | Læges eget autorisansnummer |
Sundhedsfaglig uden autorisationsnummer | Sundhedsfagligs eget CPR-nummer | Sundhedsfagligs eget CPR-nummer | - |
Attributten nsi:ResponsibleUserAuthorizationCode
Attributten nsi:ResponsibleUserAuthorizationCode angiver autorisationsnummeret registreret i Sundhedsstyrelsens autorisationsregister for den sundhedsperson, under hvis ansvar brugeren handler.
XMl-attribut Name | nsi:ResponsibleUserAuthorizationCode |
XML-attribut NameFormat | Ikke brugt |
Påkrævet | Kun hvis bruger er sundhedsfaglig. |
Værdisæt | Autorisationsnummer registreret i Sundhedsstyrelsens autorisationsregister. Hvis brugeren handler under eget ansvar, og brugeren ikke har et autorisationsnummer, angives ”-” (uden anførselstegn). |
Eksempel | |
Name XML-attribute | nsi:ResponsibleUserAuthorizationCode |
NameFormat XML-attribute | Not used |
Occurrence | Only if user is health professional |
Set of values | Authorization number recorded in Danish Health and Medicines Authority’s authorization register. If the user acts under own responsibility and the user does not have an authorization number, then ”-” is indicated (without quotation marks). |
Example | <hsuid:Attribute Name="nsi:ResponsibleUserAuthorizationCode"> <hsuid:AttributeValue>12345</hsuid:AttributeValue> </hsuid:Attribute> |
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.
...
Hvis brugeren handler under en anden sundhedsfagligs ansvar, skal den anden sundhedsfaglige have et autorisationsnummer registreret i Sundhedsstyrelsens autorisationsregister.
Attributten nsi:ConsentOverride
The attribute Attributten nsi:ConsentOverride indicates whether safeguarding is used or not. If the attribute is omitted, it means that safeguarding has not been performed.angiver, om værdispring bruges eller ej. Hvis attributten udelades, betyder det, at værdispring ikke er udført.
XMl-attribut NameName 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 |
attribut NameFormat | Ikke brugt |
Påkrævet | Nej |
Værdisæt | True indikerer at der er anvendt værdispring og false indikerer at der ikke er anvendt værdispring. |
EksempelExample | <hsuid:Attribute Name="nsi:ConsentOverride"> <hsuid:AttributeValue>true</hsuid:AttributeValue> </hsuid:Attribute> |
...
Attributten nsi:SystemOwnerName
The attribute Attributten nsi:SystemOwnerName indicates name of the system owner of the user system.angiver navnet på systemejeren af anvendersystemet.
XMl-attribut NameName XML-attribute | nsi:SystemOwnerName |
NameFormat XML-attribute | Not used |
Occurrence | Required |
Set of values | Sample space is dictated by system owner |
attribut NameFormat | Ikke brugt |
Påkrævet | Ja |
Værdisæt | Angives af systemejer |
EksempelExample | <hsuid:Attribute Name="nsi:SystemOwnerName"> <hsuid:AttributeValue>Region Midt</hsuid:AttributeValue> </hsuid:Attribute> |
...
Attributten nsi:SystemName
The attribute nsi:SystemName indicates name of the user system.
Attributten nsi:Systemnavn angiver navnet på anvendersystemet
XMl-attribut NameName 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 |
attribut NameFormat | Ikke brugt |
Påkrævet | Ja |
Værdisæt | Angives af systemejer |
EksempelExample | <hsuid:Attribute Name="nsi:SystemName"> <hsuid:AttributeValue>MidtEPJ</hsuid:AttributeValue> </hsuid:Attribute> |
...
Attributten nsi:SystemVersion
The attribute Attrbutten nsi:SystemVersion indicates version of the user systemangiver navnet på anvendersystemet.
XMl-attribut 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 |
attribut NameFormat | Ikke brugt |
Påkrævet | Ja |
Værdisæt | Angives af systemejer |
EksempelExample | <hsuid:Attribute Name="nsi:SystemVersion"> <hsuid:AttributeValue>9</hsuid:AttributeValue> </hsuid:Attribute> |
...
Attributten nsi:OrgResponsibleName
The attribute Attributen nsi:OrgResponsibleName indicates name of the organization responsible for operation of the IT-system.angiver organisationen ansvarlig for anvendersystemet.
XMl-attribut NameName XML-attribute | nsi:OrgResponsibleName |
NameFormat XML-attribute | Not used |
Occurrence | Required |
Set of values | Sample space is dictated by the responsible organization |
attribut NameFormat | Ikke brugt |
Påkrævet | Ja |
Værdisæt | Angives af den ansvarlige organisation |
EksempelExample | <hsuid:Attribute Name="nsi:OrgResponsibleName"> <hsuid:AttributeValue>Driftsafdeling Vest</hsuid:AttributeValue> </hsuid:Attribute> |
...
Attributten nsi:CitizenCivilRegistrationNumber
The attribute Attributten nsi:CitizenCivilRegistrationNumber indicates the social security number of the angiver CPR-nummer på patient.
XMl-attribut Name XML-attribute | nsi:CitizenCivilRegistrationNumber |
NameFormat XML-attribute | Not used |
Occurrence | Optional |
Set of values | Social security number |
attribut NameFormat | Ikke brugt |
Påkrævet | Nej |
Værdisæt | CPR-nummer |
EksempelExample | <hsuid:Attribute Name="nsi:CitizenCivilRegistrationNumber"> <hsuid:AttributeValue>1212124321</hsuid:AttributeValue> </hsuid:Attribute> |
...
Attributten nsi:CitizenUserRelation
The attribute Attributten nsi:CitizenCivilUserRelation indicates the relation between the user and the patient. Presence of this attribute does not mandate presence of the attribute indikerer forholdet mellem brugeren og patienten. Tilstedeværelsen af denne attribut kræver ikke tilstedeværelsen af attributten nsi:CitizenCivilRegistrationNumber.
XMl-attribut Name XML-attribute | nsi:CitizenUserRelation |
NameFormat XML-attribute | Not used |
Occurrence | Optional |
attribut NameFormat | Ikke brugt |
Påkrævet | Nej |
VærdisætSet of values | nsi:Citizen indicates user is the patient,indikerer at bruger er patient nsi:ChildCustodyHolder indicates the user has custody of the patient (in Danish: forældremyndighedsindehaver),indikerer bruger er forældremyndighedsindehaver. nsi:Guardian indicates the user is legal guardian of the patient (in Danish: indikerer bruger er værge for patienten),. nsi:ProxyHolder indicates the user has been granted the right to act on behalf of the patient (in Danish: fuldmagtshaver).indikerer patient har givet bruger fuldmagt. |
EksempelExample | <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:
...
is a health professional
...
has social security number 2202222222
...
is affiliated with hospital ward with SHAK-code 6620151 (corresponding to SOR-code 440081000016006)
Eksempel
Følgende er et eksempel på et HSUID-header for en bruger, der:
- er sundhedspersonale
- har personnummer 2202222222
- er tilknyttet hospitalafdelingen med SHAK-kode 6620151 (svarende til SOR-kode 440081000016006)
- arbejder på vegne af en sundhedsperson med CPR-nummer 1404444444 og autorisationsnummer
...
- 12345
Code Block | ||
---|---|---|
| ||
<?xml version="1.0" encoding="UTF-8" ?> <hsuid:HsuidHeader xmlns:hsuid="http://www.nsi.dk/hsuid/2016/08/hsuid-1.1.xsd"> <hsuid:Assertion IssueInstant="2016-08-24T08:26:17.183Z" Version="2.0" id="HSUID"> <hsuid:Issuer>my-issuer</hsuid:Issuer> <hsuid:AttributeStatement id="HSUIDdata"> <hsuid:Attribute Name="nsi:UserType"> <hsuid:AttributeValue>nsi:HealthcareProfessional</hsuid:AttributeValue> </hsuid:Attribute> <hsuid:Attribute Name="nsi:ActingUserCivilRegistrationNumber"> <hsuid:AttributeValue>2202222222</hsuid:AttributeValue> </hsuid:Attribute> <hsuid:Attribute Name="nsi:OrgUsingID" NameFormat="nsi:sor"> <hsuid:AttributeValue>440081000016006</hsuid:AttributeValue> </hsuid:Attribute> <hsuid:Attribute Name="nsi:OrgUsingID" NameFormat="nsi:skskode"> <hsuid:AttributeValue>6620151</hsuid:AttributeValue> </hsuid:Attribute> <hsuid:Attribute Name="nsi:ResponsibleUserCivilRegistrationNumber"> <hsuid:AttributeValue>1404444444</hsuid:AttributeValue> </hsuid:Attribute> <hsuid:Attribute Name="nsi:ResponsibleUserAuthorizationCode"> <hsuid:AttributeValue>12345</hsuid:AttributeValue> </hsuid:Attribute> <hsuid:Attribute Name="nsi:SystemOwnerName"> <hsuid:AttributeValue>Region Midt</hsuid:AttributeValue> </hsuid:Attribute> <hsuid:Attribute Name="nsi:SystemName"> <hsuid:AttributeValue>MidtEPJ</hsuid:AttributeValue> </hsuid:Attribute> <hsuid:Attribute Name="nsi:SystemVersion"> <hsuid:AttributeValue>9</hsuid:AttributeValue> </hsuid:Attribute> <hsuid:Attribute Name="nsi:OrgResponsibleName"> <hsuid:AttributeValue>Driftsafdeling Vest</hsuid:AttributeValue> </hsuid:Attribute> <hsuid:Attribute Name="nsi:CitizenCivilRegistrationNumber"> <hsuid:AttributeValue>1212124321</hsuid:AttributeValue> </hsuid:Attribute> </hsuid:AttributeStatement> </hsuid:Assertion> </hsuid:HsuidHeader> |
...