Difference between revisions of "Ontology Notes"

From NCBO Wiki
Jump to navigation Jump to search
Line 38: Line 38:
 
* '''Optional arguments:'''
 
* '''Optional arguments:'''
 
** conceptid={conceptid} - returns notes associated with the given term.
 
** conceptid={conceptid} - returns notes associated with the given term.
 +
** instanceid={isntanceid} - returns notes associated with the given instance (individual).
 
** noteid={noteid} - returns notes associated with the given note id.
 
** noteid={noteid} - returns notes associated with the given note id.
−
** instanceid={isntanceid} - returns notes associated with the given instance (individual).
+
** threaded=[true|false] - returns notes in a threaded format where responses are nested in their parent notes. Default is false.
−
** threaded=[true|false] - returns notes in a threaded format where responses are nested in their parent notes.
 
 
** Planned (not yet implemented):
 
** Planned (not yet implemented):
 
*** notetype={notetype} - returns only the notes of the specific type.
 
*** notetype={notetype} - returns only the notes of the specific type.
−
*** includeArchived=[true|false] - include archived notes; default is false.
+
*** includearchived=[true|false] - include archived notes. Default is false.
  
 
=== Get notes for an ontology by virtual id ===
 
=== Get notes for an ontology by virtual id ===
Line 49: Line 49:
 
* '''Signature''': ./virtual/notes/{ontology virtual id}?email={email_address}
 
* '''Signature''': ./virtual/notes/{ontology virtual id}?email={email_address}
 
* '''Description''': returns all notes for the virtual ontology, i.e., all notes associated with any version of this ontology  
 
* '''Description''': returns all notes for the virtual ontology, i.e., all notes associated with any version of this ontology  
−
* '''Optional arguments:'''  
+
* '''Optional arguments:'''
−
** noteType={noteType} - returns only the notes of the specific type
+
** conceptid={conceptid} - returns notes associated with the given term.
−
** includeArchived=[true|false] - include archived notes; default is false.
+
** instanceid={isntanceid} - returns notes associated with the given instance (individual).
−
 
+
** noteid={noteid} - returns notes associated with the given note id.
−
=== Get notes for a concept in an ontology by ontology version id ===
+
** threaded=[true|false] - returns notes in a threaded format where responses are nested in their parent notes. Default is false.
−
 
+
** Planned (not yet implemented):
−
* '''Signature''': ./notes/{ontology version id}/{concept id}?email={email_address}
+
*** notetype={notetype} - returns only the notes of the specific type.
−
* '''Alt Signature''': ./notes/{ontology version id}/?conceptid={uri-encoded concept id}&email={email_address}
+
*** includearchived=[true|false] - include archived notes. Default is false.
−
* '''Description''': returns all notes that are attached to a class in a specific version of the ontology
 
−
* '''Optional arguments:'''
 
−
** noteType={noteType} - returns only the notes of the specific type
 
−
** includeArchived=[true|false] - include archived notes; default is false.
 
−
 
 
−
=== Get notes for a concept in an ontology by virtual id if the ontology ===
 
−
 
 
−
* '''Signature''': ./virtual/notes/{ontology version id}/{concept id}?email={email_address}
 
−
* '''Alt Signature''': ./virtual/notes/{ontology version id}/?conceptid={uri-encoded concept id}&email={email_address}
 
−
* '''Description''': returns all notes for a concept in the virtual ontology, i.e., all notes associated with any version of this ontology
 
−
* '''Optional arguments:'''
 
−
** noteType={noteType} -  returns only the notes of the specific type
 
−
** includeArchived=[true|false] - include archived notes; default is false.
 
−
 
 
−
=== Get notes on another note ===
 
−
 
 
−
* '''Signature''': ./notes/{note id}?email={email_address}
 
−
* '''Description''': returns all notes that are attached to a specific note (usually, replies in a discussion)
 
−
* '''Optional arguments:'''
 
−
** noteType={noteType} - returns only the notes of the specific type
 
−
** includeArchived=[true|false] - include archived notes; default is false.
 
−
 
 
−
=== Create a note for a concept in an ontology (by ontology version id) ===
 
−
 
 
−
* '''Signature''': ''always by ontology version id''
 
−
* '''Description''': creates a note of a specific type with a specific set of values
 
−
** create a note, given
 
−
*** note type
 
−
*** author
 
−
*** date
 
