Child pages
  • API Use Cases
Skip to end of metadata
Go to start of metadata

Please share your API use cases here and list your organization. Thanks!

Some initial ideas...

#Use CaseCallerProviderRelevant spec and data elements
1

Send me all the medical schools/nursing schools/magnet hospitals/training institutions in Los Angeles/California/the USA.

ResearcherANCC, LCME, WFME/FAIMERProfessional Profile - education info institution, occupation info institution; name
2

Send me a unique id for Johns Hopkins School of medicine/Johns Hopkins School of Nursing/Johns Hopkins Hospital.

 ANCC, LCME, WFME/FAIMERProfessional Profile - education info institution, occupation info institution; ID
3

Is Johns Smith enrolled in medical/nursing school?

 Educational Institution, AAMCProfessional Profile - education info
4

Is Cedars Sinai Internal Medicine an accredited training program?

ECFMG, Certifying OrganizationACGMEProfessional Profile - accreditation, program name, program id
5

What's the address and  who is the program director for Cedars Sinai Internal medicine residency program?

ECFMG, Certifying OrganizationACGMEProfessional Profile - program name, program id, we would need name and contact information
6

Is Cedars Sinai a magnet hospital/have specialty accreditation or recognition (ie CoC accreditation - https://www.facs.org/quality%20programs/cancer/accredited/about) ?

Researcher, consumer-facing application?, insurers?, quality ranking publishersANCC, ACS, ACGME, Joint CommissionWe don't currently have a way to represent this data.
7

Is John Smith licensed/certified/maintaining certification?

Employers, Insurers, Lawyers, Consumer-facing applicationsLicensing/Registration Authority, Certifying BoardProfessional Profile - CertificationInfo, LicenseInfo.
8

What restrictions does his license have?

Employers, Insurers, Lawyers, Consumer-facing applications, Certifying BoardLicensing/Registration AuthorityProfessional Profile - LicenseCategory (free text)
9

What disciplinary actions do(es) his license(s) have?

Employers, Insurers, Lawyers, Consumer-facing applications, Certifying BoardLicensing/Registration AuthorityProfessionalProfile - DisciplinaryInfo
10

What QI projects or efforts will meet MOC requirements for my specialty?

Individual Health Professional, EmployersCertifying Board, ABMS

MOC requirements - none

QI projects - Healthcare Lom point release,

11

I'm John Smith, using some mobile app or Web site, and it wants to know my complete academic history, I authorized you to provide it. (AAMC, a real scenario)

Individual Health ProfessionalAAMCProfessional Profile - EducationInfo
12

Please provide a complete list of medical/nursing/pharmacy schools in the US (or worldwide) (name, code number, state).

Certifying Boards, Licensing Boards, Postgraduate Training Programs, Academic PublishersWFME/FAIMER, LCME, Accrediting AgenciesProfessional Profile - InstitutionInfo (would need to make a list)
13

Please provide all the other top-level information you have about Johns Hopkins (like what's in the AAMC's MSAR application), and yes I'm willing to pay (a little).

Consumer-facing applicationAAMCWe don't currently have a way to represent this data.
14

Remember that complete list of medical/nursing schools I got from you yesterday, can you just provide a list of what, if anything, has changed?

Certifying Boards, Licensing Boards, Postgraduate Training Programs, Academic PublishersWFME/FAIMER, LCME, Accrediting AgenciesProfessional Profile - InstitutionInfo (would need to make a list)
15

... and if I provided a URL or email address, could you notify me if anything changes or gets added?

Certifying Boards, Licensing Boards, Postgraduate Training Programs, Academic PublishersWFME/FAIMER, LCME, Accrediting AgenciesProfessional Profile - email address (for subscription API)
16

Give me all questions/material/information you have for this learning objective/other learning metadata like keyword, resource type, instructional method. (flesh out more)

Curriculum management system/Educational InstitutionEducational content/assessment provider, AAMCCurriculum Inventory - the CI working group is very interested in moving this forward.
17

Give me all the questions associated with this learning objective.

Curriculum management system/Educational InstitutionEducational content/assessment provider, AAMC

Competency Object/Competency Framework

The questions themselves would use something like QTI

18

An HR person says, give me the list if all of our doctors who are due for MOC in 2016. (I'm wondering if the use case really - is Johns SMith due for MOC in 2016. How would the board know the current employer?)

EmployerCertifying BoardProfessional Profile - UniqueID, Name, address
19

Or give me a list if doctors who received MOC in 2016. Update the HR system. (Ditto)

EmployerCertifying BoardProfessional Profile - UniqueID, Name, address
20

There may be a series of APIs to compile a curriculum inventory.

Curriculum Inventory Provider (currently AAMC)health professions schoolCurriculum Inventory
21What are the prior names of this institution (school, hospital)?  When did the name change?Certifying Organization; Regulatory AuthorityAAMC, WFME/FAIMER, AACN, AHAProfessional Profile - institution info (we have validity date attribute... not sure if that is enough)
22What are the former names for this health professional, if any?Certifying Organization; Regulatory AuthorityABMS, CNC, ANCC?, Regulatory Authority?Professional Profile - Former Name
23    

See RESTful API summary.

  • No labels