Child pages
  • Program Information API Use Cases

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Added use cases to cover alternate IDs

Note - see Data Model from Amy Opalek

Get a List of All School/Program Data 

...

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 Medical School/Program by Characteristic(Partials) Name

Actors

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

Medical School Data Provider - AAMC, FAIMER, etc

Trigger event

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

Success end condition

The Medical School Data Consumer receives Medical School school/program search results, including links to full medical school/program data, based the characteristic(partials) name supplied.

Assumptions

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

Description

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 third party user or system (medical school data consumer) wants medical school/program data for a specific medical school/program.

The medical school consumer doesn’t know the ID of the medical school but knows the (partial) name./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 (medical school data provider) and provides the characteristic(partials) name of the medical school/program.

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

The medical school data provider returns the list of medical school/program search results, including links to full medical school/program 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

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

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 has access to the medical school provider.

Description

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

The medical school data provider returns the school/program 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/program 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 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-007005

Title

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

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 University by ID.

Success end condition

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

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 University data by ID.

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

Transaction

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

Exceptions

 

Potential Standards

Medical School DataMedical

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 Includes Alternate IDs for School or Program Data 

ID

PIAPI-012010

Title

Medical School Provider Supplies Additional FieldsData Provider Includes Alternate IDs for School or Program Data

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, plus additional information known by the specific Medical School Provider/program, including alternate IDs for the 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) 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 data provider has alternate IDs for the school/program.

The data provider returns the specific school/program data to the third party user or system, including the alternate IDs.

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 Consumer Retrieves School or Program Data Using an Alternate ID

ID

PIAPI-011

Title

Data Consumer Retrieves School or Program Data Using an Alternate ID

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 using an ID from another organization.

Success end condition

The Data Consumer receives all publicly available data for the school/program.

Assumptions

The data consumer has access to the data provider.

Description

A third party user or system is able to parse the data including the additional data(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) using an ID from another organization.

The data provider maps the provided ID to its local identifier for 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 medical school/program data from another system.

Exceptions

 

Potential Standards

Medical School DataMedical

Program Data

School/Program Data Application Programming Interface (API)