How Can We Help?
Ethical Review XMLEthical Review XML
Overview
This page details the Ethical Review content type. On this page you will find different representations of the data elements contained within this type.
Below is the xsd for the Ethical Review content type that defines the import xml format. Also provided is mapping tables generated based on this XSD as well as an example xml that shows how the fields can be populated.
This is logical broken down into the different elements to help you gain a better understanding of the Ethical Review content type and how to create, read and update these records using the mechanisms provided in Pure.
Note: for the mapping tables all attributes and elements are listed, along with descriptions of the purposes of the field and any data requirements. Attribute are prefaced with an "@" to differentiate from elements, but as shown in the examples this isn't used when generating the xml.
Some elements offer options of which elements to include (such as whether to provide the ID of a person or organisation or name for lookup). These are denoted by reference to "Option Groups" where numbers are used to indicate where multiple elements are part of the same option. See example xmls for demonstrations of how to use these elements.
An Ethical review in Pure is a record that describes a formal review undertaken to evaluate whether
a research proposal adheres to ethical standards. The record contains information about people,
documents and Applications associated with the review, and maintains information about whether the
review is pending, or has been approved or declined. Multiple Applications can be associated with
one Ethical review.
Below are a series of attachments for your reference:
- Simple Example XML - This shows only the mandatory fields that need to be populated
- Advanced Example XML - This shows all fields that can be used. Snippets of this file are shown with their related elements below.
- XSD (Xml Schema Definition) - This is a definition of what structure the XML must follow. This page has been generated based on the contents of the xsd file, and snippets of the definition are shown with their relevant element below
- Editor Example PNG - This image shows the result of loading the advanced example xml into Pure, to allow for easy reference of which fields in Pure point to which elements in the XML. Note that the way the data is presented within your Pure instance may be different due to different configuration
- Webservice Example Response - This shows an example response of retrieving the record generated via this xml via the webservice
Ethical Reviews
ethicalreviews
A list of ethicalreview elements of type ethicalreview
XML Example
<ethicalreviews xmlns="v1.ethicalreview-sync.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk"><!--
For each ethical review to be created in Pure there should be a new entry of the ethicalreview element.
Type should be defined in the "Award Management: Ethical Review Types" classification scheme
-->
<ethicalreview id="ethicalreview2" type="ethicalreview" managedInPure="false">
<title>Title of Ethical Review</title>
<!-- If your Pure is configured for multiple submission languages then alternative translations can be provided below -->
<translatedTitles>
<title lang="de">Translated Title of Ethical Review</title>
</translatedTitles>
<!-- This will be of type ethicalreviewdescription and the default submission language -->
<description>Description of Ethical Review</description>
<!-- This can contain translated descriptions and alternative descriptions for types that are defined in the "Award Management: Types of Ethical Review Descriptions" classification scheme -->
<additionalDescriptions>
<description lang="de" type="ethicalreviewdescription">Description of Ethical Review in another language</description>
<description type="approval_conditions">Example of alternative description fields</description>
</additionalDescriptions>
<!-- Dates should be in the YYYY-MM-DD format and align with the workflow and reply status -->
<validFromDate>2021-02-02</validFromDate>
<validToDate>2025-02-02</validToDate>
<submissionDate>2020-05-31</submissionDate>
<approvedDate>2020-08-17</approvedDate>
<!--<declinedDate>2002-02-02</declinedDate>-->
<extendedDate>2022-09-22</extendedDate>
<extendedToDate>2027-02-02</extendedToDate>
<withdrawnDate>2023-06-11</withdrawnDate>
<!-- Presently can only relate to one application. This application should exist in Pure already -->
<relatedApplications>
<cmns:contentReference contentId="application1"/>
</relatedApplications>
<!-- Presently can only relate to one award. This award should exist in Pure already -->
<relatedAwards>
<cmns:contentReference contentId="award1"/>
</relatedAwards>
<ids><!-- Type should be defined in the "Award Management: Types of Ethical Review IDs" classification scheme -->
<cmns:id type="erm" id="ethicalreview_2"/>
</ids>
<!-- At least one associated person is required -->
<associatedPersons>
<associatedPerson id="001"><!-- If person already exists in Pure can lookup by ID -->
<person lookupId="person1"/>
<!-- Internal Person can be related to both internal and external organisations -->
<organisations>
<organisation lookupId="organisation1"/>
<organisation lookupId="external_organisation_id_002" origin="external"/>
</organisations>
<!-- Person can have a different name recorded against the ethical review if they have changed their name -->
<firstName>Johnny</firstName>
<lastName>D'oe</lastName>
<!-- Roles should be defined in the "Award Management: Ethical Review Roles" classification scheme -->
<personRole>creator</personRole>
</associatedPerson>
<associatedPerson id="002"><!-- Use origin="external" to indicate the person is external -->
<person origin="external">
<firstName>Jennifer</firstName>
<lastName>Dyson</lastName>
</person>
<!-- External people can only be affiliated to external organisations -->
<organisations><!-- If an ID is not provided Pure will attempt to match existing organisations by name. If no match found then a new organisation will be created -->
<organisation origin="external">
<name>National board of Ethics</name>
<country>us</country>
</organisation>
</organisations>
<personRole>creator</personRole>
</associatedPerson>
</associatedPersons>
<!-- Other related organisations. Can be internal or external and matched on ID or details provided -->
<organisations>
<organisation lookupId="organisation2"/>
<organisation origin="external">
<name>National board of Ethics</name>
<country>us</country>
</organisation>
</organisations>
<!-- The internal organisation unit responsible for managing the review. Must already exist in Pure -->
<managedBy lookupId="organisation1"/>
<!-- Keywords should align with defined keywords under the Administrator menu for the Ethical Review content type -->
<keywords>
<keyword>free text keyword</keyword>
<keyword logicalName="ASJCSubjectAreas" key="1500/1506"/>
</keywords>
<links>
<cmns:link id="link1">
<cmns:url>http://foo.com</cmns:url>
<cmns:description>
<cmns:text country="GB" lang="en">foo</cmns:text>
</cmns:description>
<!-- Link type should be defined in the "Types of links for Ethical reviews" classification scheme -->
<cmns:type>unspecified</cmns:type>
</cmns:link>
<cmns:link id="link2">
<cmns:url>http://bar.com</cmns:url>
<cmns:description>
<cmns:text country="GB" lang="en">bar</cmns:text>
</cmns:description>
<cmns:type>externalERM</cmns:type>
</cmns:link>
</links>
<documents>
<document id="doc1"><!-- Pure needs to be able to access the document at this link -->
<fileLocation>https://cdn.elsevier.io/verona/includes/svg/wordmark-elsevier.svg</fileLocation>
<!-- If the following fields aren't provided Pure will attempt to derive from the url -->
<title>Title-Test</title>
<fileName>test.jpg</fileName>
<mimeType>image/jpeg</mimeType>
<!-- License should be defined in the "Document Licences" classification scheme -->
<license>cc_by</license>
<!-- Options include Public, Campus, Restricted or Confidential -->
<visibility>Restricted</visibility>
<!-- Type should be defined in the "Award Management: Types of Ethical Review Documents" classification scheme -->
<type>review</type>
<!-- Version type should be defined in the "Award Management: Types of Ethical Review Document Versions" classification scheme -->
<versionType>currentversion</versionType>
</document>
</documents>
<!-- Options include Public, Campus, Restricted or Confidential -->
<visibility>Public</visibility>
<!-- Options include entryInProgress, underReview and replyReceived. Workflow should be enabled in Pure to load this -->
<workflow>replyReceived</workflow>
<!-- Options are: PENDING, APPROVED, DECLINED, EXTENDED, WITHDRAWN, EXPIRED -->
<ethicalReviewReply>WITHDRAWN</ethicalReviewReply>
<comments>
<cmns:comment>
<cmns:date>2023-05-22</cmns:date>
<cmns:username>skynet</cmns:username>
<cmns:text>A comment to the ethical review</cmns:text>
</cmns:comment>
</comments>
</ethicalreview>
</ethicalreviews>XSD Definition
<xs:element xmlns:xs="http://www.w3.org/2001/XMLSchema" name="ethicalreviews">
<xs:complexType>
<xs:sequence>
<xs:element ref="ethicalreview" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="resumptionToken" type="xs:string">
<xs:annotation>
<xs:documentation>
To enable resumption tokens, add an URL to the "XML source data location" in the job configuration with "{resumptionToken}" as a placeholder, for instance "https://example.org/data?resumptionToken={resumptionToken}".
The endpoint must handle the resumptionToken in the following manner:
If an empty resumptionToken is sent, the endpoint must return all data. If a non-empty resumptionToken is sent, the endpoint must return all data that has changed since the time the resumptionToken was sent.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>ethicalreview
For each ethical review to be created in Pure there should be a new instance of this element
XML Example
<ethicalreview xmlns="v1.ethicalreview-sync.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk"
id="ethicalreview2"
type="ethicalreview"
managedInPure="false">
<title>Title of Ethical Review</title>
<!-- If your Pure is configured for multiple submission languages then alternative translations can be provided below -->
<translatedTitles>
<title lang="de">Translated Title of Ethical Review</title>
</translatedTitles>
<!-- This will be of type ethicalreviewdescription and the default submission language -->
<description>Description of Ethical Review</description>
<!-- This can contain translated descriptions and alternative descriptions for types that are defined in the "Award Management: Types of Ethical Review Descriptions" classification scheme -->
<additionalDescriptions>
<description lang="de" type="ethicalreviewdescription">Description of Ethical Review in another language</description>
<description type="approval_conditions">Example of alternative description fields</description>
</additionalDescriptions>
<!-- Dates should be in the YYYY-MM-DD format and align with the workflow and reply status -->
<validFromDate>2021-02-02</validFromDate>
<validToDate>2025-02-02</validToDate>
<submissionDate>2020-05-31</submissionDate>
<approvedDate>2020-08-17</approvedDate>
<!--<declinedDate>2002-02-02</declinedDate>-->
<extendedDate>2022-09-22</extendedDate>
<extendedToDate>2027-02-02</extendedToDate>
<withdrawnDate>2023-06-11</withdrawnDate>
<!-- Presently can only relate to one application. This application should exist in Pure already -->
<relatedApplications>
<cmns:contentReference contentId="application1"/>
</relatedApplications>
<!-- Presently can only relate to one award. This award should exist in Pure already -->
<relatedAwards>
<cmns:contentReference contentId="award1"/>
</relatedAwards>
<ids><!-- Type should be defined in the "Award Management: Types of Ethical Review IDs" classification scheme -->
<cmns:id type="erm" id="ethicalreview_2"/>
</ids>
<!-- At least one associated person is required -->
<associatedPersons>
<associatedPerson id="001"><!-- If person already exists in Pure can lookup by ID -->
<person lookupId="person1"/>
<!-- Internal Person can be related to both internal and external organisations -->
<organisations>
<organisation lookupId="organisation1"/>
<organisation lookupId="external_organisation_id_002" origin="external"/>
</organisations>
<!-- Person can have a different name recorded against the ethical review if they have changed their name -->
<firstName>Johnny</firstName>
<lastName>D'oe</lastName>
<!-- Roles should be defined in the "Award Management: Ethical Review Roles" classification scheme -->
<personRole>creator</personRole>
</associatedPerson>
<associatedPerson id="002"><!-- Use origin="external" to indicate the person is external -->
<person origin="external">
<firstName>Jennifer</firstName>
<lastName>Dyson</lastName>
</person>
<!-- External people can only be affiliated to external organisations -->
<organisations><!-- If an ID is not provided Pure will attempt to match existing organisations by name. If no match found then a new organisation will be created -->
<organisation origin="external">
<name>National board of Ethics</name>
<country>us</country>
</organisation>
</organisations>
<personRole>creator</personRole>
</associatedPerson>
</associatedPersons>
<!-- Other related organisations. Can be internal or external and matched on ID or details provided -->
<organisations>
<organisation lookupId="organisation2"/>
<organisation origin="external">
<name>National board of Ethics</name>
<country>us</country>
</organisation>
</organisations>
<!-- The internal organisation unit responsible for managing the review. Must already exist in Pure -->
<managedBy lookupId="organisation1"/>
<!-- Keywords should align with defined keywords under the Administrator menu for the Ethical Review content type -->
<keywords>
<keyword>free text keyword</keyword>
<keyword logicalName="ASJCSubjectAreas" key="1500/1506"/>
</keywords>
<links>
<cmns:link id="link1">
<cmns:url>http://foo.com</cmns:url>
<cmns:description>
<cmns:text country="GB" lang="en">foo</cmns:text>
</cmns:description>
<!-- Link type should be defined in the "Types of links for Ethical reviews" classification scheme -->
<cmns:type>unspecified</cmns:type>
</cmns:link>
<cmns:link id="link2">
<cmns:url>http://bar.com</cmns:url>
<cmns:description>
<cmns:text country="GB" lang="en">bar</cmns:text>
</cmns:description>
<cmns:type>externalERM</cmns:type>
</cmns:link>
</links>
<documents>
<document id="doc1"><!-- Pure needs to be able to access the document at this link -->
<fileLocation>https://cdn.elsevier.io/verona/includes/svg/wordmark-elsevier.svg</fileLocation>
<!-- If the following fields aren't provided Pure will attempt to derive from the url -->
<title>Title-Test</title>
<fileName>test.jpg</fileName>
<mimeType>image/jpeg</mimeType>
<!-- License should be defined in the "Document Licences" classification scheme -->
<license>cc_by</license>
<!-- Options include Public, Campus, Restricted or Confidential -->
<visibility>Restricted</visibility>
<!-- Type should be defined in the "Award Management: Types of Ethical Review Documents" classification scheme -->
<type>review</type>
<!-- Version type should be defined in the "Award Management: Types of Ethical Review Document Versions" classification scheme -->
<versionType>currentversion</versionType>
</document>
</documents>
<!-- Options include Public, Campus, Restricted or Confidential -->
<visibility>Public</visibility>
<!-- Options include entryInProgress, underReview and replyReceived. Workflow should be enabled in Pure to load this -->
<workflow>replyReceived</workflow>
<!-- Options are: PENDING, APPROVED, DECLINED, EXTENDED, WITHDRAWN, EXPIRED -->
<ethicalReviewReply>WITHDRAWN</ethicalReviewReply>
<comments>
<cmns:comment>
<cmns:date>2023-05-22</cmns:date>
<cmns:username>skynet</cmns:username>
<cmns:text>A comment to the ethical review</cmns:text>
</cmns:comment>
</comments>
</ethicalreview>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="ethicalreviewType">
<xs:annotation>
<xs:documentation>For each ethical review to be created in Pure there should be a new instance of this element</xs:documentation>
</xs:annotation>
<xs:all>
<xs:element name="title" type="commons:string_1024" minOccurs="1">
<xs:annotation>
<xs:documentation>The title of the ethical review</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="translatedTitles" type="translatedTitles" minOccurs="0">
<xs:annotation>
<xs:documentation>Translated titles of the ethical review. Use if the title is different in another language and your Pure is configured for multiple submission languages</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="description" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>The description of the ethical review. This will add a description of the type /dk/atira/pure/ethicalreview/descriptions/ethicalreviewdescription</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="additionalDescriptions" type="descriptions" minOccurs="0">
<xs:annotation>
<xs:documentation>Descriptions of the ethical review. Use if description is different in another language, or if description is of a type other than /dk/atira/pure/ethicalreview/descriptions/ethicalreviewdescription. Add more classifications to this scheme if needed.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="validFromDate" type="commons:date" minOccurs="0">
<xs:annotation>
<xs:documentation>The date this ethical review is valid from</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="validToDate" type="commons:date" minOccurs="0">
<xs:annotation>
<xs:documentation>The date this ethical review is valid to</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="submissionDate" type="commons:date" minOccurs="0">
<xs:annotation>
<xs:documentation>The date this ethical review was submitted</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="approvedDate" type="commons:date" minOccurs="0">
<xs:annotation>
<xs:documentation>The date this ethical review was approved</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="declinedDate" type="commons:date" minOccurs="0">
<xs:annotation>
<xs:documentation>The date this ethical review was declined</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="extendedDate" type="commons:date" minOccurs="0">
<xs:annotation>
<xs:documentation>The date this ethical review was extended</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="extendedToDate" type="commons:date" minOccurs="0">
<xs:annotation>
<xs:documentation>The new valid to date this ethical review was extended to</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="withdrawnDate" type="commons:date" minOccurs="0">
<xs:annotation>
<xs:documentation>The date this ethical review was withdrawn</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="relatedAwards"
type="commons:contentReferences"
minOccurs="0"
maxOccurs="1">
<xs:annotation>
<xs:documentation>ID of the related award. Presently there is a maximum of one award allowed to be related</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="relatedApplications"
type="commons:contentReferences"
minOccurs="0"
maxOccurs="1">
<xs:annotation>
<xs:documentation>ID of the related application. Presently there is a maximum of one application allowed to be related</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element ref="associatedPersons" minOccurs="1">
<xs:annotation>
<xs:documentation>Internal or External People related to the review. At least one person is required</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="organisations" type="organisations" minOccurs="0">
<xs:annotation>
<xs:documentation>The internal or external organisations that are related to the ethical review. Normally this would be used for organisational units that are not already affiliated with a related person</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="managedBy" type="managedBy" minOccurs="0">
<xs:annotation>
<xs:documentation>The organisation by which the ethical review is managed, this must always be an internal organisation</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="keywords" type="keywords" minOccurs="0">
<xs:annotation>
<xs:documentation>Keywords of the ethical review. Should align with the keyword types defined under Administration -> Keywords for the Ethical Review content type</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="links" type="commons:links" minOccurs="0">
<xs:annotation>
<xs:documentation>Links related to the ethical review. Type should be defined in the classification scheme /dk/atira/pure/links/ethicalreview</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="documents" type="documents" minOccurs="0">
<xs:annotation>
<xs:documentation>The documents related to the ethical review. This document will be uploaded to Pure. The type of document should be defined in the /dk/atira/pure/ethicalreview/document/types classification scheme</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="visibility" type="commons:visibility">
<xs:annotation>
<xs:documentation>Visibility of the review. Options are Public, Campus, Restricted and Confidential</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="workflow" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>
Used to set the workflow state of the ethicalreview (Workflow states: entryInProgress, underReview, replyReceived)
Note that workflow is disabled by default, and must be enabled in Pure, if values are present in this tag
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="ethicalReviewReply" type="ethicalReviewReply" minOccurs="0">
<xs:annotation>
<xs:documentation>
The review reply state. Mandatory if workflow is replyReceived.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="comments" type="commons:comments" minOccurs="0">
<xs:annotation>
<xs:documentation>Comments on the ethical review</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="ids" type="commons:ids" minOccurs="0">
<xs:annotation>
<xs:documentation>Type attribute must be a token from the classification scheme /dk/atira/pure/ethicalreview/ethicalreviewsources. Default empty.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:all>
<xs:attribute type="commons:string_1024" name="id">
<xs:annotation>
<xs:documentation>
Id of the ethical review. This would be the id from an external source. Not visible in PURE.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="type" type="commons:classification">
<xs:annotation>
<xs:documentation>The ethical review type. Must be a valid classification from the /dk/atira/pure/ethicalreview/ethicalreviewtypes classification scheme</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:boolean" name="managedInPure" use="optional">
<xs:annotation>
<xs:documentation>Determines whether the ethical review is managed in Pure, if set to to true the ethical review will be fully editable and deletable in Pure</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
@id |
Id of the ethical review. This would be the id from an external source. Not visible in PURE. |
Yes |
|
@type |
The ethical review type. Must be a valid classification from the /dk/atira/pure/ethicalreview/ethicalreviewtypes classification scheme |
Yes |
|
@managedInPure |
Determines whether the ethical review is managed in Pure, if set to to true the ethical review will be fully editable and deletable in Pure |
xsd:boolean |
Yes |
title |
The title of the ethical review |
Yes |
|
translatedTitles |
Translated titles of the ethical review. Use if the title is different in another language and your Pure is configured for multiple submission languages |
No |
|
description |
The description of the ethical review. This will add a description of the type /dk/atira/pure/ethicalreview/descriptions/ethicalreviewdescription |
xsd:string |
No |
additionalDescriptions |
Descriptions of the ethical review. Use if description is different in another language, or if description is of a type other than /dk/atira/pure/ethicalreview/descriptions/ethicalreviewdescription. Add more classifications to this scheme if needed. |
No |
|
validFromDate |
The date this ethical review is valid from |
No |
|
validToDate |
The date this ethical review is valid to |
No |
|
submissionDate |
The date this ethical review was submitted |
No |
|
approvedDate |
The date this ethical review was approved |
No |
|
declinedDate |
The date this ethical review was declined |
No |
|
extendedDate |
The date this ethical review was extended |
No |
|
extendedToDate |
The new valid to date this ethical review was extended to |
No |
|
withdrawnDate |
The date this ethical review was withdrawn |
No |
|
relatedAwards |
ID of the related award. Presently there is a maximum of one award allowed to be related |
No |
|
relatedApplications |
ID of the related application. Presently there is a maximum of one application allowed to be related |
No |
|
associatedPersons |
Internal or External People related to the review. At least one person is required |
Yes |
|
organisations |
The internal or external organisations that are related to the ethical review. Normally this would be used for organisational units that are not already affiliated with a related person |
No |
|
managedBy |
The organisation by which the ethical review is managed, this must always be an internal organisation |
No |
|
keywords |
Keywords of the ethical review. Should align with the keyword types defined under Administration -> Keywords for the Ethical Review content type |
No |
|
links |
Links related to the ethical review. Type should be defined in the classification scheme /dk/atira/pure/links/ethicalreview |
No |
|
documents |
The documents related to the ethical review. This document will be uploaded to Pure. The type of document should be defined in the /dk/atira/pure/ethicalreview/document/types classification scheme |
No |
|
visibility |
Visibility of the review. Options are Public, Campus, Restricted and Confidential |
Yes |
|
workflow |
Used to set the workflow state of the ethicalreview (Workflow states: entryInProgress, underReview, replyReceived) Note that workflow is disabled by default, and must be enabled in Pure, if values are present in this tag |
xsd:string |
No |
ethicalReviewReply |
The review reply state. Mandatory if workflow is replyReceived. |
No |
|
comments |
Comments on the ethical review |
No |
|
ids |
Type attribute must be a token from the classification scheme /dk/atira/pure/ethicalreview/ethicalreviewsources. Default empty. |
No |
ethicalReviewReply
XML Example
<ethicalReviewReply xmlns="v1.ethicalreview-sync.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk">WITHDRAWN</ethicalReviewReply>XSD Definition
<xs:simpleType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="ethicalReviewReply">
<xs:restriction base="xs:string">
<xs:enumeration value="PENDING"/>
<xs:enumeration value="APPROVED"/>
<xs:enumeration value="DECLINED"/>
<xs:enumeration value="EXTENDED"/>
<xs:enumeration value="WITHDRAWN"/>
<xs:enumeration value="EXPIRED"/>
</xs:restriction>
</xs:simpleType>Restricted value: xs:string
Type |
Value |
Comments |
|---|---|---|
xs:enumeration |
PENDING |
|
xs:enumeration |
APPROVED |
|
xs:enumeration |
DECLINED |
|
xs:enumeration |
EXTENDED |
|
xs:enumeration |
WITHDRAWN |
|
xs:enumeration |
EXPIRED |
|
Translations and Alternative Descriptions
translatedTitles
A list of title elements of type commons:localized_text_1024_lang
XML Example
<translatedTitles xmlns="v1.ethicalreview-sync.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk">
<title lang="de">Translated Title of Ethical Review</title>
</translatedTitles>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="translatedTitles">
<xs:sequence>
<xs:element name="title"
type="commons:localized_text_1024_lang"
maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Translated title of the ethical review. Can be specified in multiple languages, if your Pure is multilingual</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
title |
Translated title of the ethical review. Can be specified in multiple languages, if your Pure is multilingual |
Yes |
descriptions
A list of description elements of type description
XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="descriptions">
<xs:sequence>
<xs:element name="description" type="description" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>description
XML Example
<description xmlns="v1.ethicalreview-sync.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk">Description of Ethical Review</description>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="description">
<xs:simpleContent>
<xs:extension base="commons:localized_text_lang">
<xs:attribute name="type" type="commons:classification" use="required">
<xs:annotation>
<xs:documentation>The ethical review description type. Must be a valid classification from the /dk/atira/pure/ethicalreview/descriptions classification scheme</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:extension>
</xs:simpleContent>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
@type |
The ethical review description type. Must be a valid classification from the /dk/atira/pure/ethicalreview/descriptions classification scheme |
Yes |
Persons
associatedPersons
A list of associatedPerson elements of type associatedPerson
XML Example
<associatedPersons xmlns="v1.ethicalreview-sync.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk">
<associatedPerson id="001"><!-- If person already exists in Pure can lookup by ID -->
<person lookupId="person1"/>
<!-- Internal Person can be related to both internal and external organisations -->
<organisations>
<organisation lookupId="organisation1"/>
<organisation lookupId="external_organisation_id_002" origin="external"/>
</organisations>
<!-- Person can have a different name recorded against the ethical review if they have changed their name -->
<firstName>Johnny</firstName>
<lastName>D'oe</lastName>
<!-- Roles should be defined in the "Award Management: Ethical Review Roles" classification scheme -->
<personRole>creator</personRole>
</associatedPerson>
<associatedPerson id="002"><!-- Use origin="external" to indicate the person is external -->
<person origin="external">
<firstName>Jennifer</firstName>
<lastName>Dyson</lastName>
</person>
<!-- External people can only be affiliated to external organisations -->
<organisations><!-- If an ID is not provided Pure will attempt to match existing organisations by name. If no match found then a new organisation will be created -->
<organisation origin="external">
<name>National board of Ethics</name>
<country>us</country>
</organisation>
</organisations>
<personRole>creator</personRole>
</associatedPerson>
</associatedPersons>XSD Definition
<xs:element xmlns:xs="http://www.w3.org/2001/XMLSchema" name="associatedPersons">
<xs:complexType>
<xs:sequence>
<xs:element ref="associatedPerson" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>associatedPerson
XML Example
<associatedPerson xmlns="v1.ethicalreview-sync.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk"
id="001"><!-- If person already exists in Pure can lookup by ID -->
<person lookupId="person1"/>
<!-- Internal Person can be related to both internal and external organisations -->
<organisations>
<organisation lookupId="organisation1"/>
<organisation lookupId="external_organisation_id_002" origin="external"/>
</organisations>
<!-- Person can have a different name recorded against the ethical review if they have changed their name -->
<firstName>Johnny</firstName>
<lastName>D'oe</lastName>
<!-- Roles should be defined in the "Award Management: Ethical Review Roles" classification scheme -->
<personRole>creator</personRole>
</associatedPerson>XSD Definition
<xs:element xmlns:xs="http://www.w3.org/2001/XMLSchema" name="associatedPerson">
<xs:complexType>
<xs:all>
<xs:element name="person" type="person" minOccurs="0">
<xs:annotation>
<xs:documentation>Details of the internal or external person</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="organisations" type="organisations" minOccurs="0">
<xs:annotation>
<xs:documentation>The internal or external organisations associated to the person</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="firstName" type="commons:string_1024" minOccurs="0">
<xs:annotation>
<xs:documentation>
First name of the person as listed on the ethical review. If not provided will default to the related person's details
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="lastName" type="commons:string_1024" minOccurs="0">
<xs:annotation>
<xs:documentation>
Last name of the person as listed on the ethical review. If not provided will default to the related person's details
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="personRole" type="commons:classification" minOccurs="1">
<xs:annotation>
<xs:documentation>The role of the person on the ethical review. Must be a valid classification from the /dk/atira/pure/ethicalreview/roles/ethicalreview classification scheme</xs:documentation>
</xs:annotation>
</xs:element>
</xs:all>
<xs:attribute type="commons:string_1024" name="id">
<xs:annotation>
<xs:documentation>The ID of this associated person relation</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
@id |
The ID of this associated person relation |
Yes |
|
person |
Details of the internal or external person |
No |
|
organisations |
The internal or external organisations associated to the person |
No |
|
firstName |
First name of the person as listed on the ethical review. If not provided will default to the related person's details |
No |
|
lastName |
Last name of the person as listed on the ethical review. If not provided will default to the related person's details |
No |
|
personRole |
The role of the person on the ethical review. Must be a valid classification from the /dk/atira/pure/ethicalreview/roles/ethicalreview classification scheme |
Yes |
person
Can be an internal or external person. Use origin to enforce either internal or external
If the person is an internal person in Pure, then the lookupId attribute must be used.
If the person is an external person, and id is given, matching will be done on the id. If not found, then matching will be done on name. If still not found, then an external person with the specified id and name will be created.
XML Example
<person xmlns="v1.ethicalreview-sync.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk"
lookupId="person1"/>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="person">
<xs:annotation>
<xs:documentation>
Can be an internal or external person. Use origin to enforce either internal or external
If the person is an internal person in Pure, then the lookupId attribute must be used.
If the person is an external person, and id is given, matching will be done on the id. If not found, then matching will be done on name. If still not found, then an external person with the specified id and name will be created.
</xs:documentation>
</xs:annotation>
<xs:all>
<xs:element name="firstName" type="commons:string_1024" minOccurs="0">
<xs:annotation>
<xs:documentation>First name of the person. Will only be used on external persons</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="lastName" type="commons:string_1024" minOccurs="0">
<xs:annotation>
<xs:documentation>Last name of the person. Will only be used on external persons</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="country" type="commons:classification" minOccurs="0">
<xs:annotation>
<xs:documentation>Token from the classification scheme /dk/atira/pure/core/countries</xs:documentation>
</xs:annotation>
</xs:element>
</xs:all>
<xs:attributeGroup ref="commons:originId">
<xs:annotation>
<xs:documentation>The details used to lookup the related person if they already exist in Pure</xs:documentation>
</xs:annotation>
</xs:attributeGroup>
</xs:complexType>
XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
@commons:originId |
The details used to lookup the related person if they already exist in Pure |
Yes |
|
firstName |
First name of the person. Will only be used on external persons |
No |
|
lastName |
Last name of the person. Will only be used on external persons |
No |
|
country |
Token from the classification scheme /dk/atira/pure/core/countries |
No |
Organisations
organisations
A list of organisation elements of type organisation
XML Example
<organisations xmlns="v1.ethicalreview-sync.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk">
<organisation lookupId="organisation1"/>
<organisation lookupId="external_organisation_id_002" origin="external"/>
</organisations>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="organisations">
<xs:sequence>
<xs:element name="organisation" type="organisation" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>organisation
Can be either an internal or an external organisation, indicated with the 'origin' attribute.
If the organisation is an internal organisation in Pure, only the lookupId attribute is used.
If the organisation is an external organisation and ID is given, matching will be done on the ID. If no match is found, matching will be done on name. If still no match is found, an external organisation will be created, using the available data. (TODO is this true)
XML Example
<organisation xmlns="v1.ethicalreview-sync.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk"
lookupId="organisation1"/>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="organisation">
<xs:annotation>
<xs:documentation>
Can be either an internal or an external organisation, indicated with the 'origin' attribute.
If the organisation is an internal organisation in Pure, only the lookupId attribute is used.
If the organisation is an external organisation and ID is given, matching will be done on the ID. If no match is found, matching will be done on name. If still no match is found, an external organisation will be created, using the available data. (TODO is this true)
</xs:documentation>
</xs:annotation>
<xs:all>
<xs:element name="name" type="commons:string_1024" minOccurs="0">
<xs:annotation>
<xs:documentation>Name of an external organisation</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="country" type="commons:classification" minOccurs="0">
<xs:annotation>
<xs:documentation>The country of the external organisation. Token from /dk/atira/pure/core/countries</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="type" type="commons:classification" minOccurs="0">
<xs:annotation>
<xs:documentation>The type of the external organisation (will default if nothing is written</xs:documentation>
</xs:annotation>
</xs:element>
</xs:all>
<xs:attributeGroup ref="commons:originId">
<xs:annotation>
<xs:documentation>The details used to lookup the related organisation if they already exist in Pure</xs:documentation>
</xs:annotation>
</xs:attributeGroup>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
@commons:originId |
The details used to lookup the related organisation if they already exist in Pure |
Yes |
|
name |
Name of an external organisation |
No |
|
country |
The country of the external organisation. Token from /dk/atira/pure/core/countries |
No |
|
type |
The type of the external organisation (will default if nothing is written |
No |
Keywords
keywords
A list of keyword elements of type commons:keyword
XML Example
<keywords xmlns="v1.ethicalreview-sync.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk">
<keyword>free text keyword</keyword>
<keyword logicalName="ASJCSubjectAreas" key="1500/1506"/>
</keywords>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="keywords">
<xs:sequence>
<xs:element name="keyword" type="commons:keyword" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>A free text and/or classified keyword. Should align with what is defined against the Ethical Review content type under Administrator -> Keywords</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
keyword |
A free text and/or classified keyword. Should align with what is defined against the Ethical Review content type under Administrator -> Keywords |
Yes |
Managed By
managedBy
XML Example
<managedBy xmlns="v1.ethicalreview-sync.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk"
lookupId="organisation1"/>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="managedBy">
<xs:attributeGroup ref="commons:lookupId">
<xs:annotation>
<xs:documentation>The ID of the organisational unit responsible for oversight of this ethical review</xs:documentation>
</xs:annotation>
</xs:attributeGroup>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
@commons:lookupId |
The ID of the organisational unit responsible for oversight of this ethical review |
Yes |
Documents
documents
A list of document elements of type document
XML Example
<documents xmlns="v1.ethicalreview-sync.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk">
<document id="doc1"><!-- Pure needs to be able to access the document at this link -->
<fileLocation>https://cdn.elsevier.io/verona/includes/svg/wordmark-elsevier.svg</fileLocation>
<!-- If the following fields aren't provided Pure will attempt to derive from the url -->
<title>Title-Test</title>
<fileName>test.jpg</fileName>
<mimeType>image/jpeg</mimeType>
<!-- License should be defined in the "Document Licences" classification scheme -->
<license>cc_by</license>
<!-- Options include Public, Campus, Restricted or Confidential -->
<visibility>Restricted</visibility>
<!-- Type should be defined in the "Award Management: Types of Ethical Review Documents" classification scheme -->
<type>review</type>
<!-- Version type should be defined in the "Award Management: Types of Ethical Review Document Versions" classification scheme -->
<versionType>currentversion</versionType>
</document>
</documents>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="documents">
<xs:sequence>
<xs:element name="document" type="document" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>document
XML Example
<document xmlns="v1.ethicalreview-sync.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk"
id="doc1"><!-- Pure needs to be able to access the document at this link -->
<fileLocation>https://cdn.elsevier.io/verona/includes/svg/wordmark-elsevier.svg</fileLocation>
<!-- If the following fields aren't provided Pure will attempt to derive from the url -->
<title>Title-Test</title>
<fileName>test.jpg</fileName>
<mimeType>image/jpeg</mimeType>
<!-- License should be defined in the "Document Licences" classification scheme -->
<license>cc_by</license>
<!-- Options include Public, Campus, Restricted or Confidential -->
<visibility>Restricted</visibility>
<!-- Type should be defined in the "Award Management: Types of Ethical Review Documents" classification scheme -->
<type>review</type>
<!-- Version type should be defined in the "Award Management: Types of Ethical Review Document Versions" classification scheme -->
<versionType>currentversion</versionType>
</document>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="document">
<xs:all>
<xs:element name="type"
type="commons:classification"
minOccurs="0"
default="other">
<xs:annotation>
<xs:documentation>A token from classification scheme /dk/atira/pure/ethicalreview/document/types</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="versionType"
type="commons:classification"
minOccurs="0"
default="currentversion">
<xs:annotation>
<xs:documentation>A token from classification scheme /dk/atira/pure/ethicalreview/document/versiontypes</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="fileLocation" type="commons:string_1024" minOccurs="1">
<xs:annotation>
<xs:documentation>
Location where Pure can read the file from. Must be prefixed with protocol either
http or https. Https is only supported if the remote server uses a trusted
certificate. If the remote server uses a self-signed certificate,
the JVM running Pure will need an updated keystore.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="mimeType" type="commons:string_256" minOccurs="0">
<xs:annotation>
<xs:documentation>The mime type of the file. If not provided, Pure will attempt to derive</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="fileName" type="commons:string_256" minOccurs="0">
<xs:annotation>
<xs:documentation>The file name of the file. If not provided, Pure will attempt to derive</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="title" type="commons:string_1024" minOccurs="0">
<xs:annotation>
<xs:documentation>The title of the file. If not provided, Pure will attempt to derive</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="license" type="commons:classification" minOccurs="0">
<xs:annotation>
<xs:documentation>
Token from the classification scheme /dk/atira/pure/core/document/licenses
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="visibility" type="commons:visibility" minOccurs="0">
<xs:annotation>
<xs:documentation>Visibility of the document. Options are Public, Campus, Restricted and Confidential</xs:documentation>
</xs:annotation>
</xs:element>
</xs:all>
<xs:attribute type="commons:string_1024" name="id" use="required">
<xs:annotation>
<xs:documentation>ID of the document. Not visible in Pure</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
@id |
ID of the document. Not visible in Pure |
Yes |
|
type |
A token from classification scheme /dk/atira/pure/ethicalreview/document/types |
No |
|
versionType |
A token from classification scheme /dk/atira/pure/ethicalreview/document/versiontypes |
No |
|
fileLocation |
Location where Pure can read the file from. Must be prefixed with protocol either http or https. Https is only supported if the remote server uses a trusted certificate. If the remote server uses a self-signed certificate, the JVM running Pure will need an updated keystore. |
Yes |
|
mimeType |
The mime type of the file. If not provided, Pure will attempt to derive |
No |
|
fileName |
The file name of the file. If not provided, Pure will attempt to derive |
No |
|
title |
The title of the file. If not provided, Pure will attempt to derive |
No |
|
license |
Token from the classification scheme /dk/atira/pure/core/document/licenses |
No |
|
visibility |
Visibility of the document. Options are Public, Campus, Restricted and Confidential |
No |
Updated at July 27, 2024