VERSION 1.0.0 MANDATORY
Contents
1. Exchange Data Model: QueryResponse (Evidence Response)
This guideline explains how to use the ebRS QueryResponse syntax to implement the Business Requirements (Req ID) described for the Evidence Response. The guideline provides specific details for each class and information elements including the underlying standards, data types and cardinalities to produce conformant XML documents. In the following sections, we describe the XML serialization of the Evidence Response in the same hierarchical order of the corresponding Exchange Data Model.
The Exchange Data Model in the figure below provides an overview of the information elements and their associations contained in the Evidence Response. An Evidence Response is a message created by the Evidence Provider (EP) containing all the necessary parameters for positively responding to an evidence request including the evidence itself.
Note that rim:Slot elements are to be processed based on the value of the name attribute, not on XML document order. However, it is good practice to following the order as presented in the diagram below.
To form a valid QueryResponse, at least the following elements are required:
- the "requestId" of the QueryRequest;
- the "status" of the QueryResponse;
- the "SpecificationIdentifier" to identify the version of this specification.
- the "EvidenceResponseIdentifier" provides a unique identifier of the Response Message.
- the "IssueDateTime" to describe the time of the response;
- the "EvidenceProvider" to describe the entity that is technically responsible for creating the QueryResponse;
- the "EvidenceRequester" to describe the entity that is technically responsible for receiving the QueryResponse;
- In case of success, the QueryResponse must include a "rim:RegistryObjectList" which returns the requested information. A "DocumentQuery" triggers a response with the rim:Slot "EvidenceMetadata" and rim:RepositoryItemRef.
2. ebRIM Definition of the QueryResponse (Evidence Response)
This section defines the core ebRIM (Registry Information Model) elements that are used to compose a Query Response (Evidence Response). It thereby distinguishes between attributes and slots to define the Evidence Response in the column ebRIM type:
Attribute Definition: The table provides an overview of the mandatory attributes and the information they contain for each QueryResponse according to ebRIM.
Slot definition: The elements provide an overview of the defined ebRIM SlotType instances, which have a name and a value. The value is of type ValueType. Most rim:Slots do not contain sub-properties other than the SlotValue itself, except if they are collections. Collections refer to sources such as Core Vocabularies and a corresponding syntax binding to a class defined in the SDG Generic Metadata Profile. (see section 3).
Legend
The table below represent the tree structure of the data models illustrated in this section. Light grey rows describe classes and define their properties and attributes. Light green rows soley illustrate the classes that are subordinated or associated to a class and therewith illustrate the tree structure of the data model. Light green rows are thus always repeated as light grey rows to describe the properties and attributes of a class. The hierarchy of the tree structure is also indicated in the first column via the '+' symbol. The rim:slots illustrated in this table (ebRIM definitions) are repeated and they are further detailed through a syntax binding to the corresponding elements of the SDG Generic Metadata Profile in the subsequent tables (red rows).
Name | Definition | Cardinality | ebRIM type | Data Type | Rules | Mapping to SDG Generic Metadata Profile | Mapping to Core Vocabulary | |
---|---|---|---|---|---|---|---|---|
query:QueryResponse | Evidence Response root element | ComplexType | Structure: R-EDM-RESP-S001, R-EDM-RESP-S002, R-EDM-RESP-S016 | |||||
+ | requestId | The unique identifier of the Evidence request. Must be the same as the id attribute of the QueryRequest that generated this QueryResponse. | 1..1 | Attribute | Identifier | Structure: R-EDM-RESP-S003, R-EDM-RESP-S004 | ||
+ | status | This attribute contains the status of the response. If the evidence is provided the value "urn:oasis:names:tc:ebxml-regrep:ResponseStatusType:Success" is used. | 1..1 | Attribute | Identifier | Structure: R-EDM-RESP-S005, R-EDM-RESP-S006, R-EDM-RESP-S008 | ||
++ | rim:slot "SpecificationIdentifier" | An identification of the specification for the Evidence Response containing the total set of rules regarding semantic content, cardinalities and business rules to which the data contained in the instance document conforms. | 1..1 | SlotType | StringValueType | Structure: R-EDM-RESP-S009, R-EDM-RESP-S017 Content: R-EDM-RESP-C002 | - | - |
++ | rim:slot "EvidenceResponseIdentifier" | The unique identifier of the Evidence Response. | 1..1 | SlotType | StringValueType | Structure: R-EDM-RESP-S010, R-EDM-RESP-S018 Content: R-EDM-RESP-C003 | ||
++ | rim:slot "IssueDateTime" | The issue date and time when the Evidence Response is issued. The issue date time must have a granularity of seconds and include time zone information. | 1..1 | SlotType | DateTimeValueType | Structure: R-EDM-RESP-S011, R-EDM-RESP-S019 Content: R-EDM-RESP-C004 | - | - |
++ | rim:slot "ResponseAvailableDateTime" | The date and time when the Evidence Response will be issued in case of asynchronous evidence distribution. At the time of availability a new Evidence Request must be made. | 0..1 | SlotType | DateTimeValueType | Structure: R-EDM-RESP-S014, R-EDM-RESP-S023 Content: R-EDM-RESP-C005 | - | - |
++ | rim:slot "EvidenceProvider" | The Agent or organisation that operates the data service providing the evidence. | 1..1 | SlotType | CollectionValueType | Structure: R-EDM-RESP-S012, R-EDM-RESP-S020, R-EDM-RESP-S021, R-EDM-RESP-S025, R-EDM-RESP-S026 | Agent | Core Public Service Vocabulary Application Profile |
++ | rim:slot "EvidenceRequester" | The Agent or organisation that is requesting the evidence. | 1..1 | SlotType | AnyValueType | Structure: R-EDM-RESP-S013, R-EDM-RESP-S022, R-EDM-RESP-S027, R-EDM-RESP-S028 | Agent | Core Public Service Vocabulary Application Profile |
++ | rim:RegistryObjectList | Element to list the Registry Objects of the QueryResponse. | 0..n | ComplexType | - | Structure: R-EDM-RESP-S007 | ||
+++ | RegistryObject | Element to control the type and structure of Registry Object within the QueryResponse. | 0..n | ComplexType | ExtrinsicObjectType | |||
++++ | id | Unique UUID for each RegistryObject. This value is defined by the Evidence Provider. | 1..1 | Attribute | Identifier | Structure: R-EDM-RESP-S036, R-EDM-RESP-S037 | - | - |
++++ | rim:slot "EvidenceMetadata" | Element to provide the metadata about an evidence that is provided from the Data Service of an Evidence Provider (EP). | 1..1 | SlotType | AnyValueType | Structure: R-EDM-RESP-S015, R-EDM-RESP-S024, R-EDM-RESP-S029, R-EDM-RESP-S030 | Evidence | DCAT Application Profile |
++++ | RepositoryItemRef | The RepositoryItemRef locates the Evidence file within the repository. It provides a precise reference to the repository item provided by the Evidence Provider. | 1..1 | ComplexType | Structure: R-EDM-RESP-S033 | |||
+++++ | xlink:href | An internal reference to the repository in which the requested Evidence file is located. The reference thereby may point to a specific distribution of the Evidence. | 1..1 | Attribute | URI | Structure: R-EDM-RESP-S034 Content: R-EDM-RESP-C042 | ||
+++++ | xlink:title | The title of the document instance that is provided by the Data Provider. | 1..1 | Attribute | string | Structure: R-EDM-RESP-S035 |
2.1 ebRIM QueryResponse example
The Evidence Response is expressed using the ebRS QueryResponse
Message. It contains a reference to the query it is responding to, the requestId
attribute, and thus there is no need to include any information already present in the request.
The status
attribute is used to distinguish between a successful response using the value "urn:oasis:names:tc:ebxml-regrep:ResponseStatusType:Success" and a response that is available at a later time "urn:oasis:names:tc:ebxml-regrep:ResponseStatusType:Unavailable". If the status attribute "urn:oasis:names:tc:ebxml-regrep:ResponseStatusType:Unavailable" is used, there MUST be the rim:slot "ResponseAvailableDateTime" to indicate the time of availablity. In that case, the content of the QueryResponse element must contain a possibly empty RegistryObjectList. This the rim:slot "ResponseAvailableDateTime" is not used in case of a successful response.
The Evidence Response is contained in the RegistryObjectList
element of the QueryResponse. Each RegistryObject
in the registry object list represents an Evidence Distribution. It is noted that the registry object list may contain more than one responding pieces of evidence, each represented in the distribution requested. Each RegistryObject
element contains one EvidenceMetadata slot
and one repositoryItemRef
element. Note that the list may be the empty list if there are no matching pieces of evidence for the request or if the user, during preview, decides not to use any of them for the procedure. See chapter 4.10.5.1.
The RepositoryItemRef
element contains the link to the AS4 Attachment containing the Evidence described in the EvidenceMetadata
Slot.
<?xml version="1.0" encoding="UTF-8"?> <query:QueryResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:rs="urn:oasis:names:tc:ebxml-regrep:xsd:rs:4.0" xmlns:rim="urn:oasis:names:tc:ebxml-regrep:xsd:rim:4.0" xmlns:sdg="http://data.europa.eu/p4s" xmlns:query="urn:oasis:names:tc:ebxml-regrep:xsd:query:4.0" xmlns:sdg="http://data.europa.eu/p4s" xmlns:xlink="http://www.w3.org/1999/xlink" status="urn:oasis:names:tc:ebxml-regrep:ResponseStatusType:Success" xmlns:xml="http://www.w3.org/XML/1998/namespace" requestId="urn:uuid:c4369c4d-740e-4b64-80f0-7b209a66d629"> <!-- The 'id' attribute of a 'QueryResponse' MUST be unique UUID (RFC 4122) for each request starting with prefix "urn:uuid:" --> <!-- The 'status attribute of a 'QueryResponse' MUST be encoded as "urn:oasis:names:tc:ebxml-regrep:ResponseStatusType:Success" for successful responses or as "urn:oasis:names:tc:ebxml-regrep:ResponseStatusType:Unavailable" for responses that will be available at a later time . --> <!-- Slots are omitted for clarity --> <rim:RegistryObjectList> <!-- First Object. The 'id' attribute of a 'RegistryObject' MUST be unique UUID (RFC 4122) starting with prefix "urn:uuid:". --> <rim:RegistryObject xsi:type="rim:ExtrinsicObjectType" id="urn:uuid:555555-740e-4b64-80f0-2462462462"> <!-- The slot "EvidenceMetadata" is included here --> <!-- The attached Document Provided as Evidence. Points to an AS4 attachment --> <rim:RepositoryItemRef xlink:href="cid:attachment100001@example.oots.eu" xlink:title="SecondaryEducationCompletion"/> </rim:RegistryObject> <!-- Second Object. The 'id' attribute of a 'RegistryObject' MUST be unique UUID (RFC 4122) starting with prefix "urn:uuid:". --> <rim:RegistryObject xsi:type="rim:ExtrinsicObjectType" id="urn:uuid:60bc1cbb-2f6c-4eef-9479-b4ce3684572c"> <!-- The slot "EvidenceMetadata" is included here --> <!-- The attached Document Provided as Evidence. Points to an AS4 attachment --> <rim:RepositoryItemRef xlink:href="cid:attachment100002@example.oots.eu" xlink:title="Secondary Education Completion Evidence Supplement"/> </rim:RegistryObject> </rim:RegistryObjectList> </query:QueryResponse>
2.2. Specification Identifier example
The SpecificationIdentifier
element is used for expressing the version of the specification used for creating the referred document.
A Slot with the name of "SpecificationIdentifier" is used with the ValueType of StringValueType. In this version of the TDD specification, this MUST be set to the value oots-edm:v1.0
<!-- SpecificationIdentifier Slot --> <rim:Slot name="SpecificationIdentifier"> <rim:SlotValue xsi:type="rim:StringValueType"> <!-- MUST be the fixed value "oots-edm:v1.0". --> <rim:Value>oots-edm:v1.0</rim:Value> </rim:SlotValue> </rim:Slot>
2.3. Evidence Response Identifier example
The EvidenceResponseIdentifier
element is used for expressing the Unique Identifier of the response generated by the evidence provider.
A Slot with the name of "EvidenceResponseIdentifier" is used with the ValueType of StringValueType. Note that in RIM, the rim:Value for an element of type StringValueType is of type LongText which has a length limit of 256 characters.
<!-- EvidenceResponseIdentifier Slot --> <rim:Slot name="EvidenceResponseIdentifier"> <rim:SlotValue xsi:type="rim:StringValueType"> <!-- The 'rim:Value' of the 'EvidenceResponseIdentifier' MUST be unique UUID (RFC 4122) for each response. --> <rim:Value>5af62cce-debe-11ec-9d64-0242ac120002</rim:Value> </rim:SlotValue> </rim:Slot>
2.4. Issue Date and Time example
The IssueDateTime
slot is used for expressing the creation date and time of the referred document.
Α Slot with the name IssueDateTime
is used with the ValueType of DateTimeValueType which has an ISO timestamp value according to xsd:dateTime.
<!-- IssueDateTime Slot --> <rim:Slot name="IssueDateTime"> <rim:SlotValue xsi:type="rim:DateTimeValueType"> <!-- MUST be according to xsd:dateTime. --> <rim:Value>2022-05-19T17:10:10.872Z</rim:Value> </rim:SlotValue> </rim:Slot>
2.5 Response Available Date Time example
In situations where pieces of evidence may exist that are not immediately available, the ResponseAvailableDateTime slot may be used to express the latest point in time by which any such late pieces of evidence may be made available. As an example, this may be used by Data Services that generate evidence using a process that cannot complete within the duration of an interactive user session, but which have a predictable availability date and time. For example, a process that involves scheduled batch jobs. Depending on implementation, the Online Procedure Portal may use this information to inform the user to pause the procedure and to return at a later point by which time the evidence will be available.
If multiple pieces of evidence may be available, with possibly different dates and times at which they are available, the value to be used in the Slot should be the latest of these values.
This Slot MUST only be used with QueryResponse where the status is set to the "urn:oasis:names:tc:ebxml-regrep:ResponseStatusType:Unavailable". In that case, the content of the QueryResponse element must contain a possibly empty RegistryObjectList.
The Slot must be omitted if the Data Service is not willing or able to provide the date and time by which pieces of evidence may be available.
Α Slot with the name of ResponseAvailableDateTime
is optionally used with the ValueType of DateTimeValueType which has the value of ISO timestamp according to xsd:dateTime.
<!-- ResponseAvailableDateTime Slot --> <rim:Slot name="ResponseAvailableDateTime"> <rim:SlotValue xsi:type="rim:DateTimeValueType"> <!-- The 'rim:Value' of 'ResponseAvailableDateTime' MUST be according to xsd:dateTime. --> <rim:Value>2022-05-30T15:00:00.000Z</rim:Value> </rim:SlotValue> </rim:Slot>
3. SDGR Application Profile for the Evidence Response
The SDGR application profile for the Evidence Response defines the semantics of the previously introduced rim:Slots defined as a collection (green components) of the Evidence Response Message. The SDGR application profile for the Evidence Response describes how the SDG-Generic-Metadata Profile (SDG-syntax) is profiled in ebRIM in order to compose a valid QueryResponse. It therefore contains a mapping to the underlying SDG-syntax elements and necessary parameters for providing the evidence that was requested by an Evidence Request. Thus, the values for several parameters are obtained from the Evidence Provider that is responding to the Evidence Request. The namespace of the SDG-syntax is http://data.europa.eu/p4s. In the following samples, the prefix "sdg" is assumed to be linked to the namespace http://data.europa.eu/p4s.
3.1 Evidence Provider slot and example
The Evidence Provider element is used to describe an organisation that provides data or documents requested by an Evidence Requester. In most cases, the agent is a public organisation, however in some MS, for some evidence types, businesses have been accredited to supply them. If there are multiple agents involved, they can be classified. In case of multiple national routings on the side of the Evidence provider an Evidence Response shall name and identify the intermediary platforms involved in the communication.
An evidence provider must be registered in the Data Service Directory in order to be activated in the SDG OOTS.
The following info box and role model illustrates the principles and agent roles that can be applied for the Evidence Provider.
Agent Role Model - Principles
- The Implementing Act requires that transactions name and identify the evidence requester, provider and intermediary platforms involved into the communication (see. e.g. Article 13 1. (e))
- The Evidence Provider must be named and identified.
- The sender of a document (C1) must provide information about Intermediary Platforms involved on the sending side.
- A classification must be provided for sdg:Agent in Evidence Response for rim:Slot "EvidenceProvider". Allowed values are EP and IP.
Name | Definition | Cardinality | Type | Rules | Core Vocabulary | Notes | |
---|---|---|---|---|---|---|---|
rim:slot "EvidenceProvider" | The Agent or organisation that operates the data service providing the evidence. | 1..1 | SlotType | CollectionValueType | |||
Agent | The Agent or organisation that is providing the evidence. | 1..n | Agent | dct:Agent | Core Public Service Vocabulary Application Profile | ||
+ | Identifier | A unique identification for the agent. | 1..1 | Identifier | dct:identifier | ||
++ | Identifier/@schemeID | Scheme identifier for the agent identification. The default value urn:cef.eu:names:identifier:EAS:[Code] SHOULD be used. If there is no appropiate EAS scheme for the postfix, the unregistered option urn:oasis:names:tc:ebcore:partyid-type:unregistered:[Code] MAY be also used togehter with a ‘ISO 3166-1 alpha-2 country code (EEA_country subset)’ postfix (e.g. urn:oasis:names:tc:ebcore:partyid-type:unregistered:NL). | M | Code | R-EDM-RESP-C006, R-EDM-RESP-C007 | dct:identifier | |
+ | Name | A short label for the agent. | 1..n | Text | dct:title | ||
++ | Name/@lang | The language of the name. Default value "EN". | M | Code | dct:title | ||
+ | Address | A location of the Evidence Provider in the form of an address. | 0..1 | Address | locn:Address | Core Location Vocabulary | |
+ | Classification | A code to classify the agents associated to the communication. In case there are multiple agents the codes must be used to distinguish between the actual Evidence Provider and Intermediary Platforms that are involved in the transaction. Default value: EP | 1..1 | Code | R-EDM-RESP-C010, R-EDM-RESP-C011 | cv:role | |
++ | Address | A location of the Evidence Provider in the form of an address. | Address | locn:Address | Core Location Vocabulary | ||
+++ | FullAddress | The complete address written as a string. | 0..3 | Text | locn:fullAddress | ||
+++ | Thoroughfare | The name of a street, passage or way through from one location to another. | 0..1 | Text | locn:thoroughfare | ||
+++ | LocatorDesignator | A number or sequence of characters that uniquely identifies the locator (building number, apartment number, etc.) within the relevant scope. | 0..1 | Text | locn:locatorDesignator | ||
+++ | AdminUnitLevel1 | The name of the uppermost level of the address, almost always a country. The value must be provided if the Classification of the Agent is 'EP' (Evidence Provider). | 0..1 | Code | R-EDM-RESP-C008, R-EDM-RESP-C047 | locn:adminUnitL1 | |
+++ | AdminUnitLevel2 | The name of a secondary level/region of the address, usually a county, state or other such area that typically encompasses several localities. | 0..1 | Code | R-EDM-RESP-C009 | locn:adminUnitL2 | |
+++ | PostCode | The code created and maintained for postal purposes to identify a subdivision of addresses and postal delivery points. | 0..1 | Code | locn:postCode | ||
+++ | PostCityName | The key postal division of the address, usually the city. | 0..1 | Code | locn:postName |
A Slot with the name of EvidenceProvider
is used with the ValueType of CollectionValueType which is a container for a collection of values. It may be used to represent a SlotValue that is a collection of values where each value is represented by a AnyValueType instance which accepts any xml representation. In this particular case, the Agent class is used for the expression of the Evidence Provider information inside the AnyValueType Slot.
The value of the schemeID
attribute of the Identifier
MUST not extend 256 characters and it either, MUST use the prefix 'urn:cef.eu:names:identifier:EAS:[Code]' and a code being part of the code list 'EAS' (Electronic Address Scheme ) OR it MUST use the prefix 'urn:oasis:names:tc:ebcore:partyid-type:unregistered:[Code]' and a code being part of the code list ‘ISO 3166-1 alpha-2 country code (EEA_country subset)’.
The value of lang
attribute of the Name
MUST be part of the code list 'LanguageCode'. Default value "EN".
The value of the AdminUnitLevel1
MUST be coded using the code list 'CountryIdentificationCode' (ISO 3166-1' alpha-2 codes). The value must be provided if the Classification
of the Agent is 'EP' (Evidence Provider).
The value of the AdminUnitLevel2
MUST be coded using the code list 'NUTS' (Nomenclature of Territorial Units for Statistics).
The CollectionValueType Slot as a container can hold information about the Evidence Provider and Intermediaries. The roles are classified through the element Classification
. The value of Classification
MUST be part of the code list 'AgentClassification'. Default value: 'EP' (Evidence Provider). If the code 'IP' (Intermediary Platform) is present there must be another 'sdg:Agent' Element containing the code 'EP'. The code 'ER' and 'ERRP' shall not be used by this transaction.
<!-- EvidenceProvider Slot --> <rim:Slot name="EvidenceProvider"> <rim:SlotValue xsi:type="rim:CollectionValueType"> <rim:Element xsi:type="rim:AnyValueType"> <sdg:Agent> <!-- The value of the schemeID attribute of the Identifier MUST not extend 256 characters and it either, MUST use the prefix 'urn:cef.eu:names:identifier:EAS:[Code]' and a code being part of the code list 'EAS' (Electronic Address Scheme ) OR it MUST use the prefix 'urn:oasis:names:tc:ebcore:partyid-type:unregistered:[Code]' and a code being part of the code list ‘ISO 3166-1 alpha-2 country code (EEA_country subset)’. --> <sdg:Identifier schemeID="urn:cef.eu:names:identifier:EAS:9930">DE73524311</sdg:Identifier> <!-- The value of 'lang' attribute MUST be part of the code list 'LanguageCode'. Default value "EN". --> <sdg:Name lang="EN">Civil Registration Office Berlin I</sdg:Name> <sdg:Address> <sdg:FullAddress>Schönstedtstraße 5, 13357 Berlin, Germany</sdg:FullAddress> <sdg:LocatorDesignator>5</sdg:LocatorDesignator> <sdg:PostCode>13357</sdg:PostCode> <sdg:PostCityName>Berlin</sdg:PostCityName> <sdg:Thoroughfare>Schönstedtstraße</sdg:Thoroughfare> <!-- The value of the 'AdminUnitLevel1' MUST be coded using the code list 'CountryIdentificationCode' (ISO 3166-1' alpha-2 codes). --> <sdg:AdminUnitLevel1>DE</sdg:AdminUnitLevel1> <!-- The value of the 'AdminUnitLevel2' MUST be coded using the code list 'NUTS' (Nomenclature of Territorial Units for Statistics). --> <sdg:AdminUnitLevel2>DE3</sdg:AdminUnitLevel2> </sdg:Address> <!-- The value MUST be part of the code list 'AgentClassification'. Default value: EP (Evidence Provider). If the code 'IP' (Intermediary Platform) is present there must be another 'sdg:Agent' Element containing the code 'EP'. The code 'ER' and 'ERRP' shall not be used by this transaction. --> <sdg:Classification>EP</sdg:Classification> </sdg:Agent> </rim:Element> </rim:SlotValue> </rim:Slot>
3.2 Evidence Requester slot and example
The Evidence Requester element is used to describe an organisation that requests data or documents from Evidence Providers. The agent requests the evidence, by sending an evidence request to the evidence provider, on behalf of the evidence subject. In several cases it might be a portal/organisation that initiates the evidence request. However, the evidence response must be adressed to the Evidence Requester that initiated the evidence request and not to the portal/intermediary in case there are more than one Evidence Requesters named in the evidence request.
No central registry of evidence requesters is required, only the minimal details required to enable legal logging of requests and response to facilitate the processing of the evidence request.
The following info box and role model illustrates the principles and agent roles that can be applied for the Evidence Requester.
Agent Role Model - Principles
![EvidenceResponse class Diagram](/digital-building-blocks/sites/download/attachments/766869548/EvidenceResponse%20class%20Diagram.png?version=1&modificationDate=1721027904822&api=v2)
- The Implementing Act requires that transactions name and identify the evidence requester, the evidence provider and intermediary platforms involved into the communication (see. e.g. Article 13 1. (e))
- The Evidence Requester (final recipient) must be named and identified. No classification needed.
- The agent occurs only once. The sender of a document (C1) must only name and identify the final recipient (Corner 4) or or Evidence Requester which made the request. The sender is not aware about Intermediary Platforms involved on the receiver side.
- No classification allowed for sdg:Agent in Evidence Response for rim:Slot "EvidenceRequester".
Name | Definition | Cardinality | Type | Rules | Core Vocabulary | Notes | |
---|---|---|---|---|---|---|---|
rim:slot "EvidenceRequester" | The Agent or organisation that is requesting the evidence. | 1..1 | SlotType | AnyValueType | |||
Agent | The Agent or organisation that is requesting the evidence. | 1..1 | Agent | dct:Agent | Core Public Service Vocabulary Application Profile | ||
+ | Identifier | A unique identification for the agent. | 1..1 | Identifier | dct:identifier | ||
++ | Identifier/@schemeID | Scheme identifier for the agent identification. The default value urn:cef.eu:names:identifier:EAS:[Code] SHOULD be used. If there is no appropiate EAS scheme for the postfix, the unregistered option urn:oasis:names:tc:ebcore:partyid-type:unregistered:[Code] MAY be also used togehter with a ‘ISO 3166-1 alpha-2 country code (EEA_country subset)’ postfix (e.g. urn:oasis:names:tc:ebcore:partyid-type:unregistered:NL). | M | Code | R-EDM-RESP-C012, R-EDM-RESP-C013 | dct:identifier | |
+ | Name | A short label for the agent. | 1..n | Text | dct:title | ||
++ | Name/@lang | The language of the name. Default value "EN" | M | Code | dct:title |
A Slot with the name EvidenceRequester
is used with the ValueType of AnyValueType which accepts any xml representation. In this particular case, the Core Public Service Vocabulary Application Profile and its Agent class is used for the expression of the Evidence Requester information inside the AnyValueType Slot.
The value of the schemeID
attribute of the Identifier
MUST not extend 256 characters and it either, MUST use the prefix 'urn:cef.eu:names:identifier:EAS:[Code]' and a code being part of the code list 'EAS' (Electronic Address Scheme ) OR it MUST use the prefix 'urn:oasis:names:tc:ebcore:partyid-type:unregistered:[Code]' and a code being part of the code list ‘‘ISO 3166-1 alpha-2 country code (EEA_country subset)’.
The value of lang
attribute of the Name
MUST be part of the code list 'LanguageCode'. Default value "EN"..
<!-- EvidenceRequester Slot --> <rim:Slot name="EvidenceRequester"> <rim:SlotValue xsi:type="rim:AnyValueType"> <sdg:Agent> <!-- The value of the schemeID attribute of the Identifier MUST not extend 256 characters and it either, MUST use the prefix 'urn:cef.eu:names:identifier:EAS:[Code]' and a code being part of the code list 'EAS' (Electronic Address Scheme ) OR it MUST use the prefix 'urn:oasis:names:tc:ebcore:partyid-type:unregistered:[Code]' and a code being part of the code list ‘ISO 3166-1 alpha-2 country code (EEA_country subset)’. --> <sdg:Identifier schemeID="urn:cef.eu:names:identifier:EAS:0096">DK22233223</sdg:Identifier> <!-- The value of 'lang' attribute MUST be part of the code list 'LanguageCode'. Default value "EN". --> <sdg:Name lang="EN">Denmark University Portal</sdg:Name> </sdg:Agent> </rim:SlotValue> </rim:Slot>
3.3 Evidence Metadata slot and example
Element to provide the metadata about an evidence that is provided from the Data Service of an Evidence Provider (EP). It is described along the DCAT Application Profile.
Name | Definition | Cardinality | Type | Rules | Core Vocabulary | Notes | |
---|---|---|---|---|---|---|---|
rim:slot "EvidenceMetadata" | Element to provide the metadata about an evidence that is provided from the Data Service of an Evidence Provider (EP). | 1..1 | SlotType | AnyValueType | |||
Evidence | Provides the semantic information to describe an evidence retrieved from a Data Service. | 1..1 | Evidence | dcat:Dataset | DCAT Application Profile | ||
+ | Identifier | The identifier of an evidence. | 1..1 | Identifier | R-EDM-RESP-C015 | dcat:identifier | |
+ | IsAbout <<NaturalPerson>> | The evidence subject, namly the natural person which the evidence is about. | 0..1 | Person | Must contain either a IsAbout <<NaturalPerson>> or <<LegalPerson>> but NOT both. <xs:choice> | cpv:Person | |
+ | IsAbout <<LegalPerson>> | The evidence subject, namly the legal entity which the evidence is about. | 0..1 | Legal Person | Must contain either a IsAbout <<NaturalPerson>> or <<LegalPerson>> but NOT both. <xs:choice> | cbv:LegalEntity | |
+ | IssuingAuthority | The evidence provider, namely the agent that is issuing the evidence. | 1..1 | Agent | dct:Agent | ||
+ | IsConformantTo | Relation to an Evidence Type. An Evidence Type is an evidence classification that can be provided to meet a requirement, within a certain jurisdiction or procedure. | 1..1 | EvidenceType | cccev:EvidenceType | ||
+ | IssuingDate | The date and time the evidence has been issued by the Evidence Provider. | 1..1 | Date | R-EDM-RESP-C016 | dct:issued | |
+ | Distribution | The kind of distributions that is provided by this response and that was requested by the EvidenceRequester. | 1..1 | Distribution | dcat:distribution | ||
+ | ValidityPeriod | The validity period of the evidence ensured by the Evidence Provider. | 0..1 | Period | dct:PeriodOfTime | ||
++ | IsAbout <<NaturalPerson>> | The evidence subject, namly the natural person which the evidence is about. | 0..1 | Person | Must contain either a IsAbout <<NaturalPerson>> or <<LegalPerson>> but NOT both. <xs:choice> | cpv:Person | |
+++ | Identifier | The unique identifier provided by eIDAS to identify the Natural Person. Example: ES/AT/02635542Y | 0..1 | Identifier | R-EDM-RESP-C027, R-EDM-RESP-C028, R-EDM-RESP-C029, | cpv:identifer | |
++++ | Identifier/@schemeID | The schemeID of this identifier. Fixed value: eidas | M | Code | R-EDM-RESP-C030, R-EDM-RESP-C031 | cpv:identifier | |
+++ | FamilyName | The hereditary surname of a family. | 1..1 | Text | cpv:familyName | ||
+++ | GivenName | The name(s) that identify the Person within a family with a common surname. | 1..1 | Text | cpv:givenName | ||
+++ | DateOfBirth | The point in time on which the Person was born. | 1..1 | Date | R-EDM-RESP-C032 | cpv:dateOfBirth | |
++ | IsAbout <<LegalPerson>> | The evidence subject, namly the legal entity which the evidence is about. | 0..1 | Legal Person | Must contain either a IsAbout <<NaturalPerson>> or <<LegalPerson>> but NOT both. <xs:choice> | cbv:LegalEntity | |
+++ | LegalPersonIdentifier | The unique identifier provided by eIDAS to identify the Legal Entity. Example: ES/AT/02635542Y | 0..1 | Identifier | R-EDM-RESP-C033, R-EDM-RESP-C034, R-EDM-RESP-C035 | cbv:identifier | |
++++ | LegalPersonIdentifier/@schemeID | The schemeID of this identifier. Fixed value: eidas | M | Code | R-EDM-RESP-C036, R-EDM-RESP-C037 | cbv:identifier | |
+++ | LegalName | The name under which the Legal Entity is legally registered. | 1..1 | Text | cbv:legalName | ||
++ | IssuingAuthority | The evidence provider, namely the agent that is issuing the evidence. | 1..1 | Agent | dct:Agent | ||
+++ | Identifier | The identifier of the Issuing Authority. | 1..1 | Identifier | dct:identifier | ||
++++ | Identifier/@schemeID | Scheme identifier for the agent identification. The default value urn:cef.eu:names:identifier:EAS:[Code] SHOULD be used. If there is no appropiate EAS scheme for the postfix, the unregistered option urn:oasis:names:tc:ebcore:partyid-type:unregistered:[Code] MAY be also used togehter with a ‘ISO 3166-1 alpha-2 country code (EEA_country subset)’ postfix (e.g. urn:oasis:names:tc:ebcore:partyid-type:unregistered:NL). | M | Code | R-EDM-RESP-C038, R-EDM-RESP-C039 | dct:identifier | |
+++ | Name | The name of the Issuing Authority | 1..n | Text | dct:title | ||
++++ | Name/@lang | The language of the name. Default value "EN" | M | Code | dct:title | ||
++ | IsConformantTo | Relation to an Evidence Type. An Evidence Type is a type of evidence that can be provided to meet a requirement, within a certain jurisdiction or procedure. | 1..1 | EvidenceType | cccev:EvidenceType | ||
+++ | EvidenceTypeClassification | An URI pointing to the Evidence Type that has been provided. The classification is linking with the Evidence Type of the Semantic Repository (Evidence Broker). | 1..1 | Code | R-EDM-RESP-C017 | cccev:evidenceTypeClassification | Core Criterion Core Evidence Vocabulary |
+++ | Title | A name to identify in common language the Evidence Type. Unbounded cardinality to support multiple languages. | 1..n | Text | dct:title | ||
++++ | Title/@lang | The language of the title. Default value "EN" | M | Code | R-EDM-RESP-C018, R-EDM-RESP-C019 | dct:title | |
+++ | Description | A description of the Evidence Type. Unbounded cardinality to support multiple languages. | 0..n | Text | dct:description | ||
++++ | Description/@lang | The language of the description . Default value "EN" | M | Code | R-EDM-RESP-C020, R-EDM-RESP-C021 | dct:description | |
++ | Distribution | The kind of distributions that is provided by this response and that was requested by the EvidenceRequester. | 1..1 | Distribution | dcat:distribution | ||
+++ | Format | The technical representation of the evidence. Declaration of the file types that provide structured content like PDF, XML, JSON, RDF etc | 1..1 | Code | R-EDM-RESP-C023 | dct:format | |
+++ | Language | The language(s) in which the evidence is provided. | 0..n | Code | R-EDM-RESP-C026 | dct:LinguisticSystem | |
+++ | ConformsTo | A registered schema or conformance profile in the OOTS semantic repository to which the distributed evidence conforms. | 0..1 | URI | R-EDM-RESP-C022, R-EDM-RESP-C044, R-EDM-RESP-C045 | dct:conformsTo | The element's value is a persistent URL, pointing to an entry of the OOTS Semantic Repository that contains all the relevant information of such a profile. |
+++ | Transformation | The element points to a known and structured evidence type subset that would suffice the request. Evidence type subsets fulfil the principle of data minimization and can limit the collection to those information required for the execution of a procedure. They are connected to a defined conformance profile. | 0..1 | URI | R-EDM-RESP-C043 | dct:conformsTo | |
++ | ValidityPeriod | The validity period of the evidence ensured by the Evidence Provider. | 0..1 | Period | dct:PeriodOfTime | ||
+++ | StartDate | The start date of the validity period. The StartDate MUST be according to xsd:date. | 1..1 | Date | R-EDM-RESP-C040 | schema:startDate | |
+++ | EndDate | The end date of the validity period. The EndDate MUST be according to xsd:date. | 1..1 | Date | R-EDM-RESP-C041 | schema:endDate |
The EvidenceMetadata
Slot has a SlotValue of type AnyValueType containing an Evidence
class. The DCAT Application profile is used for representing each XML element.
The Evidence class contains:
- The unique
Identifier
of the issued evidence - The Evidence Subject in the
IsAbout
element, either a natural or a legal person. Thus it must contain either IsAbout <<NaturalPerson>> or <<LegalPerson>> but NOT both. It Must contain the mandatory Minimum Data Set part of the Evidence Subject attributes received by the Evidence Request to confirm identity matching. - The
IssuingAuthority
which uses the Agent class from the SDG Application Profile using the Core Public Service Vocabulary Application Profile. This information entity contains anIdentifier
and theName
of the Issuing Body. The value oflang
attribute of theName
MUST be part of the code list 'LanguageCode'. Default value "EN". The value of theschemeID
attribute of theIdentifier
MUST not extend 256 characters and it either, MUST use the prefix 'urn:cef.eu:names:identifier:EAS:[Code]' and a code being part of the code list 'EAS' (Electronic Address Scheme ) OR it MUST use the prefix 'urn:oasis:names:tc:ebcore:partyid-type:unregistered:[Code]' and a code being part of the code list ‘ISO 3166-1 alpha-2 country code (EEA_country subset)’. - A reference to the EvidenceType to which the Evidence
IsConformantTo
. It includes the- the
EvidenceTypeClassification
(Identifier of the Evidence type) - the
Title
andDescription
of the evidence including their associated language attributes from the code list 'LanguageCode'. Default value "EN".
- the
- The document's
IssuingDate
according to xsd:date. - The
Distribution
class, which includes the format, conformance, transformation and language code as defined in the SDG Application Profile- The
Format
MUST be part of the code list 'OOTSMediaTypes'. - The
ConformsTo
(the conformance profile requested when applicable, e.g. when evidence is structured) MUST be a persistent URL with a link to a "DataModelScheme" of the DataServiceEvidenceType retrieved by the DSD and described in the Semantic Repository which uses the prefix "https://sr.oots.tech.ec.europa.eu/distributions/[DataModelScheme]". - The format of a
Transformation
(pointing to a subset of the DataModelScheme defined in the Semantic Repository along a corresponding conformance profile description) MUST be a persistent URL with link to a "DataModelScheme" and "Subset" of the DataServiceEvidenceType retrieved from the Data Service Directory, described in the Semantic Repository which uses the prefix "https://sr.oots.tech.ec.europa.eu/distributions/[DataModelScheme]/[Subset]". Language
(s) of the included evidence expressed as value of the code list 'LanguageCode'.
- The
- Optionally, a V
alidityPeriod
, specified in the temporal element with a start and end date according to xsd:date.
When using the Evidence
class for representing the value of each element, AnyValueType is used as it allows data in XML format to be used as the slot's value.
<!-- EvidenceMetadata Slot --> <rim:Slot name="EvidenceMetadata"> <rim:SlotValue xsi:type="rim:AnyValueType"> <sdg:Evidence> <!-- The value of 'Identifier' of an 'Evidence' MUST be unique UUID (RFC 4122). --> <sdg:Identifier>37a169f1-9cf6-4aa8-ac24-b083fa569173</sdg:Identifier> <sdg:IsAbout> <!-- Must contain the Minimum Data Set part of the Evidence Subject attributes of the Evidence Request to confirm identity matching. --> <!-- Must contain either a IsAbout <<NaturalPerson>> or <<LegalPerson>> but NOT both. An example for <<LegalPerson>> is <sdg:LegalPersonIdentifier schemeID="eidas">ES/SE/12132123Y</sdg:LegalPersonIdentifier> <sdg:LegalName>AnyCompanyName</sdg:LegalName> --> <sdg:NaturalPerson> <!-- The identifier of the user retrieved through the EvidenceRequest from eIDAS --> <!-- eIDAS Identifier: MUST have the format XX/YY/ZZZZZZZ where XX is the Nationality Code of the identifier and YY is the Nationality Code of the destination country and ZZZZZZZ is an undefined combination of characters which uniquely identifies the identity asserted in the country of origin. The values of XX and YY MUST be part of the code list ‘ISO 3166-1 alpha-2 country code (EEA_country subset)’. Example: ES/AT/02635542Y. --> <!-- The 'schemeID' attribute of the 'Identifier' MUST have the fixed value 'eidas'. --> <sdg:Identifier schemeID="eidas">DK/DE/123456</sdg:Identifier> <!-- Mandatory Minimum Data Set --> <sdg:FamilyName>Smith</sdg:FamilyName> <sdg:GivenName>John</sdg:GivenName> <!-- The value of 'DateOfBirth' MUST use the following format YYYY + “-“ + MM + “-“ + DD --> <sdg:DateOfBirth>1985-09-09</sdg:DateOfBirth> </sdg:NaturalPerson> </sdg:IsAbout> <!-- The issuing authority which might be different from the evidence provider e.g. if the evidence provider acts as national base registry that aggregates local authorities issuing the evidence --> <sdg:IssuingAuthority> <sdg:Identifier schemeID="urn:cef.eu:names:identifier:EAS:9930">DE73524311</sdg:Identifier> <sdg:Name lang="EN">Civil Registration Office Berlin I</sdg:Name> </sdg:IssuingAuthority> <sdg:IsConformantTo> <!-- MUST be a UUID of the request which was retrieved from the Evidence Broker/DSD and include a code of the code list ‘ISO 3166-1 alpha-2 country code (EEA_country subset)’ using the prefix and scheme ''https://sr.oots.tech.ec.europa.eu/evidencetypeclassifications/[EEA_Country]/[UUID]'' pointing to the Semantic Repository --> <sdg:EvidenceTypeClassification>https://sr.oots.tech.ec.europa.eu/evidencetypeclassifications/DE/620c08b0-eca2-4dd9-9d1e-45fdb0baac8e</sdg:EvidenceTypeClassification> <!-- The value of 'lang' attribute of Title and Description MUST be part of the code list 'LanguageCode'. Default value "EN". --> <sdg:Title lang="EN">Certificate of Birth</sdg:Title> <sdg:Title lang="DE">Geburtsurkunde</sdg:Title> <sdg:Description lang="EN">An official certificate of birth of a person - with first name, surname, sex, date and place of birth, which is obtained from the birth register of the place of birth.</sdg:Description> <sdg:Description lang="DE">Eine amtliche Bescheinigung über die Geburt einer Person – mit Vorname, Familienname, Geschlecht, Datum und Ort der Geburt, welche aus dem Geburtsregister des Geburtsortes erstellt wird.</sdg:Description> </sdg:IsConformantTo> <!-- The issuing date, distribution and validity period of the evidence. MUST be according to xsd:date. --> <sdg:IssuingDate>1985-09-11</sdg:IssuingDate> <sdg:Distribution> <!-- The value of 'Format' of the requested distribution MUST be part of the code list 'OOTSMediaTypes' and should match the one requested by the Evidence Requester --> <sdg:Format>application/xml</sdg:Format> <!-- The value of Language attribute MUST be part of the code list 'LanguageCode'. --> <sdg:Language>DE</sdg:Language> <!-- MUST be a persistent URL with a link to a "DataModelScheme" of the Evidence Type retrieved by the DSD and described in the Semantic Repository which uses the prefix "https://sr.oots.tech.ec.europa.eu/distributions/[DataModelScheme]".--> <sdg:ConformsTo>https://sr.oots.tech.ec.europa.eu/distributions/birthcert-1.0.0</sdg:ConformsTo> <!-- MUST be a persistent URL with link to a "DataModelScheme" and "Subset" of the EvidenceType retrieved from the Data Service Directory, described in the Semantic Repository which uses the prefix "https://sr.oots.tech.ec.europa.eu/distributions/[DataModelScheme]/[Subset]"--> <sdg:Transformation>https://sr.oots.tech.ec.europa.eu/distributions/birthcert-1.0.0/age-of-majority</sdg:Transformation> </sdg:Distribution> <sdg:ValidityPeriod> <!-- The StartDate and EndDate MUST be according to xsd:date. --> <sdg:StartDate>2022-05-20</sdg:StartDate> <sdg:EndDate>2023-05-20</sdg:EndDate> </sdg:ValidityPeriod> </sdg:Evidence> </rim:SlotValue> </rim:Slot>