Get a List of All School/Program Data (General comment - let's use more neutral language, so that this could be used by any health professions school or program)

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 Medical School Consumer receives a list of the data the consumer is authorized to receive for medical schools. (Are they getting a list of all schools or data on all schools?)

Assumptions

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

Description

A third party user or system (medical school consumer) wants a list of all medical schools.

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

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

Transaction

Requesting a list of school data from another system.

Exceptions

 

Potential Standards

Medical School Data

Medical School Data Application Programming Interface (API)

 

Get a List of New Medical Schools  

ID

PIAPI-002

Title

Get a List of New Medical Schools

Actors

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

Medical School Provider - AAMC, FAIMER, etc

Trigger event

A user or system requests a list of new medical schools added on another system.

Success end condition

The Medical School Consumer receives a list of all publicly available data for medical schools that have recently been added.

Assumptions

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

Description

A third party user or system (medical school consumer) wants a list of recently added medical schools.

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

The maintaining system returns the list of medical schools added since the provided date.

Transaction

Requesting a list of recently added schools from another system.

Exceptions

 

Potential Standards

Medical School Data

Medical School Data Application Programming Interface (API)

 

Get a List of Updated Medical Schools (Would this included new schools? De we want all updates?)

ID

PIAPI-003

Title

Get a List of Updated Medical Schools

Actors

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

Medical School Provider - AAMC, FAIMER, etc

Trigger event

A user or system requests a list of medical schools updated on another system.

Success end condition

The Medical School Consumer receives a list of all publicly available data for medical schools that have recently been updated.

Assumptions

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

Description

A third party user or system (medical school consumer) wants a list of recently updated medical schools.

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

The maintaining system returns the list of medical schools updated since the provided date.

Transaction

Requesting a list of recently added schools from another system.

Exceptions

 

Potential Standards

Medical School Data

Medical School Data Application Programming Interface (API)

 

Get Individual Medical School Data by ID

ID

PIAPI-004

Title

Get Individual Medical School Data by ID

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 by the ID of the medical school maintained on another system.

Success end condition

The Medical School 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?)

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.

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

The maintaining system returns the specific medical school 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

Medical School 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-005

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

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

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

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

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

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

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

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

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)