Child pages
  • Program Information API Use Cases

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: resolved editorial comments

...

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-008006

Title

Medical School Data Includes a List of URLs to Program Information

Actors

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

Medical School 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 Medical School Data Consumer receives a list program data URLs for programs provided by the medical school. (Would these be links to more data on each program, or the actual data?)

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) requests medical school/program data by ID.

The medical school data provider returns medical school/program data, which includes (links?) URLs to program data provided by that medical school/program.

Transaction

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

Exceptions

 

Potential Standards

Medical School DataMedical

Program Data

School/Program Data Application Programming Interface (API)

 

...

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

ID

PIAPI-009007

Title

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

Actors

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

Medical School Data Provider - AAMC, FAIMER, etc

Trigger event

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

Success end condition

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

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) requests medical school/program data by ID.

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

Transaction

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

Exceptions

 

Potential Standards

Medical School DataMedical

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-010008

Title

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

Actors

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

Medical School Data Provider - AAMC, FAIMER, etc

Trigger event

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

Success end condition

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

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) requests medical school/program data by ID.

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

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

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

Transaction

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

Exceptions

 

Potential Standards

Medical School DataMedical

Program Data

School/Program Data Application Programming Interface (API)

 

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

ID

PIAPI-011009

Title

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

Actors

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

Medical School Data Provider - AAMC, FAIMER, etc

Trigger event

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

Success end condition

The Medical School Data Consumer receives medical school/program data that includes program data, which contains links to other schools/programs offering this 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) requests medical school/program data by ID.

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

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

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

Transaction

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

Exceptions

 

Potential Standards

Medical School DataMedical

Program Data

School/Program Data Application Programming Interface (API)

 

...

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

ID

PIAPI-012010

Title

Medical School Data Provider Supplies Additional Fields

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 from a Medical School Data Provider.

Success end condition

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

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.

That user or system makes a request to the system that maintains the list of schools/programs (medical school 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 medical 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 medical school/program data from another system.

Exceptions

 

Potential Standards

Medical School DataMedical

Program Data

School/Program Data Application Programming Interface (API)