Introduktion

Dette dokument beskriver formatet til Healthcare Service User Identification (HSUID) header. 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

Healthcare Service User Identification header består af et HsuidHeader-element, der indeholder en Security Assertion Markup Language-lignende påstand, der i sig selv indeholder et enkelt AttributeStatement-element.

<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>

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

The attribute nsi:UserType indicates whether user is citizen or health professional.

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	<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.

XMl-attribut Name	nsi:ActingUserCivilRegistrationNumber
XML-attribut NameFormat	Not used
Påkrævet	Required
Værdisæt	Social security number
Eksempel	<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.

XMl-attribut Name	nsi:OrgUsingID
XML-attribut NameFormat	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)
Påkrævet	Only if user is health professional
Værdisæt	Depends on classifications system provided in the NameFormat-attribute
Eksempel	<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.

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.

XMl-attribut Name	nsi:ResponsibleUserCivilRegistrationNumber
XML-attribut NameFormat	Not used
Påkrævet	Only if user is health professional
Værdisæt	Social security number
Eksempel	<hsuid:Attribute Name="nsi: ResponsibleUserCivilRegistrationNumber"> <hsuid:AttributeValue>1111112222</hsuid:AttributeValue> </hsuid:Attribute>

Examples of usage are provided in the table below:

	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.

XMl-attribut Name	nsi:ResponsibleUserAuthorizationCode
XML-attribut NameFormat	Not used
Påkrævet	Only if user is health professional
Værdisæt	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).
Eksempel	<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.

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.

XMl-attribut Name	nsi:ConsentOverride
XML-attribut NameFormat	Not used
Påkrævet	Only if user is health professional. Optional
Værdisæt	True indicates use of safe guarding, false indicates that safeguarding is not used
Eksempel	<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.

XMl-attribut Name	nsi:SystemOwnerName
XML-attribut NameFormat	Not used
Påkrævet	Required
Værdisæt	Sample space is dictated by system owner
Eksempel	<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.

XMl-attribut Name	nsi:SystemName
XML-attribut NameFormat	Not used
Påkrævet	Required
Værdisæt	Sample space is dictated by system owner/provider of user system
Eksempel	<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.

XMl-attribut Name	nsi:SystemVersion
XML-attribut NameFormat	Not used
Påkrævet	Required
Værdisæt	Sample space is dictated by system owner/provider of user system
Eksempel	<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.

XMl-attribut Name	nsi:OrgResponsibleName
XML-attribut NameFormat	Not used
Påkrævet	Required
Værdisæt	Sample space is dictated by the responsible organization
Eksempel	<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.

XMl-attribut Name	nsi:CitizenCivilRegistrationNumber
XML-attribut NameFormat	Not used
Påkrævet	Optional
Værdisæt	Social security number
Eksempel	<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.

XMl-attribut Name	nsi:CitizenUserRelation
XML-attribut NameFormat	Not used
Påkrævet	Optional
Værdisæt	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).
Eksempel	<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)
works on behalf of a health professional with social security number 1404444444 and authorization number 12345

<?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>