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 6 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 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?)

ID

PIAPI-004

Title

Find a Medical School by (Partial) Name

Actors

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

Medical School Provider - AAMC, FAIMER, etc

Trigger event

A user or system queries for medical school data by the (partial) name of the medical school maintained on another system.

Success end condition

The Medical School Consumer receives Medical School search results, including links to full medical school data, based the (partial) name supplied.

Assumptions

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

Description

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

The medical school consumer doesn’t know the ID of the medical school but knows the (partial) name.

That user or system makes a request to the system that maintains the list of schools (medical school provider) and provides the (partial) name of the medical school.

The medical school provider accumulates a list of medical schools that match the supplied (partial) name.

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

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

The medical school provider returns the school data associated with that ID.

Transaction

Requesting a list of medical school data from another system.

Exceptions

 

Potential Standards

Medical School Data

Medical School Search Results

Medical School Data Application Programming Interface (API)

 

Find Medical School by Historical Name - Superficial, Name Changes

ID

PIAPI-005

Title

Find Medical School by Historical Name - Superficial, Name Changes

Actors

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

Medical School Provider - AAMC, FAIMER, etc

Trigger event

A user or system (medical school consumer) queries for medical school data by a historical name of the medical school maintained on another system.

Success end condition

The Medical School Consumer receives the current Medical School data that is associated with the historical name.

Assumptions

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

Description

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

The medical school consumer doesn’t know the ID of the medical school but knows the historical name.

That user or system makes a request to the system that maintains the list of schools (medical school provider) and provides the historical name of the medical school.

The medical school provider returns the list of medical school search results matching the historical name, including links to full medical school data, to the medical school consumer.

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

The medical school provider returns the school data associated with that ID.

The medical school data may contain historical notes describing changes such as name changes.

Transaction

Requesting a list of medical school data from another system.

Exceptions

 

Potential Standards

Medical School Data

Medical School Search Results

Medical School Data Application Programming Interface (API)

 

Find Medical School by Historical Name - Substantial Changes

ID

PIAPI-006

Title

Find Medical School by Historical Name - Substantial Changes

Actors

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

Medical School Provider - AAMC, FAIMER, etc

Trigger event

A user or system (medical school consumer) queries for medical school data by a historical name of the medical school maintained on another system.

Success end condition

The Medical School Consumer receives the historical Medical School data with a link to the current Medical School data that is associated with the historical name.

Assumptions

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

Description

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

The medical school consumer doesn’t know the ID of the medical school but knows the historical name.

That user or system makes a request to the system that maintains the list of schools (medical school provider) and provides the historical name of the medical school.

The medical school provider has a historical record with substantial difference to the current medical school data associated with the historical name.

The medical school provider includes the historical medical school in the search results.

The medical school provider returns the list of medical school search results matching the historical name, including links to full medical school data, to the medical school consumer.

The medical school consumer selects the historical medical school data by ID.

The medical school provider returns the historical medical school data associated with that ID, which includes a link to the current medical school data.

Transaction

Requesting a list of medical school data from another system.

Exceptions

 

Potential Standards

Medical School Data

Medical School Search Results

Medical School Data Application Programming Interface (API)

 

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

ID

PIAPI-007

Title

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

Actors

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

Medical School Provider - AAMC, FAIMER, etc

Trigger event

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

Success end condition

The Medical School Consumer receives a list of links to schools within the requested University.

Assumptions

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

Description

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

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

Transaction

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

Exceptions

 

Potential Standards

Medical School Data

Medical School Data Application Programming Interface (API)

 

Medical School Data Includes a List of 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-008

Title

Medical School Data Includes a List of Program Information

Actors

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

Medical School 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 Consumer receives a list program data 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 consumer has access to the medical school provider.

Description

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

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

Transaction

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

Exceptions

 

Potential Standards

Medical School Data

Medical School Data Application Programming Interface (API)

 

Medical School Data Includes Relationships to Other Schools and Universities

ID

PIAPI-009

Title

Medical School Data Includes Relationships to Other Schools and Universities

Actors

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

Medical School 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 Consumer receives medical school data that includes relationships to other schools, such as campuses to schools and schools to universities.

Assumptions

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

Description

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

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

Transaction

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

Exceptions

 

Potential Standards

Medical School Data

Medical School Data Application Programming Interface (API)

 

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

ID

PIAPI-010

Title

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

Actors

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

Medical School 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 Consumer receives medical school data that includes links to data about the specific medical school that is maintained by another system or organization.

Assumptions

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

Description

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

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

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

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

Transaction

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

Exceptions

 

Potential Standards

Medical School Data

Medical School Data Application Programming Interface (API)

 

A Specific Program is Offered by More Than One School

ID

PIAPI-011

Title

A Specific Program is Offered by More Than One School

Actors

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

Medical School 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 Consumer receives medical school data that includes program data, which contains links to other schools offering this program.

Assumptions

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

Description

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

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

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

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

Transaction

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

Exceptions

 

Potential Standards

Medical School Data

Medical School Data Application Programming Interface (API)

 

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

ID

PIAPI-012

Title

Medical School Provider Supplies Additional Fields

Actors

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

Medical School Provider - AAMC, FAIMER, etc

Trigger event

A user or system requests medical school data from a Medical School Provider.

Success end condition

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

Assumptions

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

Description

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

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

Exceptions

 

Potential Standards

Medical School Data

Medical School Data Application Programming Interface (API)

  • No labels