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

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Next »

Get a List of All School/Program Data 

ID

PIAPI-001

Title

Get a List of All School/Program Data

Actors

Data Consumer - app, website, BI tool, etc

Data Provider - AAMC, FAIMER, etc

Trigger event

A user or system requests a list of school/program data maintained on another system.

Success end condition

The Data Consumer receives a list of the data the consumer is authorized to receive for schools/programs.

Assumptions

The data consumer has access to the data provider.

Description

A third party user or system (data consumer) wants a list of all schools/programs.

That user or system makes a request to the system that maintains the list of schools/programs.

The maintaining system returns the list of schools/programs to the third party user or system.

Transaction

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

Exceptions

 

Potential Standards

School Data

Program Data

School/Program Data Application Programming Interface (API)

 

Get a List of New/Updated School/Program Data 

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 School/Program Data by ID

Actors

Data Consumer - app, website, BI tool, etc

Data Provider - AAMC, FAIMER, etc

Trigger event

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

Success end condition

The Data Consumer receives all of the data the consumer is authorized to receive for the specified school/program.

Assumptions

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

Description

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

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

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

Transaction

Requesting a single record of school data from another system.

Exceptions

 

Potential Standards

School Data

Program Data

School/Program Data Application Programming Interface (API)


Find a School/Program by Characteristic(s)

ID

PIAPI-004

Title

Find a School/Program by Characteristic(s)

Actors

Data Consumer - app, website, BI tool, etc

Data Provider - AAMC, FAIMER, etc

Trigger event

A user or system queries for school/program data by characteristic(s) of the school/program maintained on another system.

Success end condition

The Data Consumer receives school/program search results, including links to full school/program data, based the characteristic(s) supplied.

Assumptions

The data consumer has access to the data provider.

Description

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

The consumer doesn’t know the ID of the school/program but wants to search by characteristic(s) - name, country, state/province, language

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

The data provider accumulates a list of schools that match the supplied characteristic(s).

The data provider returns the list of school/program search results, including links to full school/program data, to the data consumer.

The data consumer determines the target school/program in the list and requests the school/program data by ID.

The data provider returns the school/program data associated with that ID.

Transaction

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

Exceptions

 

Potential Standards

School Data

Program Data

School/Program Search Results

School/Program Data Application Programming Interface (API)


Requesting a University by ID Returns a List of Schools of that University

ID

PIAPI-005

Title

Requesting a University by ID Returns a List of Schools of that University

Actors

Data Consumer - app, website, BI tool, etc

Data Provider - AAMC, FAIMER, etc

Trigger event

A user or system (data consumer) queries for a University by ID.

Success end condition

The data consumer receives a list of links to schools within the requested University.

Assumptions

The data consumer has access to the data provider.

Description

A third party user or system (data consumer) requests University data by ID.

The medical school provider returns University data, which includes URLs to the school/program data for each school within the university.

Transaction

Requesting a single record of school data from another system.

Exceptions

 

Potential Standards

School Data

Program Data

School/Program Data Application Programming Interface (API)

 

School Data Includes a List of URLs to Program Information (We may want to make this school/sponsor to reflect the language used in graduate medical education training. I'm not sure what language is used in training for advanced nurses - will check).

ID

PIAPI-006

Title

School Data Includes a List of URLs to Program Information

Actors

Data Consumer - app, website, BI tool, etc

Data Provider - AAMC, FAIMER, etc

Trigger event

A user or system (medical school consumer) queries for a medical school by ID.

Success end condition

The Data Consumer receives a list program data URLs for programs provided by the medical school.

Assumptions

The data consumer has access to the data provider.

Description

A third party user or system (data consumer) requests school/program data by ID.

The data provider returns school/program data, which includes URLs to program data provided by that school/program.

Transaction

Requesting a single record of school/program data from another system.

Exceptions

 

Potential Standards

School Data

Program Data

School/Program Data Application Programming Interface (API)

 

School/Program Data Includes Relationships to Other Schools/Programs and Universities

ID

PIAPI-007

Title

School/Program Data Includes Relationships to Other Schools/Programs and Universities

Actors

Data Consumer - app, website, BI tool, etc

Data Provider - AAMC, FAIMER, etc

Trigger event

A user or system (data consumer) queries for a school/program by ID.

Success end condition

The Data Consumer receives school/program data that includes relationships to other schools/programs, such as campuses to schools/programs and schools/programs to universities.

Assumptions

The data consumer has access to the data provider.

Description

A third party user or system (data consumer) requests school/program data by ID.

The data provider returns school/program data, which includes related schools/programs, campuses and universities.

Transaction

Requesting a single record of school/program data from another system.

Exceptions

 

Potential Standards

School Data

Program Data

School/Program Data Application Programming Interface (API)

 

School/Program Data Can Link to the School/Program Data on Another Provider’s System

ID

PIAPI-008

Title

School/Program Data Can Link to the School/Program Data on Another Provider’s System

Actors

Data Consumer - app, website, BI tool, etc

Data Provider - AAMC, FAIMER, etc

Trigger event

A user or system (data consumer) queries for a school/program by ID.

Success end condition

The Data Consumer receives school/program data that includes links to data about the specific school/program that is maintained by another system or organization.

Assumptions

The data consumer has access to the data provider.

Description

A third party user or system (data consumer) requests school/program data by ID.

The data provider knows other organizations maintain data about the requested school/program.

The data provider includes links to the other organization’s data about the school/program.

The data provider returns school/program data, which includes links to the school’s/program's data maintained by other organizations.

Transaction

Requesting a single record of school/program data from another system.

Exceptions

 

Potential Standards

School Data

Program Data

School/Program Data Application Programming Interface (API)

 

A Specific Program is Offered by More Than One School/Program

ID

PIAPI-009

Title

A Specific Program is Offered by More Than One School/Program

Actors

Data Consumer - app, website, BI tool, etc

Data Provider - AAMC, FAIMER, etc

Trigger event

A user or system (data consumer) queries for a school/program by ID.

Success end condition

The Data Consumer receives school/program data that includes program data, which contains links to other schools/programs offering this program.

Assumptions

The data consumer has access to the data provider.

Description

A third party user or system (data consumer) requests school/program data by ID.

The data provider knows a program offered by this school/program is also offered by another school/program.

The data provider includes links to the other school’s/program's data.

The data provider returns school/program data, which includes links to the other school’s/program's data that offers the same program.

Transaction

Requesting a single record of school/program data from another system.

Exceptions

 

Potential Standards

School Data

Program Data

School/Program Data Application Programming Interface (API)

 

Data Provider Supplies Additional Fields (Is this a use case or a requirement?)

ID

PIAPI-010

Title

Data Provider Supplies Additional Fields

Actors

Data Consumer - app, website, BI tool, etc

Data Provider - AAMC, FAIMER, etc

Trigger event

A user or system requests school/program data from a Data Provider.

Success end condition

The Data Consumer receives all publicly available data for the school/program, plus additional information known by the specific Data Provider.

Assumptions

The data consumer has access to the data provider.

Description

A third party user or system (data consumer) wants school/program data.

That user or system makes a request to the system that maintains the list of schools/programs (data provider).

The maintaining system has additional information beyond what is defined in the response data model.

The maintaining system uses a specified method to include additional data and returns the school/program data to the third party user or system.

The third party user or system is able to parse the data including the additional data.

Transaction

Requesting a single record of school/program data from another system.

Exceptions

 

Potential Standards

School Data

Program Data

School/Program Data Application Programming Interface (API)

  • No labels