UA API
by mtaylorfsmb

UA API

Uniform Application API for Federation of State Medical Boards.

Base URL

https://demo-services.fsmb.org/ua
Operations
Type Definitions
SubmissionRequest
Object
fid
string FID

FID to filter (optional if FromDate is set)

fromDate
string date-time

Start date to filter by (optional if Fid is set)

toDate
string date-time

End date to filter by (must be >= FromDate)

SubmissionSummary
Object
id
integer int64
fid
string
name
Name
submitDate
string date-time
Methods: Get summary of submissions
Submission
Object
id
integer int64
fid
string
submitDate
string date-time
application
Application
identity
Identification
names
Names
addresses
Addresses
emailAddresses
EmailAddresses
phones
Phones
medicalEducationTraining
MedicalEducationTraining
postGraduateTraining
PostGraduateTraining
exams
Array of Exam
licenses
Array of License
malpractice
Array of Malpractice
workHistory
Array of WorkHistory
addendum
Addendum
Methods: Get a submission Get submissions
Application
Object
licenseType
string
boardName
string
Types: Submission
Identification
Object
ssn
string
ssnLast4
string
npi
string
usmleId
string
isUSCitizen
string
birthDate
string date-time
birthCity
string
birthStateOrProvince
Region
gender
string
Types: Submission
Name
Object
firstName
string
middleName
string
lastName
string
suffix
string
Types: Names SubmissionSummary
Address
Object
addressType
string
lines
Array of string
city
string
stateOrProvince
Region
zipCode
string
Types: Addresses
Names
Object
legalName
Name
other
Array of Name
Types: Submission
EmailAddress
Object
email
string
Types: EmailAddresses
Addresses
Object
forPublic
Address
forBoard
Address
other
Array of Address
Types: Submission
Phone
Object
phoneType
string
phoneNumber
string
extension
string
Types: Phones
MedicalEducation
Object
school
School
beginDate
string date-time
endDate
string date-time
degree
CodedDescription
graduationDate
string date-time
Types: MedicalEducationTraining
Ecfmg
Object
ecfmgId
string
issueDate
string date-time
Types: MedicalEducationTraining
FifthPathway
Object
school
FifthPathwaySchool
startDate
string date-time
endDate
string date-time
certificateDate
string date-time
Types: MedicalEducationTraining
School
Object
name
string
cibisCode
string
schoolType
CodedDescription
city
string
stateOrProvince
Region
Types: MedicalEducation
FifthPathwaySchool
Object
name
string
affiliatedInstitution
string
city
string
stateOrProvince
Region
Types: FifthPathway
EmailAddresses
Object
forPublic
EmailAddress
forBoard
EmailAddress
other
Array of EmailAddress
Types: Submission
Program
Object
hospitalName
string
affiliatedInstitution
string
city
string
stateOrProvince
Region
Types: AccreditedTraining OtherTraining
Specialty
Object
description
string

Description

Types: AccreditedTraining OtherTraining
Phones
Object
forPublic
Phone
forBoard
Phone
other
Array of Phone
Types: Submission
AccreditedTraining
Object
accreditationType
string

The type of accreditation (ACGME, AOA)

programCode
string

Program code

program
Program

Program

specialty
Specialty

Specialty

programType
string

Program type

trainingStatus
string

Training status

beginDate
string date-time

Start date

endDate
string date-time

End date

Types: PostGraduateTraining
OtherTraining
Object
program
Program

Program

specialty
Specialty

Specialty

programType
string

Program type

trainingStatus
string

Training status

beginDate
string date-time

Start date

endDate
string date-time

End date

