Skip to end of metadata
Go to start of metadata

Valerie,

 

The below example is from CECity’s API documentation and illustrates how we notify external systems, including ABIM’s, of a user (Diplomate) completing an activity in our system that offers MOC credit.  The notification contains a link to the activity report which includes the MOC information.  The actual snippet of the activity report that contains the MOC information is illustrated below the notification example.

 

Sample Notifications

Activity Completion

Parameters/Path Components

Field Name

Description

Cardinality

XPath

NotificationType

Type of notification.

1

/feed/entry/content/Notification/NotificationType

ActivityID

Globally Unique Identifier for the Activity.

1

/feed/entry/content/Notification/ActivityID

ParticipantID

Globally Unique Identifier for the Participant.

1

/feed/entry/content/Notification/ParticipantID

InstanceID

Globally Unique Identifier for the Activity-Participant attempt.

1

/feed/entry/content/Notification/InstanceID

 

<?xml version="1.0" encoding="UTF-8"?>

<feed xml:lang="en-us" xmlns="http://www.w3.org/2005/Atom">

      <title type="text">Lifetime Web Services (LWS) Response</title>

      <id>tag:cecity.com,2009:/lifetime/</id>

      <rights type="text">Copyright (c) 2009, CECity.com</rights>

      <updated>2009-09-29T19:25:11-04:00</updated>

      <author>

            <name>Lifetime Web Services</name>

      </author>

      <link rel="self" type="application/atom+xml" href="http://api.mysite.org/" />

      <generator uri="http://api.mysite.org" version="1.0" xmlns="http://www.w3.org/2005/Atom">Lifetime Web Services</generator>

      <entry>

            <id>tag:cecity.com,2009:/lifetime/notification/xxxxxxxxxxxxx</id>

            <title type="text" />

            <!-- Time is UTC and military format (YYYY-MM-DDTHH24:MI:SSZ) -->

            <published>2009-09-29T23:25:11Z</published>

            <updated>2009-09-29T23:25:11Z</updated>

            <link rel="related" href="http://api.mysite.org/activities/xxxxxxxxxxxxxx/reports/activity-completion?participantid=xxxxxxxxxxxxxxx" />

            <category term="tag:cecity.com,2008/lifetime/schemas#notification" scheme="tag:cecity.com,2008/lifetime/schemas#type" />

            <content type="application/vnd.lifetime.webservices+notifications+xml">

                  <Notification xmlns="tag:cecity.com,2008:/lifetime/data">

                        <NotificationType>Activity-Completion</NotificationType>

<ActivityID>xxxxxxxxxxxxxxx</ActivityID>

<ParticipantID>xxxxxxxxxxxxxxxxxxx</ParticipantID>

<InstanceID>xxxxxxxxxxxxxxxxInstanceID> <!—- Identifies the activity-participant attempt -->

                  </Notification>

            </content>

      </entry>

</feed>

 

 

Below is an example of the activity report, when the call is made back to CECity’s system to request it, after a notification.  The MOC points are towards the bottom.

 

 

<feed xml:lang="en-us" xmlns="http://www.w3.org/2005/Atom">

  <title type="text">Lifetime Web Services (LWS) Response</title>

  <id>tag:cecity.com,2013:/lifetime/91cd0081-49e8-40ce-88bb-5246b14ca873</id>

<rights type="text">Copyright (c) 2013, CECity.com</rights>

<updated>2013-02-13T20:50:41-05:00</updated>

<author>

  <name>Lifetime Web Services</name>

</author>

<link rel="self" type="application/atom+xml" href="http://api.moc.abim.org/service.svc/activities/xxxxxxx/reports/activity-completion?participantid=xxxxxx" />

<generator uri="http://api.moc.abim.org" version="1" xmlns="http://www.w3.org/2005/Atom">Lifetime Web Services</generator>

  <entry>

    <id>tag:cecity.com,2013:/lifetime/activities/xxxxxxx</id>

<title type="text" />

<updated>2013-02-14T01:50:41Z</updated>

<link rel="related" href="http://api.moc.abim.org/activities/xxxxxxx" />

<category term="tag:cecity.com,2008/lifetime/schemas#activity-report-item" scheme="tag:cecity.com,2008/lifetime/schemas#type" />

