Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: update use case 3

...

ID

PIAPI-002

Title

Get a List of New/Updated School/Program Data

Actors

Data Consumer - app, website, BI tool, etc

Data School Provider - AAMC, FAIMER, etc

Trigger event

A user or system requests a list of new or updated school/program data added to another system.

Success end condition

The Data Consumer receives a list of the data the consumer is authorized to receive that has recently been added or updated.

Assumptions

The data consumer has access to the data provider.

Description

A third party user or system (data consumer) wants a list of recently added school/program data.

That user or system makes a request to the system that maintains the list of schools (data provider), with a date to only include schools that have been added to or updated in the system since that date.

The maintaining system returns the list of school/program data added since the provided date.

Transaction

Requesting a list of recently added/updated school/program data from another system.

Exceptions

 

Potential Standards

School Data

Program Data

School/Program Data Application Programming Interface (API)


Get Individual

...

School/Program Data by ID

ID

PIAPI-003

Title

Get Individual Medical School/Program Data by ID

Actors

Medical School Data Consumer - app, website, BI tool, etc

Medical School Data Provider - AAMC, FAIMER, etc

Trigger event

A user or system requests medical school/program data by the ID of the medical school/program maintained on another system.

Success end condition

The Medical School Data Consumer receives all publicly available data for the specified medical school. (I can see a situation where there are two end points for this service - one that is for publicly available data and one that is for data that requires a license fee. Could the API be the same, with additional data being provided to those who pay a license fee?)of the data the consumer is authorized to receive for the specified school/program.

Assumptions

The medical school data consumer has access to the medical school/data provider.

Description

A third party user or system (medical school data consumer) wants medical school/program data for a specific medical school/program.

That user or system makes a request to the system that maintains the list of schools/programs (medical school data provider) and provides the ID of the medical school/program.

The maintaining system returns the specific medical school/program data to the third party user or system.

Transaction

Requesting a single record of medical school data from another system.

Exceptions

 

Potential Standards

Medical School Data

Program Data

Medical School/Program Data Application Programming Interface (API)

...


Find a Medical School by (Partial) Name (Would we also want a use case for submitting a City, state, or country and getting back a list of schools? We could generalize this use case to Find a school by characteristic, where the characteristic could be any onbe of a number of things. Or is that too general?)

...