Types: PostGraduateTraining
MedicalEducationTraining
Object
graduating
MedicalEducation
other
Array of MedicalEducation
ecfmg
Ecfmg
fifthPathway
FifthPathway
Types: Submission
PostGraduateTraining
Object
accreditedTraining
Array of AccreditedTraining
otherTraining
Array of OtherTraining
Types: Submission
Exam
Object
examType
string
stateBoard
string
examDate
string date-time
numberOfAttempts
integer int32
passFail
string
Types: Submission
License
Object
licenseType
string
licensingEntity
CodedDescription
status
string
practitionerType
CodedDescription
licenseNumber
string
issueDate
string date-time
expirationDate
string date-time
Types: Submission
Malpractice
Object
state
CodedDescription
eventDate
string date-time
patientName
string
courtName
string
caseNumber
string
role
string
lawsuitDate
string date-time
claimStatus
string
insuranceName
string
judgementAmount
number double
behalfAmount
number double
explanation
string
Types: Submission
WorkHistory
Object
id
string
workHistoryType
string
inProgress
boolean
beginDate
string date-time
endDate
string date-time
description
string
addressLines
Array of string
city
string
stateOrProvince
Region
zipCode
string
position
string
department
string
wasEmployed
boolean
hadStaffPrivileges
boolean
wasAffiliated
boolean
percentageClinical
integer int32
percentageAdministrative
integer int32
Types: Submission
CodedDescription
Object
code
string
description
string
Types: License Malpractice MedicalEducation School
Addendum
Object
Types: Submission
Region
Object
code
string
description
string
countryCode
string
countryDescription
string
Types: Address FifthPathwaySchool Identification Program School WorkHistory
Object
Object
Submissions (v1)

Provides access to submissions to a board.

Get a submission
GET /v1/submissions/{board}/{id}
Get submissions
GET /v1/submissions/{board}
Get summary of submissions
GET /v1/submissions/{board}/summary
Get a submission
GET /v1/submissions/{board}/{id}

Authentication

oauth2
ua.read

Gets a specific submission by its unique ID.

Path variables

board
string required

Board identifier

Default:
me
id
integer int64 required

Submission ID

Responses

200 200

OK

Body
application/json
text/json
Submission
404 404

Not Found

application/json
text/json
Example 1
GET https://demo-services.fsmb.org/ua/v1/v1/submissions/me/1234 HTTP/1.1
Get submissions
GET /v1/submissions/{board}

Authentication

oauth2
ua.read

Gets the submissions for a board using the provided criteria.

Path variables

board
string required

Board identifier

Default:
me

Request parameters

$orderBy
string optional

Order in which the items are returned

$page
integer int32 optional

Index of page to return

Default:
0
$pageSize
integer int32 optional

Number of items to return in a page

Max: 100
Default:
25
fid
string FID optional

FID to filter (optional if FromDate is set)

fromDate
string date-time optional

Start date to filter by (optional if Fid is set)

toDate
string date-time optional

End date to filter by (must be >= FromDate)

Responses

200 200

OK

Body
application/json
text/json
Array of Submission
204 204

No Content

application/json
text/json
200 OK
application/json
text/json
Get summary of submissions
GET /v1/submissions/{board}/summary

Authentication

oauth2
ua.read

Get a summary of the submissions for a board meeting the given criteria.

Path variables

board
string required

Board identifier

Default:
me

Request parameters

$orderBy
string optional

Order in which the items are returned

$page
integer int32 optional

Index of page to return

Default:
0
$pageSize
integer int32 optional

Number of items to return in a page

Max: 100
Default:
25
fid
string FID optional

FID to filter (optional if FromDate is set)

fromDate
string date-time optional

Start date to filter by (optional if Fid is set)

toDate
string date-time optional

End date to filter by (must be >= FromDate)

Responses

200 200

OK

Body
application/json
text/json
Array of SubmissionSummary
204 204

No Content

application/json
text/json
$orderBy
string optional

Order in which the items are returned

Operations: Get submissions Get summary of submissions
$page
integer int32 optional

Index of page to return

Default:
0
Operations: Get submissions Get summary of submissions
$pageSize
integer int32 optional

Number of items to return in a page

Max: 100
Default:
25
Operations: Get submissions Get summary of submissions