<content type="application/vnd.medbiq.activity-report+xml">

  <ActivityReports xsi:schemaLocation="http://ns.medbiq.org/activityreport/v1/ http://ns.medbiq.org/activityreport/v1/activityreport.xsd" xmlns="http://ns.medbiq.org/activityreport/v1/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:m="http://ns.medbiq.org/member/v1/" xmlns:n="http://ns.medbiq.org/name/v1/" xmlns:a="http://ns.medbiq.org/address/v1/" xmlns:ltd="tag:cecity.com,2008:/lifetime/data" xmlns:lom="http://ltsc.ieee.org/xsd/LOM" xmlns:hx="http://ns.medbiq.org/lom/extend/v1/">

    <DateTimeCreated>2013-02-14T01:50:41.1936939Z</DateTimeCreated>

    <ActivityReport>

      <ReportingOrganization>~~</ReportingOrganization>

      <Member>

        <m:UniqueID domain="CECity">xxxxxxxxxxx</m:UniqueID>

        <m:Name><n:GivenName>xxxxxxxxxxx</n:GivenName>

        <n:FamilyName>xxxxxxxxxxxx</n:FamilyName>

        <n:Degree>~~</n:Degree></m:Name>

      </Member>

      <Activity>

        <ProviderOrganization>~~</ProviderOrganization>

        <ActivityName>Communication - Recent Visit PIM</ActivityName>

        <Module>

          <ModuleName>Communication - Recent Visit PIM</ModuleName>

          <Metadata>

            <lom:lom>

              <hx:healthcareMetadata>

                <hx:healthcareEducation>

                  <hx:startDateTime>2008-01-01T05:00:00Z</hx:startDateTime>

                  <hx:endDateTime>9999-12-31T23:59:59Z</hx:endDateTime>

                </hx:healthcareEducation>

              </hx:healthcareMetadata>

            </lom:lom>

          </Metadata>

          <Status>Completed</Status>

          <Results>Pass</Results>

          <CreditCertificate>

            <CreditReceived>

              <hx:accreditingBody>Accreditation Council for Continuing Medical Education</hx:accreditingBody>

              <hx:activityCertification>AMA PRA Category 1 Credit</hx:activityCertification>

              <hx:creditType>CME</hx:creditType>

              <hx:creditUnit>Credits</hx:creditUnit>

              <hx:accreditedProvider>American Board of Internal Medicine</hx:accreditedProvider>

              <hx:numberOfCredits>20.0000</hx:numberOfCredits>

            </CreditReceived>

            <CreditID>ccid:cecity.com:5099769</CreditID>

          </CreditCertificate>

        </Module>

      </Activity>

      <XtensibleInfo>

        <ltd:ParticipantID>xxxxxxxxxxxx</ltd:ParticipantID>

        <ltd:CompletionDate>~~</ltd:CompletionDate>

        <ltd:CreditIssueDate creditID="ccid:cecity.com:5099769">2/13/2013 8:49:50 PM</ltd:CreditIssueDate>

      </XtensibleInfo>

    </ActivityReport>

    <ActivityReport>

      <ReportingOrganization>~~</ReportingOrganization>

      <Member>

        <m:UniqueID domain="CECity">xxxxxxxxxxxxxxx</m:UniqueID>

        <m:Name><n:GivenName>xxxxxxxxxxxx</n:GivenName>

        <n:FamilyName>xxxxxxxxxxx</n:FamilyName>

          <n:Degree>~~</n:Degree>

        </m:Name>

      </Member>

      <Activity>

        <ProviderOrganization>~~</ProviderOrganization>

        <ActivityName>Communication - Recent Visit PIM</ActivityName>

        <Module>

          <ModuleName>Communication - Recent Visit PIM</ModuleName>

          <Metadata>

            <lom:lom>

              <hx:healthcareMetadata>

                <hx:healthcareEducation>

                  <hx:startDateTime>2008-01-01T05:00:00Z</hx:startDateTime>

                  <hx:endDateTime>9999-12-31T23:59:59Z</hx:endDateTime>

                </hx:healthcareEducation>

              </hx:healthcareMetadata>

            </lom:lom>

          </Metadata>

          <Status>Completed</Status>

          <Results>Pass</Results>

          <CreditCertificate>

            <CreditReceived>

              <hx:accreditingBody>American Board of Internal Medicine</hx:accreditingBody>

              <hx:activityCertification>Maintenance of Certification Part IV</hx:activityCertification>

              <hx:creditType>~~</hx:creditType>

              <hx:creditUnit>Points</hx:creditUnit>

              <hx:accreditedProvider>American Board of Internal Medicine</hx:accreditedProvider>

              <hx:numberOfCredits>20.0000</hx:numberOfCredits>

            </CreditReceived>

            <CreditID>ccid:cecity.com:5099766</CreditID>

          </CreditCertificate>

        </Module>

      </Activity>

      <XtensibleInfo>

        <ltd:ParticipantID>aeef78c7-273d-4e18-9125-a7090917268b</ltd:ParticipantID>

        <ltd:CompletionDate>~~</ltd:CompletionDate>

        <ltd:CreditIssueDate creditID="ccid:cecity.com:5099766">2/13/2013 8:49:25 PM</ltd:CreditIssueDate>

      </XtensibleInfo>

    </ActivityReport>

  </ActivityReports>

</content>

  </entry>

</feed> 

 

 

We are also looking at methods to include a reference to an external competency framework, as illustrated below.  The dcterms:references element is from Dublin Core (http://dublincore.org/documents/2012/06/14/dcmi-terms/#terms-references). The rdf:resource attribute is the “linked data” way to refer to another resource from within a resource –i.e., referring to a competency from within an activity report document.

 

 

<CreditFocus>

   <Description>Patient Care Category 1: Abdomen - General</Description>

   <Code>PC1</Code>

   <NumberOfCredits>3</NumberOfCredits>

   <dcterms:references rdf:resource="http://www.example.org/competency/12345">

</CreditFocus>

 

 

Let me know if you have any additional questions.  Carl is available to participate on the next Activity Report call to discuss this, if you would like.

 

Thanks,

Andy

 

  • No labels