Atom Feeds

NOTE: Atom Feeds are not fully implemented and the documentation is out of date

Table of Contents

Overview

• Overview

Feeds

• Concept Feed
• Source Feed
• Collection Feed

Overview

The OCL API exposes atom feeds at the level of concepts, sources, and collections. Atom feeds include only changes to the concepts, not changes to the metadata of the source or collection. For example, an update to the source_type of a source would not be reflected in the atom feed.

Details

• Feeds are limited to 30 entries by default.
• All date formats are ISO 8601 (e.g. 2011-11-16T14:26:15Z)
• Entries always sorted by updated descending.

Parameters

• limit (Optional) - the maximum number of entries to return; set limit=0 for unlimited; default is 30
• updated_since (Optional) - only include entires updated after the specified date; ISO 8601 date format

Examples

GET /orgs/WHO/sources/ICD-10/concepts/A15.1/atom/
GET /orgs/WHO/sources/ICD-10/atom/
GET /orgs/OmniSDO/collections/StarterSet/concepts/atom/

# Get 30 most recent updates sorted by updated descending
GET /orgs/TESTORG1/sources/S1/atom/

# Get 50 most recent updates sorted by updated descending
GET /orgs/TESTORG1/sources/S1/atom/?limit=50

# Get all updates sorted by updated descending
GET /orgs/TESTORG1/sources/S1/atom/?limit=0

# Get 30 most recent entries sorted by updated descending that have been updated since 2014-09-14
GET /orgs/TESTORG1/sources/S1/atom/?updated_since=2014-09-14T00:00:01Z

# Get 50 most recent entries sorted by updated descending that have been updated since 2014-09-14
GET /orgs/TESTORG1/sources/S1/atom/?limit=50&updated_since=2014-09-14T00:00:01Z

# Get all entries sorted by updated descending that have been updated since 2014-09-14
GET /orgs/TESTORG1/sources/S1/atom/?limit=0&updated_since=2014-09-14T00:00:01Z

Concept Feed

• Get the atom feed of changes to a specific concept

GET /orgs/[:org]/sources/[:source]/concepts/[:concept]/atom/
GET /users/[:user]/sources/[:source]/concepts/[:concept]/atom/
GET /user/sources/[:source]/concepts/[:concept]/atom/

Source Feed

• Get the atom feed of changes to concepts within a source

GET /orgs/[:org]/sources/[:source]/atom/
GET /users/[:user]/sources/[:source]/atom/
GET /user/sources/[:source]/atom/

Example: GET /orgs/TESTORG1/sources/S1/atom/

<feed xmlns="http://www.w3.org/2005/Atom" xml:lang="en-us">
    <title>Updates to S1</title>
    <link href="http://65.99.230.144/orgs/TESTORG1/sources/S1/" rel="alternate" />
    <link href="http://65.99.230.144/orgs/TESTORG1/sources/S1/atom/" rel="self" />
    <id>http://65.99.230.144/orgs/TESTORG1/sources/S1/</id>
    <updated>2014-10-06T09:01:36Z</updated>
    <entry>
        <title>S1C3</title>
        <link href="http://65.99.230.144/orgs/TESTORG1/sources/S1/concepts/S1C3/" rel="alternate" />
        <id>http://65.99.230.144/orgs/TESTORG1/sources/S1/concepts/S1C3/</id>
        <summary type="html">Updated eee in names.</summary>
    </entry>
    <entry>
        <title>C2</title>
        <link href="http://65.99.230.144/orgs/TESTORG1/sources/S1/concepts/C2/" rel="alternate" />
        <id>http://65.99.230.144/orgs/TESTORG1/sources/S1/concepts/C2/</id>
        <summary type="html" />
    </entry>
    <entry>
        <title>CTEST001</title>
        <link href="http://65.99.230.144/orgs/TESTORG1/sources/S1/concepts/CTEST001/" rel="alternate" />
        <id>http://65.99.230.144/orgs/TESTORG1/sources/S1/concepts/CTEST001/</id>
    </entry>
</feed>

Collection Feed

• Get the atom feed of changes to concepts within a source

GET /orgs/[:org]/collections/[:collection]/concepts/atom/
GET /users/[:user]/collections/[:collection]/concepts/atom/
GET /user/collections/[:collection]/concepts/atom/