−
*** appliedTo
 
−
*** values
 
−
**** relationship-value pairs
 
  
 
=== Sample of the XML returned for a note ===
 
=== Sample of the XML returned for a note ===

Revision as of 12:45, 26 April 2010

Ontology Notes in BioPortal

BioPortal uses ontology notes to describe a variety of user-specified comments and metadata on ontology, including new-term proposals, proposals for changes, comments and questions about classes, and so on.

Types of notes in BioPortal

The following are the types of notes in BioPortal. Please, email us at support@bioontology.org if you have suggestions for other note types (or specific parameters for the notes).

  • Basic comments (as they are in BioPortal currently)
  • Proposals
    • New term proposal
      • Generated ID
      • PrefName
      • Synonym
      • Definition
      • Superclass
      • Comment
    • New relationship proposal
      • Relationship type: is-a, part-of
      • Relationship target
    • New attribute value proposal
      • Attribute: documentation, definition, etc.
      • New value
      • Flag: replaces the current value (which one, in case of multiple values) or in addition to the current value(s)
      • Special kind of new attribute value proposal: Assigning UMLS semantic type
        • Semantic type
        • Semantic typeID
  • (for later) Structured annotations with user-defined structure
  • (for later) Usage-guideline notes

Services to access and generate notes

(Note: We are currently working on these services. They are not available yet! If you have specific requirements that the list of services below does not satisfy, please contact us at support@bioontology.org)

Get notes for an ontology by version id

  • Signature: ./notes/{ontology version id}?email={email_address}
  • Description: returns all notes for a specific version of the ontology
  • Optional arguments:
    • conceptid={conceptid} - returns notes associated with the given term.
    • instanceid={isntanceid} - returns notes associated with the given instance (individual).
    • noteid={noteid} - returns notes associated with the given note id.
    • threaded=[true|false] - returns notes in a threaded format where responses are nested in their parent notes. Default is false.
    • Planned (not yet implemented):
      • notetype={notetype} - returns only the notes of the specific type.
      • includearchived=[true|false] - include archived notes. Default is false.

Get notes for an ontology by virtual id

  • Signature: ./virtual/notes/{ontology virtual id}?email={email_address}
  • Description: returns all notes for the virtual ontology, i.e., all notes associated with any version of this ontology
  • Optional arguments:
    • conceptid={conceptid} - returns notes associated with the given term.
    • instanceid={isntanceid} - returns notes associated with the given instance (individual).
    • noteid={noteid} - returns notes associated with the given note id.
    • threaded=[true|false] - returns notes in a threaded format where responses are nested in their parent notes. Default is false.
    • Planned (not yet implemented):
      • notetype={notetype} - returns only the notes of the specific type.
      • includearchived=[true|false] - include archived notes. Default is false.

Sample of the XML returned for a note

A single 'Comment' note

<success>
  <accessedResource>/bioportal/virtual/notes/1104</accessedResource>
  <accessDate>2010-04-26 13:02:57.418 PDT</accessDate>
  <data>
    <list>
      <noteBean>
        <id>Note_0a78922c-3d1e-4689-8af8-48d10d4cdaa8</id>
        <ontologyId>1104</ontologyId>
        <type>Comment</type>
        <author>38143</author>
        <created>1272070868364</created>
        <updated>1272070868250</updated>
        <subject>Including clinical trial data as clinical data</subject>
        <body>I note that clinical data is specifically defined not to include clinical trial data. So is anyone already thinking about where at a high level subtrees might be added to deal with clinical trial data and clinical trial management systems? Or is it premature to do that? This is for the CTSAs.</body>
        <createdInOntologyVersion>2</createdInOntologyVersion>
        <appliesToList>
          <appliesTo>
            <fullId>http://bioontology.org/ontologies/BiomedicalResourceOntology.owl#Clinical_Data</fullId>
            <type>Class</type>
          </appliesTo>
        </appliesToList>
      </noteBean>
    </list>
  </data>
</success>

A single 'New Term Proposal' note

A single 'Change Relationship/Hierarchy Proposal' note

A single 'Property Value Change Proposal note

A nested thread of 'Comment' notes

