AuthorizationService.xsd

<?xml version="1.0" encoding="UTF-8"?>
<!-- Mit XMLSpy v2019 sp2 (x64) (http://www.altova.com) von n/a (Gematik) bearbeitet -->
<!-- ===================================================================== -->
<!-- Copyright (C) 2021 gematik GmbH. Alle Rechte vorbehalten.             -->
<!-- ===================================================================== -->
<!-- Version History

			version: V1.8.0
			===========
			*** added UpdateAuthorizationPeriod
			
			version: V1.7.5
			===========
			*** removed OKDate from putForReplacementResponse
			
			version: V1.7.4
			===========
			*** removed OKDate from finishKeyChangeResponse

			version: V1.7.3
			===========
			*** comment on timestamp format for LastTimeStamp in GetAuditEvents and GetSignedÁuditEvents

			version: V1.7.2
			===========
			*** corrected regex for UserAgentsType value

			version: V1.7.1
			===========
			*** added regex for UserAgentsType value

			version: V1.7.0
			===========
			*** added LastTimeStamp to GetAuditEvents and GetSignedÁuditEvents

			version: V1.6.0
			===========
			*** added GetAuthorizationState, GetAuthorizationStateResponse and AuthorizedApplicationType
			*** added Paramter AllMandators and HomeCommunityId to CheckRecordExists
			*** added Paramters for Paging to GetSignedAuditEvents (Request and Response)

			version: V1.5.4
			===========
			*** bugfix parametertype in FinishKeyChange

			version: V1.5.3
			===========
			*** removed GetRecordProviderList and RecordProviderListType

			version: V1.5.2
			===========
			*** fixed wrong type of OkDate to dateTime in finishKeyChangeResponse
			*** fixed cardinality of ActorID in GetNotificationInfo to 0..1
			*** fixed cardinality of NotificationInfoListEntry in GetNotificationInfoResponse to unbound

			version: V1.5.1
			===========
			*** added paging functionality to GetAuditEvents
			*** added parameter RecordId to GetNotificationInfo
			*** added GetKtrTelematikID and GetKtrTelematikIDResponse
			*** added GetRecordProviderList and GetRecordProviderListResponse
			*** added type RecordProviderListType
			*** removed parameter ActorID in startKeyChange
			*** removed parameter DeviceID in startKeyChange
			*** removed parameter RollbackTime in startKeyChangeResponse 
			*** removed parameter ActorID in finishKeyChange
			*** removed parameter DeviceID in finishKeyChange
			*** removed parameter ActorID in putForReplacement,
			*** added DL_IN_PROGRESS, READY_FOR_IMPORT and START_MIGRATION in RecordStateType

			version: V1.5.0
			===========
			*** neuer Record State KEY_CHANGE
			
			version: V1.4.0
			===========
			*** neue Operation Element GetNotificationInfo
			
			version: V1.3.0
			===========
			*** neue Operation Element GetSignedAuditEvents

			version: V1.2.0 (R4.0.2)
			===========
			*** Feature Umschlüsselung mit neuen Operationen: startKeyChange, putForReplacement, finishKeyChange
			
			version: V1.1.4 (R3.1.3)
			===========
			*** Korrektur Restriktion  [a-zA-Z] in Element DisplayName entfernt
			*** Korrektur Element name REGISTERED_MIGRATION -> REGISTERED_FOR_MIGRATION
			
			version: V1.1.3
			===========
			*** Korrektur DeviceID type in Element DeleteAuthorizationKey

			version: V1.1.2
			===========
			*** Korrektur AuthorizationTypeType und AssociatedDataType

			version: V1.1.1
			===========
			*** Korrektur Konsistenzfehler mit Spezifikation: Entfernen des "minOccurs="0"" für AuthorizationAssertion in GetAuthorizationKeyResponse

			version: V1.1.0
			===========
			*** Überarbeitung Verschlüsselungskonzept ePa mit SGD (Schlüsselgenerierungsdienst)
			*** Einführung neuer Operationen zur Berechtigungsabfrage
			*** Einführung Prozess Vertreterfreischaltung

			version: V1.0
			===========
			*** Initiale Erstellung

	 	End of Version History
-->
<schema xmlns="http://www.w3.org/2001/XMLSchema" xmlns:phrs="http://ws.gematik.de/fd/phrs/AuthorizationService/v1.1" xmlns:phr="http://ws.gematik.de/fa/phr/v1.1" xmlns:phrext="http://ws.gematik.de/fa/phrext/v1.0" xmlns:xenc="http://www.w3.org/2001/04/xmlenc#" xmlns:SAML="urn:oasis:names:tc:SAML:2.0:assertion" xmlns:ds="http://www.w3.org/2000/09/xmldsig#" xmlns:tel="http://ws.gematik.de/tel/error/v2.0" targetNamespace="http://ws.gematik.de/fd/phrs/AuthorizationService/v1.1" elementFormDefault="qualified" attributeFormDefault="unqualified" version="1.8.0">
	<annotation>
		<documentation xml:lang="de">
			Copyright (c) 2021, gematik GmbH
			Schema-Beschreibung der Schnittstellen der Komponente Autorisierung.
		</documentation>
	</annotation>
	<import namespace="urn:oasis:names:tc:SAML:2.0:assertion" schemaLocation="../../ext/saml-schema-assertion-2.0.xsd"/>
	<import namespace="http://www.w3.org/2001/04/xmlenc#" schemaLocation="../../ext/xenc-schema.xsd"/>
	<import namespace="http://www.w3.org/2000/09/xmldsig#" schemaLocation="../../ext/xmldsig-core-schema.xsd"/>
	<import namespace="http://ws.gematik.de/fa/phrext/v1.0" schemaLocation="../../ext/IHE/healthcare-security-audit.xsd"/>
	<import namespace="http://ws.gematik.de/tel/error/v2.0" schemaLocation="../../tel/error/TelematikError.xsd"/>
	<import namespace="http://ws.gematik.de/fa/phr/v1.1" schemaLocation="PHR_Common.xsd"/>
	<element name="GetKtrTelematikID">
		<complexType>
			<sequence>
				<element name="RecordIdentifier" type="phr:RecordIdentifierType"/>
				<element name="DeviceID" type="phr:DeviceIdType"/>
			</sequence>
		</complexType>
	</element>
	<element name="GetKtrTelematikIDResponse">
		<complexType>
			<sequence>
				<element name="KtrTelematikID" type="phr:TelematikIdType"/>
			</sequence>
		</complexType>
	</element>
	<element name="GetAuthorizationKey">
		<complexType>
			<sequence>
				<element name="RecordIdentifier" type="phr:RecordIdentifierType"/>
				<element name="DeviceID" type="phr:DeviceIdType" minOccurs="0">
					<annotation>
						<documentation>Gerätekennung des Geräts des Versicherten, Verwendung nur bei Aufruf aus der Personal Zone des Versicherten</documentation>
					</annotation>
				</element>
			</sequence>
		</complexType>
	</element>
	<element name="GetAuthorizationKeyResponse">
		<complexType>
			<sequence>
				<element name="AuthorizationKey" type="phrs:AuthorizationKeyType" minOccurs="0"/>
				<element name="AuthorizationAssertion" type="base64Binary"/>
			</sequence>
		</complexType>
	</element>
	<element name="PutAuthorizationKey">
		<complexType>
			<sequence>
				<element name="AuthorizationKey" type="phrs:AuthorizationKeyType"/>
				<element name="RecordIdentifier" type="phr:RecordIdentifierType"/>
				<element name="DeviceID" type="phr:DeviceIdType" minOccurs="0"/>
				<element name="NotificationInfoRepresentative" type="string" minOccurs="0"/>
			</sequence>
		</complexType>
	</element>
	<element name="PutAuthorizationKeyResponse"/>
	<element name="DeleteAuthorizationKey">
		<complexType>
			<sequence>
				<element name="RecordIdentifier" type="phr:RecordIdentifierType"/>
				<element name="ActorID" type="string"/>
				<element name="DeviceID" type="phr:DeviceIdType"/>
			</sequence>
		</complexType>
	</element>
	<element name="DeleteAuthorizationKeyResponse"/>
	<element name="ReplaceAuthorizationKey">
		<annotation>
			<documentation>deprecated</documentation>
		</annotation>
		<complexType>
			<sequence>
				<element name="AuthorizationKey" type="phrs:AuthorizationKeyType"/>
				<element name="RecordIdentifier" type="phr:RecordIdentifierType"/>
				<element name="DeviceID" type="phr:DeviceIdType"/>
			</sequence>
		</complexType>
	</element>
	<element name="ReplaceAuthorizationKeyResponse">
		<annotation>
			<documentation>deprecated</documentation>
		</annotation>
	</element>
	<element name="UpdateAuthorizationPeriod">
		<complexType>
			<sequence>
				<element name="RecordIdentifier" type="phr:RecordIdentifierType"/>
				<element name="ActorId" type="string"/>
				<element name="validTo" type="date"/>
				<element name="DeviceID" type="phr:DeviceIdType"/>
			</sequence>
		</complexType>
	</element>
	<element name="UpdateAuthorizationPeriodResponse"/>
	<element name="CheckRecordExists">
		<complexType>
			<sequence>
				<element name="KVNR" type="phr:InsurantIdType">
					<annotation>
						<documentation>10 stelliger, unveränderlicher Anteil der KVNR = VersichertenID</documentation>
					</annotation>
				</element>
				<element name="AllMandators" type="boolean" minOccurs="0">
					<annotation>
						<documentation>TRUE:= Prüfe alle Mandanten des Aktensystems. Nicht vorhanden oder FALSE := prüfe nur ausgewählten Mandanten</documentation>
					</annotation>
				</element>
			</sequence>
		</complexType>
	</element>
	<element name="CheckRecordExistsResponse">
		<complexType>
			<sequence>
				<element name="RecordState" type="phrs:RecordStateType"/>
				<element name="HomeCommunityId" type="phr:HomeCommunityIdType" minOccurs="0">
					<annotation>
						<documentation>HomeCommunityId des Mandanten des Aktensystems, der eine Akte für die angefragte KVNR vorliegen hat.</documentation>
					</annotation>
				</element>
			</sequence>
		</complexType>
	</element>
	<element name="GetAuditEvents">
		<complexType>
			<sequence>
				<element name="RecordIdentifier" type="phr:RecordIdentifierType"/>
				<element name="DeviceID" type="phr:DeviceIdType"/>
				<element name="PageSize" minOccurs="0">
					<simpleType>
						<restriction base="integer">
							<minInclusive value="1"/>
						</restriction>
					</simpleType>
				</element>
				<element name="PageNumber" minOccurs="0">
					<simpleType>
						<restriction base="integer">
							<minInclusive value="1"/>
						</restriction>
					</simpleType>
				</element>
				<choice>
					<element name="LastDay" type="date" minOccurs="0">
						<annotation>
							<documentation>deprecated - das Element LastDay in Zukunft nicht weiter verwenden</documentation>
						</annotation>
					</element>
					<element name="LastTimestamp" type="dateTime" minOccurs="0">
						<annotation>
							<documentation>Das Element LastTimestamp muss bei Verwendung mit einem Zeitstempel im Format YYYY-MM-DDThh:mm:ssZ belegt sein. Weitere Formate sind nicht zulässig.</documentation>
						</annotation>
					</element>
				</choice>
			</sequence>
		</complexType>
	</element>
	<element name="GetAuditEventsResponse">
		<complexType>
			<sequence>
				<element ref="phrext:AuditMessage" minOccurs="0" maxOccurs="unbounded"/>
				<element name="PageSize" minOccurs="0">
					<simpleType>
						<restriction base="integer">
							<minInclusive value="1"/>
						</restriction>
					</simpleType>
				</element>
				<element name="PageNumber" minOccurs="0">
					<simpleType>
						<restriction base="integer">
							<minInclusive value="1"/>
						</restriction>
					</simpleType>
				</element>
				<element name="TotalPages" minOccurs="0">
					<simpleType>
						<restriction base="integer">
							<minInclusive value="0"/>
						</restriction>
					</simpleType>
				</element>
				<element name="TotalEntries" minOccurs="0">
					<simpleType>
						<restriction base="integer">
							<minInclusive value="0"/>
						</restriction>
					</simpleType>
				</element>
			</sequence>
		</complexType>
	</element>
	<element name="GetSignedAuditEvents">
		<complexType>
			<sequence>
				<element name="RecordIdentifier" type="phr:RecordIdentifierType"/>
				<element name="DeviceID" type="phr:DeviceIdType"/>
				<element name="PageSize" minOccurs="0">
					<simpleType>
						<restriction base="integer">
							<minInclusive value="1"/>
						</restriction>
					</simpleType>
				</element>
				<element name="PageNumber" minOccurs="0">
					<simpleType>
						<restriction base="integer">
							<minInclusive value="1"/>
						</restriction>
					</simpleType>
				</element>
				<choice>
					<element name="LastDay" type="date" minOccurs="0">
						<annotation>
							<documentation>deprecated - das Element LastDay in Zukunft nicht weiter verwenden</documentation>
						</annotation>
					</element>
					<element name="LastTimestamp" type="dateTime" minOccurs="0">
						<annotation>
							<documentation>Das Element LastTimestamp muss bei Verwendung mit einem Zeitstempel im Format YYYY-MM-DDThh:mm:ssZ belegt sein. Weitere Formate sind nicht zulässig.</documentation>
						</annotation>
					</element>
				</choice>
			</sequence>
		</complexType>
	</element>
	<element name="GetSignedAuditEventsResponse">
		<complexType>
			<sequence>
				<element name="SignedAuditEventList" type="base64Binary"/>
				<element name="PageSize" minOccurs="0">
					<simpleType>
						<restriction base="integer">
							<minInclusive value="1"/>
						</restriction>
					</simpleType>
				</element>
				<element name="PageNumber" minOccurs="0">
					<simpleType>
						<restriction base="integer">
							<minInclusive value="1"/>
						</restriction>
					</simpleType>
				</element>
				<element name="TotalPages" minOccurs="0">
					<simpleType>
						<restriction base="integer">
							<minInclusive value="0"/>
						</restriction>
					</simpleType>
				</element>
				<element name="TotalEntries" minOccurs="0">
					<simpleType>
						<restriction base="integer">
							<minInclusive value="0"/>
						</restriction>
					</simpleType>
				</element>
			</sequence>
		</complexType>
	</element>
	<element name="PutNotificationInfo">
		<complexType>
			<sequence>
				<element name="RecordIdentifier" type="phr:RecordIdentifierType"/>
				<element name="DeviceID" type="phr:DeviceIdType"/>
				<element name="NewNotificationInfo" type="string"/>
			</sequence>
		</complexType>
	</element>
	<element name="PutNotificationInfoResponse"/>
	<element name="GetNotificationInfo">
		<complexType>
			<sequence>
				<element name="RecordIdentifier" type="phr:RecordIdentifierType"/>
				<element name="DeviceID" type="phr:DeviceIdType"/>
				<element name="ActorID" type="string" minOccurs="0"/>
			</sequence>
		</complexType>
	</element>
	<element name="GetNotificationInfoResponse">
		<complexType>
			<sequence>
				<element name="NotificationInfoList">
					<complexType>
						<sequence>
							<element name="NotificationInfoListEntry" type="phr:NotificationInfoListEntryType" maxOccurs="unbounded"/>
						</sequence>
					</complexType>
				</element>
			</sequence>
		</complexType>
	</element>
	<element name="GetAuthorizationList">
		<complexType>
			<sequence>
				<element name="RecordIdentifier" type="phr:RecordIdentifierType" minOccurs="0"/>
				<element name="DeviceID" type="phr:DeviceIdType" minOccurs="0"/>
			</sequence>
		</complexType>
	</element>
	<element name="GetAuthorizationListResponse">
		<complexType>
			<choice maxOccurs="1">
				<annotation>
					<documentation>abhängig von der aufgerufenen Schnittstelle (aus der Umgebung des Leistungserbringers = Konnektor oder durch den Versicheten @home wird entweder eine horizontale Liste aller Autorisierungen eine Leistungserbringerinstitution oder eine vertikale Liste aller Schlüssel in der Akte eines Versicherten zurückgegeben)</documentation>
				</annotation>
				<element name="AuthorizationInfo" type="phrs:AuthorizationInfoType" minOccurs="0" maxOccurs="unbounded"/>
				<element name="AuthorizationKey" type="phrs:AuthorizationKeyType" minOccurs="0" maxOccurs="unbounded"/>
			</choice>
		</complexType>
	</element>
	<element name="GetAuthorizationState">
		<complexType>
			<sequence>
				<element name="InsurantId" type="phr:InsurantIdType">
					<annotation>
						<documentation>eindeutige Kennung der Akte eines Versicherten im Kontext einer HomeCommuityId (Versichertennummer (KVNR))</documentation>
					</annotation>
				</element>
				<element name="UserAgents" type="phrs:UserAgentsType">
					<annotation>
						<documentation>Liste der aufrufenden Systembestandteile in der Reihenfolge des Aufrufs. Der aktuelle Aufrufer der Operation GetAuthorizationState muss als letzter Eintrag in der Liste enthalten sein.</documentation>
					</annotation>
				</element>
			</sequence>
		</complexType>
	</element>
	<element name="GetAuthorizationStateResponse">
		<annotation>
			<documentation>Liste der autorisierten Anwendungen für die Telematik-ID der Anfrage</documentation>
		</annotation>
		<complexType>
			<sequence>
				<element name="AuthorizedApplication" type="phrs:AuthorizedApplicationType" minOccurs="0" maxOccurs="unbounded">
					<annotation>
						<documentation>Listenelemente für jeweils eine autorisierte Anwendung. Anwendungen ohne Autorisierung, bzw. ohne gültigen ValidTo-Zeitpunkt dürfen nicht in der Liste enthalten sein. </documentation>
					</annotation>
				</element>
			</sequence>
		</complexType>
	</element>
	<element name="startKeyChange">
		<complexType>
			<sequence>
				<element name="RecordIdentifier" type="phr:RecordIdentifierType"/>
			</sequence>
		</complexType>
	</element>
	<element name="startKeyChangeResponse"/>
	<element name="putForReplacement">
		<complexType>
			<sequence>
				<element name="RecordIdentifier" type="phr:RecordIdentifierType"/>
				<element name="DeviceID" type="phr:DeviceIdType"/>
				<element name="AllEncryptedKeys" type="phrs:AuthorizationKeyType" minOccurs="0" maxOccurs="unbounded"/>
			</sequence>
		</complexType>
	</element>
	<element name="putForReplacementResponse"/>
	<element name="finishKeyChange">
		<complexType>
			<sequence>
				<element name="RecordIdentifier" type="phr:RecordIdentifierType"/>
				<element name="Success" type="boolean"/>
			</sequence>
		</complexType>
	</element>
	<element name="finishKeyChangeResponse"/>
	<complexType name="RecordStateType">
		<choice>
			<element name="UNKNOWN">
				<annotation>
					<documentation>Es existiert kein Konto für eine angefragte KVNR</documentation>
				</annotation>
			</element>
			<element name="REGISTERED">
				<annotation>
					<documentation>Es wurde ein Konto für diese KVNR registriert aber nicht aktiviert</documentation>
				</annotation>
			</element>
			<element name="REGISTERED_FOR_MIGRATION">
				<annotation>
					<documentation>Es wurde ein Konto für diese KVNR registriert aber nicht aktiviert und der Versicherte möchte vorhandene Daten aus einem anderen Aktenkonto in das neue übernehmen</documentation>
				</annotation>
			</element>
			<element name="ACTIVATED">
				<annotation>
					<documentation>Es existiert ein aktives Konto zur angefragten KVNR</documentation>
				</annotation>
			</element>
			<element name="DISMISSED">
				<annotation>
					<documentation>Ein vorhandenes Konto zu einer KVNR wurde gekündigt, ist jedoch noch in Benutzung</documentation>
				</annotation>
			</element>
			<element name="SUSPENDED">
				<annotation>
					<documentation>Ein vorhandenes Konto zu einer KVNR wurde gekündigt und vorhandene Daten wurden für den Kontoumzug vorbereitet</documentation>
				</annotation>
			</element>
			<element name="KEY_CHANGE">
				<annotation>
					<documentation>Das ePA-Aktensystem befindet sich in einem Umschlüsselungsvorgang und ist derzeit nicht verfügbar</documentation>
				</annotation>
			</element>
			<element name="DL_IN_PROGRESS">
				<annotation>
					<documentation>Der Download eines Aktenmigrationspakets wurde gestartet</documentation>
				</annotation>
			</element>
			<element name="READY_FOR_IMPORT">
				<annotation>
					<documentation>Der Download eines Aktenmigrationspakets wurde erfolgreich abgeschlossen</documentation>
				</annotation>
			</element>
			<element name="START_MIGRATION">
				<annotation>
					<documentation>Die Erstellung eine Aktenmigrationspakets zur Übertragung der Daten auf ein neues Konto wurde gestartet</documentation>
				</annotation>
			</element>
		</choice>
	</complexType>
	<simpleType name="AuthorizationTypeType">
		<restriction base="string">
			<enumeration value="DOCUMENT_AUTHORIZATION">
				<annotation>
					<documentation>Autorisierung mit Dokumentenzugriff (Standardfall Zugriff auf medizinische Daten und Dokumente)</documentation>
				</annotation>
			</enumeration>
			<enumeration value="RECOVERY_AUTHORIZATION">
				<annotation>
					<documentation>Autorisierung zur Umschlüsselung ohne Zugriff auf medizinische Daten eines Kontos</documentation>
				</annotation>
			</enumeration>
			<enumeration value="ACCOUNT_AUTHORIZATION">
				<annotation>
					<documentation>Autorisierung im Zusammenhang mit Kontoaktivierung, Aktenumzug bzw. Anbieterwechsel oder anderen Anwendungsfällen, in denen für den Versicherten kein gültiges Schlüsselmaterial vorhanden ist</documentation>
				</annotation>
			</enumeration>
		</restriction>
	</simpleType>
	<simpleType name="CiphertextType">
		<restriction base="base64Binary">
			<maxLength value="102400"/>
		</restriction>
	</simpleType>
	<simpleType name="AssociatedDataType">
		<restriction base="string">
			<maxLength value="10240"/>
		</restriction>
	</simpleType>
	<complexType name="EncryptedKeyContainerType">
		<sequence>
			<element name="Ciphertext" type="phrs:CiphertextType"/>
			<element name="AssociatedData" type="phrs:AssociatedDataType"/>
		</sequence>
		<attribute name="algorithm" type="anyURI" use="required"/>
	</complexType>
	<complexType name="AuthorizationKeyType">
		<sequence>
			<element name="EncryptedKeyContainer" type="phrs:EncryptedKeyContainerType" minOccurs="1" maxOccurs="1"/>
			<element name="AuthorizationType" type="phrs:AuthorizationTypeType"/>
		</sequence>
		<attribute name="validTo" type="date" use="required"/>
		<attribute name="actorID" type="string" use="required"/>
		<attribute name="DisplayName" type="phrs:DisplayNameType" use="optional"/>
	</complexType>
	<simpleType name="DisplayNameType">
		<restriction base="string">
			<maxLength value="50"/>
		</restriction>
	</simpleType>
	<complexType name="AuthorizationInfoType">
		<sequence>
			<element name="InsurantId" type="phr:InsurantIdType"/>
			<element name="validTo" type="date"/>
		</sequence>
	</complexType>
	<complexType name="AuthorizedApplicationType">
		<sequence>
			<element name="ApplicationName" type="string">
				<annotation>
					<documentation>Kennzeichnung der Anwendung gemäß Vorgabe für Anwendungen der Anwendungsplattform</documentation>
				</annotation>
			</element>
			<element name="ValidTo" type="date">
				<annotation>
					<documentation>Ende der Gültigkeit der erteilten Authorizatuion für diese Anwendung</documentation>
				</annotation>
			</element>
		</sequence>
	</complexType>
	<complexType name="UserAgentsType">
		<sequence>
			<element name="UserAgent" maxOccurs="unbounded">
				<annotation>
					<documentation>Liste von Produktkennungen von identifizierbaren Systemelementen (UserAgents) in der Reihenfolge des Aufrufs</documentation>
				</annotation>
				<simpleType>
					<restriction base="string">
						<maxLength value="65"/>
						<minLength value="5"/>
						<pattern value="[a-zA-Z0-9_\-\+\.: \(\)]{1,20}/[a-zA-Z0-9_\-\+\.: \(\)]{1,23}/[a-zA-Z0-9_\-\+\.: \(\)]{1,20}"/>
					</restriction>
				</simpleType>
			</element>
		</sequence>
	</complexType>
</schema>