This package defines the EOSC Profiles data model, a shared and interoperable data model that Nodes of the EOSC Federation can use to exchange information about the resources in their catalogues. It ensures that every Node describes services, data sources, training materials, interoperability guidelines, deployable applications, and organisations using a common, machine‑readable structure.
Figure 1 gives an overview of the data model. Relationships among entities are semantically labelled. The label 'isA' denotes a hierarchical relationship ('super-class'). For example: Datasource is a sub-class ('isA') of Service, Service is a sub-class ('isA') of Resource. Sub-classes inherit all the properties of their super-class.
In the following, each table includes details about the fields of each entity:
- Field: name of the field. When a field is nested, the form
mainField.nestedField. - Description: description of the field
- Type: type of the field. Array/List denote the same concept of collection of values. Object is used for composite fields and nested structure
- Multiplicity: 1 means non repeatable. N means repeatable. Fields with type Array/List are non repeatable, but they can obviously contain several values.
- Mandatory: M means Mandatory, R is reccomended, O optional. Reccomended fields are not mandatory.
- Vocabulary: if the values of the fields must comply with a given vocabulary, this column contain the link to the vocabulary. In case of Array/List of strings, the values in the array/list must comply with the vocabulary.
You can find a more structured definition in json in the folder schemas.
EOSC Resource is the super-class that defines properties shared among the different sub-classes.
| Field | Description | Type | Multiplicity | Mandatory | Vocabulary |
|---|---|---|---|---|---|
| id | A persistent identifier, a unique reference to the Resource | String | 1 | M | |
| alternativePIDs | Other persistent identifiers | List of Objects | 1 | O | |
| alternativePIDs.pid | PID value | String | 1 | M | |
| alternativePIDs.pidSchema | PID schema | String | 1 | O | |
| url | URLs resolving to the resource | URL | N | O | |
| name | Name or title of the resource | String | 1 | M | |
| description | A high-level description in fairly non-technical terms of a) what the Resource does, functionality it provides and Resources it enables to access, b) the benefit to a user/customer delivered by a Resource; benefits are usually related to alleviating pains (e.g., eliminate undesired outcomes, obstacles or risks) or producing gains (e.g. increased performance, social gains, positive emotions or cost saving), c) list of customers, communities, users, etc. using the Resource. | String | 1 | M | |
| publishingDate | date in which the resource was made available for discovery and access to others | Date (ISO 8601) | 1 | M | |
| type | Type of the resource. | String | 1 | M | One among: Service, DataSource, Adapter, InteroperabilityGuidelines, TrainingMaterial, DeployableApplication |
| nodePID | Node the resource belongs to | PID | 1 | M | |
| resourceOwner | PID of the organization that manages or delivers the Resource | PID | 1 | O | |
| publicContact | Email to contact for the resource | N | M |
A Service is an EOSC Resource. As such, it inherits all its fields. In addition, a Service has the following properties:
| Field | Description | Type | Multiplicity | Mandatory | Vocabulary |
|---|---|---|---|---|---|
| serviceProviders | The name(s) (or abbreviation(s)) of Provider(s) that manage or deliver the Service in federated scenarios. | array of Strings | 1 | R | |
| webpage | Webpage with information about the Service usually hosted and maintained by the Provider. | URL | 1 | M | |
| logo | Link to the logo/visual identity of the Service. The logo will be visible at the Portal. If there is no specific logo for the Service the logo of the Provider may be used. | URL | 1 | R | |
| scientificDomains | The branch of science, scientific discipline that is related to the Service. | Object | 1 | R | |
| scientificDomains.scientificDomain | string | 1 | M | SCIENTIFIC_DOMAIN | |
| scientificDomains.scientificSubdomain | string | 1 | M | SCIENTIFIC_SUBDOMAIN | |
| categories | list of objects | 1 | R | ||
| categories.category | string | 1 | M | CATEGORY | |
| categories.subcategory | string | 1 | M | SUBCATEGORY | |
| tags | free text Keywords associated to the Service to simplify search by relevant keywords. | array of string | 1 | R | |
| accessType | Type of access to the service (e.g. physical, virtual) | string | 1 | R | ACCESS_TYPE |
| jurisdiction | The property defines the jurisdiction of the users of the service, based on the vocabulary for this property | string | 1 | M | DS_JURISDICTION |
| trl | The Technology Readiness Level of the Service | string Vocabulary TRL | 1 | M | TRL |
| termsOfUse | Webpage describing the rules, Service conditions and usage policy which one must agree to abide by in order to use the Service. | URL | 1 | O | |
| privacyPolicy | Link to the privacy policy applicable to the Service. | URL | 1 | O | |
| accessPolicy | Information about the access policies that apply. | URL | 1 | O | |
| orderType | Information on the order type: if the service is open access of if an order is required. | string | 1 | O | ORDER_TYPE |
| order | Webpage through which an order for the Service can be placed. | URL | 1 | O | |
| relatedInteroperabilityGuidelines | Interoperability Guidelines this service complies with | Array of object | 1 | O | |
| interoperabilityGuideline | identifier of the guideline | string | 1 | M | |
| configurationInstance | if the guideline defines a configuration template, the service can provide a configuration instance to specify how it can be called. The structure of this field depends on the configuration template of the related guideline. | object | N | O |
A Data Source is a specific type of Service. As such, it inherits all its fields. In addition, a Data Source has the following properties:
| Field | Description | Type | Multiplicity | Mandatory | Vocabulary |
|---|---|---|---|---|---|
| submissionPolicyUrl | This policy provides a comprehensive framework for the contribution of research products. Criteria for submitting content to the repository as well as product preparation guidelines can be stated. Concepts for quality assurance may be provided. | URL | 1 | R | |
| preservationPolicyUrl | This policy provides a comprehensive framework for the long-term preservation of the research products. Principles aims and responsibilities must be clarified. An important aspect is the description of preservation concepts to ensure the technical and conceptual utility of the content | URL | 1 | R | |
| versionControl | If data versioning is supported: the data source explicitly allows the deposition of different versions of the same object | Boolean | 1 | O | |
| persistentIdentitySystems | The persistent identifier systems that are used by the Data Source to identify the ProductType it supports | lis of objects | 1 | R | |
| persistentIdentitySystems.persistentIdentityProductType | Specify the ProductType to which the persistent identifier is referring to. | String | 1 | M | DS_RESEARCH_ENTITY_TYPE |
| persistentIdentitySystems.persistentIdentityProductTypeScheme | Specify the list of persistent identifier schemes used to refer to other research-related entities (e.g., authors, organizations, etc.) | List of string | N | M | Each value from vocabulary DS_PERSISTENT_IDENTITY_SCHEME |
| dataSourceClassification | The specific type of the data source based on the vocabulary defined for this property | string | 1 | M | DS_CLASSIFICATION |
| researchProductTypes | The types of OpenAIRE products managed by the data source, based on the vocabulary for this property | array of strings Vocabulary: Research Product Type | 1 | M | DS_RESEARCH_ENTITY_TYPE |
| thematic | Boolean value specifying if the data source is dedicated to a given discipline or is instead discipline agnostic | Boolean | 1 | M | |
| metadataLicense | License of metadata about the data hosted by the source. It specifies under which license all metadata in the repository can be accessed, used, and repurposed. | Object | 1 | R | SPDX_LICENSE |
| metadataLicense.licenseName | Name of the license | string | 1 | R | |
| metadataLicense.licenseURL | URL of the license | URL | 1 | R |
An Adapter is an EOSC Resource. As such, it inherits all its fields. In addition, a Adapter has the following properties:
| Field | Description | Type | Multiplicity | Mandatory | Vocabulary |
|---|---|---|---|---|---|
| linkedResource | EOSC Service or Guideline reference | Object | 1 | M | |
| linkedResource.type | Type of resource linked | String. One among: Service, InteroperabilityGuidelines | 1 | M | |
| linkedResource.id | Unique ID of the resource linked | String | 1 | M | |
| tagline | Short (one-sentence) description | String | 1 | O | |
| logo | URL to the logo of the adapter | URL | 1 | O | |
| documentation | Documentation webpage (eg, read-the-docs page) | URL | 1 | M | |
| repository | Code repository webpage (eg, Github repository) | URL | 1 | M | |
| package | Software package releases webpage | URL | 1 | M | |
| programmingLanguage | Programming language | String | 1 | M | ADAPTER_PROGRAMMING_LANGUAGE |
| license | License of the source code of the adapter | Object | 1 | M | SPDX_LICENSE |
| license.licenseName | Name of the license | String | 1 | M | |
| license.licenseURL | URL of the license | URL | 1 | M | |
| version | Software version | String | 1 | M | |
| changeLog | Changes in the latest version | String | 1 | M | |
| lastUpdate | Latest update date | Date (ISO 8601) | 1 | M | |
| creator | PersonType | N | M | ||
| creator.firstName | First Name of the person | string | 1 | M | |
| creator.lastName | Last Name of the person | string | 1 | M | |
| creator.email | Email of the person | string | 1 | O | |
| creator.pids | persistent ids of the person | List of objects | 1 | O | |
| creator.pids.pid | pid | string | 1 | M | |
| creator.pids.pidScheme | PID scheme | string | 1 | M | |
| creator.affiliations | The organizational or institutional affiliation of the person. | List of objects | 1 | O | |
| creator.affiliations.affiliationName | Name of the organisation | string | 1 | M | |
| creator.affiliations.affiliationIdentifiers | Uniquely identifies the organizational affiliation of the person. | List of objects | 1 | O | |
| creator.affiliations.affiliationIdentifiers.id | PID of the organisation | string | 1 | M | |
| creator.affiliations.affiliationIdentifiers.type | Type of the PID of the organisation | string | 1 | M | |
| creator.role | Role of the person in the context of this entity | String Vocabulary Credit Taxonomy | 1 | O | CREDIT |
| notes | Notes: for optional attributes | Object | 1 | O | |
| notes.sqa | Software quality information | Object | 1 | O | |
| notes.sqa.url | URL to the software quality scores | URL | 1 | M | |
| notes.sqa.badge | Badge | String | 1 | M / O* | Badge |
An InteroperabilityGuideline is an EOSC Resource. As such, it inherits all its fields. In addition, an InteroperabilityGuideline has the following properties:
| Field | Description | Type | Multiplicity | Mandatory | Vocabulary |
|---|---|---|---|---|---|
| resourceTypesInfo | Interoperability Guideline type. | object | 1 | M | |
| resourceTypesInfo.resourceTypeGeneral | Type of the resource. Default value, not editable: "Guideline" | string('Guideline') | 1 | M | |
| resourceTypesInfo.resourceType | Specific type of the guideline. | string | 1 | M | |
| license | License of the source code of the adapter | Object | 1 | M | SPDX_LICENSE |
| license.licenseName | Name of the license | String | 1 | M | |
| license.licenseURL | URL of the license | URL | 1 | M | |
| relatedStandards | Standards related to the guideline This should point out to related standards only when it is a prerequisitite/dependency, and likely to influence a Provider’s design towards interoperability based on the guideline. | list of objects | 1 | O | |
| relatedStandards.relatedStandardURI | The URI of the related standard. | URL | 1 | M | |
| relatedStandards.relatedStandardIdentifier | The name of the related standard. | string | 1 | M | |
| creator | PersonType | N | M | ||
| creator.firstName | First Name of the person | string | 1 | M | |
| creator.lastName | Last Name of the person | string | 1 | M | |
| creator.email | Email of the person | string | 1 | O | |
| creator.pids | persistent ids of the person | List of objects | 1 | O | |
| creator.pids.pid | pid | string | 1 | M | |
| creator.pids.pidScheme | PID scheme | string | 1 | M | |
| creator.affiliations | The organizational or institutional affiliation of the person. | List of objects | 1 | O | |
| creator.affiliations.affiliationName | Name of the organisation | string | 1 | M | |
| creator.affiliations.affiliationIdentifiers | Uniquely identifies the organizational affiliation of the person. | List of objects | 1 | O | |
| creator.affiliations.affiliationIdentifiers.id | PID of the organisation | string | 1 | M | |
| creator.affiliations.affiliationIdentifiers.type | Type of the PID of the organisation | string | 1 | M | |
| creator.role | Role of the person in the context of this entity | String Vocabulary Credit Taxonomy | 1 | O | CREDIT |
| configurationTemplate | The configuration template defines the properties that a compliant resource should have to enable machine-interoperability | PID | N | O |
A DeployableApplication is an EOSC Resource. As such, it inherits all its fields. In addition, a DeployableApplication has the following properties:
| Field | Description | Type | Multiplicity | Mandatory | Vocabulary |
|---|---|---|---|---|---|
| acronym | Acronym of the Application | string | 1 | M | |
| tagline | Short catch-phrase for marketing and advertising purposes. It will be usually displayed close to the Resource name and should refer to the main value or purpose of the Resource. | string | 1 | O | |
| logo | Link to the logo of the deployable application. | URL | 1 | O | |
| version | Version of the Resource. | string | 1 | M | |
| lastUpdate | Date of the latest update of the Resource. | date | 1 | O | |
| license | License of the deployable application | Object | 1 | R | SPDX_LICENSE |
| license.licenseURL | URL of the license | URL | 1 | R | |
| license.licenseName | Name of the license | string | 1 | R | |
| scientificDomains | The branch of science, scientific discipline that is related to the Service. | list of Objects | 1 | R | |
| scientificDomains.scientificDomain | string | 1 | M | SCIENTIFIC_DOMAIN | |
| scientificDomains.scientificSubdomain | string | 1 | M | SCIENTIFIC_SUBDOMAIN | |
| tags | Keywords associated to the Resource to simplify search by relevant keywords. | list of string | 1 | O | |
| creator | PersonType | N | M | ||
| creator.firstName | First Name of the person | string | 1 | M | |
| creator.lastName | Last Name of the person | string | 1 | M | |
| creator.email | Email of the person | string | 1 | O | |
| creator.pids | persistent ids of the person | List of objects | 1 | O | |
| creator.pids.pid | pid | string | 1 | M | |
| creator.pids.pidScheme | PID scheme | string | 1 | M | |
| creator.affiliations | The organizational or institutional affiliation of the person. | List of objects | 1 | O | |
| creator.affiliations.affiliationName | Name of the organisation | string | 1 | M | |
| creator.affiliations.affiliationIdentifiers | Uniquely identifies the organizational affiliation of the person. | List of objects | 1 | O | |
| creator.affiliations.affiliationIdentifiers.id | PID of the organisation | string | 1 | M | |
| creator.affiliations.affiliationIdentifiers.type | Type of the PID of the organisation | string | 1 | M | |
| creator.role | Role of the person in the context of this entity | String Vocabulary Credit Taxonomy | 1 | O | CREDIT |
A TrainingResource is an EOSC Resource. As such, it inherits all its fields. In addition, a TrainingResource has the following properties:
| Field | Description | Type | Multiplicity | Mandatory | Vocabulary |
|---|---|---|---|---|---|
| eoscRelatedServices | PIDs of services related to this training resource | list of string | 1 | M | |
| keywords | The keyword(s) or tag(s) used to describe the resource. | 1 | M | ||
| license | License of the training resource | LicenseType | 1 | M | |
| license.licenseURL | URL of the license | String | 1 | M | |
| license.licenseName | Name of the license | string | 1 | M | |
| accessRights | The access status of a resource (open, restricted, paid). | string | 1 | M | TR_ACCESS_RIGHT |
| versionDate | The date of the latest version of the training resource | Date (ISO 8601) | 1 | M | |
| targetGroups | The principal users(s) for which the learning resource was designed. | list of string | 1 | M | TARGET_USER |
| learningResourceTypes | The predominant type or kind that characterizes the learning resource. | list of string | 1 | M | TR_DCMI_TYPE |
| learningOutcomes | The descriptions of what knowledge, skills or abilities students should acquire on completion of the resource. | list of string | 1 | M | |
| expertiseLevel | Target skill level in the topic being taught. | string | N | M | TR_EXPERTISE_LEVEL |
| contentResourceTypes | The predominant content type of the learning resource (video, game, diagram, slides, etc.). | list of string | 1 | M | TR_CONTENT_RESOURCE_TYPE |
| qualifications | Identification of certification, accreditation or badge obtained with course or learning resource. | string | 1 | R | TR_QUALIFICATION |
| duration | Approximate or typical time it takes to work with or through the learning resource for the typical intended target audience. | string | N | M | |
| languages | The language in which the resource was originally published or made available. | list of string (ISO 2-letter codes) | 1 | O | LANGUAGE |
| scientificDomains | The branch of science, scientific discipline that is related to the Service. | list of Objects | 1 | R | |
| scientificDomains.scientificDomain | string | 1 | M | SCIENTIFIC_DOMAIN | |
| scientificDomains.scientificSubdomain | string | 1 | M | SCIENTIFIC_SUBDOMAIN | |
| creator | PersonType | N | M | ||
| creator.firstName | First Name of the person | string | 1 | M | |
| creator.lastName | Last Name of the person | string | 1 | M | |
| creator.email | Email of the person | string | 1 | O | |
| creator.pids | persistent ids of the person | List of objects | 1 | O | |
| creator.pids.pid | pid | string | 1 | M | |
| creator.pids.pidScheme | PID scheme | string | 1 | M | |
| creator.affiliations | The organizational or institutional affiliation of the person. | List of objects | 1 | O | |
| creator.affiliations.affiliationName | Name of the organisation | string | 1 | M | |
| creator.affiliations.affiliationIdentifiers | Uniquely identifies the organizational affiliation of the person. | List of objects | 1 | O | |
| creator.affiliations.affiliationIdentifiers.id | PID of the organisation | string | 1 | M | |
| creator.affiliations.affiliationIdentifiers.type | Type of the PID of the organisation | string | 1 | M | |
| creator.role | Role of the person in the context of this entity | String Vocabulary Credit Taxonomy | 1 | O | CREDIT |
| Field | Description | Type | Multiplicity | Mandatory | Vocabulary |
|---|---|---|---|---|---|
| id | A persistent identifier, a unique reference to the organisation | String | 1 | M | |
| alternativePIDs | Other persistent identifiers | list of Objects | 1 | O | |
| alternativePIDs.pid | PID value | String | 1 | M | |
| alternativePIDs.pidSchema | PID schema | String | 1 | O | |
| name | Name of the organisation | String | 1 | M | |
| abbreviation | Acronym or short name of the organisation | String | 1 | M | |
| website | Website of the organisation | URL | 1 | M | |
| country | Country of incorporation or Physical location of the organisation or its coordinating centre in the case of distributed, virtual, and mobile providers. | string | 1 | M | COUNTRY |
| legalEntity | Yes if the organisation is a legal entity. False if it is not (e.g. a project consortium) | boolean | 1 | M | |
| legalStatus | Legal status of the Organisation. The legal status is usually noted in the registration act/statutes. For independent legal entities (1) - legal status of the Provider. For embedded organisations (2) - legal status of the hosting legal entity. | string | 1 | R | PROVIDER_LEGAL_STATUS |
| hostingLegalEntity | Name of the organisation/institution legally hosting (housing) the provider/research infrastructure or its coordinating centre. A distinction is made between: (1) research infrastructures that are self-standing and have a defined and distinct legal entity, (2) research infrastructures that are embedded into another institution which is a legal entity (such as a university, a research organisation, etc.). If (1) - name of the research infrastructure, If (2) - name of the hosting organisation. | string | 1 | R | PROVIDER_HOSTING_LEGAL_ENTITY |
| description | A high-level description of the Organisation in fairly non-technical terms, with the vision, mission, objectives, background, experience. | String | 1 | M | |
| logo | Link to the logo/visual identity of the Organisation. | URL | 1 | M | |
| multimedia | Link to video, slideshow, photos, screenshots with details of the Organisation. | List of objects | 1 | O | |
| multimedia.multimediaURL | URL to the multimedia resource. | URL | 1 | M | |
| multimedia.multimediaName | Name of the multimedia resource. | String | 1 | M | |
| publicContact | Email to contact the organisation | N | M | ||
| nodePID | Node the organisation is contributing to | PID | 1 | M |
| Field | Description | Type | Multiplicity | Mandatory | Vocabulary |
|---|---|---|---|---|---|
| id | Persistent identifier of the configuration template | PID | 1 | M | — |
| interoperabilityGuidelineId | Persistent identifier of the interoperability guideline | PID | 1 | M | — |
| name | Name of the configuration template | string | 1 | M | — |
| nodePID | PID of the Node where the template was defined | PID | 1 | M | — |
| formModel | Map defining the structure of the configuration template (fields to be filled in by users) | List of objects (formField) |
N | M | — |
| formModel.formField | Definition of a single form field in the configuration template | object | N | M | — |
| formModel.formField.fieldName | Name of the form field | string | 1 | M | — |
| formModel.formField.fieldType | Type of the form field | string | 1 | M | — |
| formModel.formField.fieldDescription | Description of the form field | string | 1 | O | — |
| formModel.formField.mandatory | Indicates whether the field is mandatory | boolean | 1 | M | — |
| formModel.formField.repeatable | Indicates whether the field is repeatable | boolean | 1 | M | — |