<success>
  <accessedResource>/bioportal/virtual/notes/1104</accessedResource>
  <accessDate>2010-04-26 13:21:28.104 PDT</accessDate>
  <data>
    <list>
      <noteBean>
        <id>Note_0a78922c-3d1e-4689-8af8-48d10d4cdaa8</id>
        <ontologyId>1104</ontologyId>
        <type>Comment</type>
        <author>38143</author>
        <created>1272070868364</created>
        <updated>1272070868250</updated>
        <subject>Including clinical trial data as clinical data</subject>
        <body>I note that clinical data is specifically defined not to include clinical trial data. So is anyone already thinking about where at a high level subtrees might be added to deal with clinical trial data and clinical trial management systems? Or is it premature to do that? This is for the CTSAs.</body>
        <createdInOntologyVersion>2</createdInOntologyVersion>
        <appliesToList>
          <appliesTo>
            <fullId>http://bioontology.org/ontologies/BiomedicalResourceOntology.owl#Clinical_Data</fullId>
            <type>Class</type>
          </appliesTo>
        </appliesToList>
        <associated>
          <noteBean>
            <id>Note_02e4b8cd-f582-411c-8561-035a0f7d1dd9</id>
            <ontologyId>1104</ontologyId>
            <type>Comment</type>
            <author>38144</author>
            <created>1272070984380</created>
            <updated>1272070984243</updated>
            <subject>RE:Including clinical trial data as clinical data</subject>
            <body>Not sure I follow the argument here.&nbsp; Clinical trial data is covered under PHI so no distinction there.&nbsp; Data generated in the course of delivering routine standard of care may be needed in the course of a clinical trial.&nbsp; Does this make clinical trial data an overlapping superset of clinical data?</body>
            <createdInOntologyVersion>2</createdInOntologyVersion>
            <appliesToList>
              <appliesTo>
                <fullId>Note_0a78922c-3d1e-4689-8af8-48d10d4cdaa8</fullId>
                <type>Ontology</type>
              </appliesTo>
            </appliesToList>
            <associated>
              <noteBean>
                <id>Note_6bdc5fae-bd95-492c-ab47-0aaae7a2193a</id>
                <ontologyId>1104</ontologyId>
                <type>Comment</type>
                <author>38143</author>
                <created>1272070985097</created>
                <updated>1272070985195</updated>
                <subject>RE:RE:Including clinical trial data as clinical data</subject>
                <body>I was only reacting to the definition of BRO:Clinical_Data in the current version: "Any type of data obtained in the course of caring for humans outside of measurements obtained in clinical trials". I think I'm agreeing with you that clinical trial data should be overlapping clinical data (whether its a superset I'm not sure). So I'm not clear why the definition that is in the current version is there. Somehow this might be related to the fact that BRO:Data_Object is subclassed partly by function (eg clinical data) and partly by data type (eg image). I would think images could also be a type of clinical data.</body>
                <createdInOntologyVersion>2</createdInOntologyVersion>
                <appliesToList>
                  <appliesTo>
                    <fullId>Note_02e4b8cd-f582-411c-8561-035a0f7d1dd9</fullId>
                    <type>Ontology</type>
                  </appliesTo>
                </appliesToList>
              </noteBean>
              <noteBean>
                <id>Note_1b490c3a-dd19-458a-9446-5184e42d03ab</id>
                <ontologyId>1104</ontologyId>
                <type>Comment</type>
                <author>38145</author>
                <created>1272070986051</created>
                <updated>1272070986093</updated>
                <subject>RE: Including clinical trial data as clinical data</subject>
                <body>Hi David and all,<br><br>Clinical Trial Data should probably be dealt with separately from Clinical Data<br>collected in the course of administering clinical care.&nbsp; The use of Clinical<br>Trial data will be governed by the Consent that the patient signs as part of the<br>IRB Protocol that is set up to allow its collection, while the use Clinical Care<br>Data will be governed by the HIPAA notification that the patient receives, as<br>well as any IRB Protocols set up for the research involved.<br></body>
                <createdInOntologyVersion>2</createdInOntologyVersion>
                <appliesToList>
                  <appliesTo>
                    <fullId>Note_02e4b8cd-f582-411c-8561-035a0f7d1dd9</fullId>
                    <type>Ontology</type>
                  </appliesTo>
                </appliesToList>
              </noteBean>
            </associated>
          </noteBean>
        </associated>
      </noteBean>
    </list>
  </data>
</success>
Retrieved from "https://www.bioontology.org//mediawiki/index.php?title=Ontology_Notes&oldid=9878"