openapi: '3.1.1'
info:
  title: FCVSUA API
  description: Provides access to applicant FCVS and UA information.
  version: v1
  summary: Provides access to applicant FCVS and UA information
servers:
  - url: https://services-fcvsua-demo.fsmb.org/
paths:
  '/v1/{board}/applicants/{fid}':
    get:
      tags:
        - Applicant
      summary: Get Applicant
      description: Gets the current applicant information.
      parameters:
        - name: board
          in: path
          description: Board code
          required: true
          schema:
            type: string
            default: me
        - name: fid
          in: path
          description: FID of the practitioner
          required: true
          schema:
            maxLength: 9
            minLength: 9
            pattern: '^\d{9}$'
            type: string
            format: FID
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Applicant'
            text/json:
              schema:
                $ref: '#/components/schemas/Applicant'
        '204':
          description: There are no details for the applicant
        '403':
          description: Board code is invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '400':
          description: FID is invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '401':
          description: Unauthorized
  '/v1/{board}/applicants/summary':
    get:
      tags:
        - Applicant
      summary: List Submissions
      description: Gets a list of submissions for the given criteria.
      parameters:
        - name: board
          in: path
          description: Board code
          required: true
          schema:
            type: string
            default: me
        - name: FromDate
          in: query
          description: Gets or sets the from date.
          schema:
            type: string
            format: date-time
        - name: ToDate
          in: query
          description: Gets or sets the to date.
          schema:
            type: string
            format: date-time
        - name: HasPaging
          in: query
          schema:
            type: boolean
        - name: HasSorting
          in: query
          schema:
            type: boolean
        - name: OrderBy
          in: query
          schema:
            type: string
        - name: Page
          in: query
          schema:
            maximum: 2147483647
            minimum: 1
            pattern: '^-?(?:0|[1-9]\d*)$'
            type:
              - integer
              - string
            format: int32
        - name: PageSize
          in: query
          schema:
            maximum: 2147483647
            minimum: 1
            pattern: '^-?(?:0|[1-9]\d*)$'
            type:
              - integer
              - string
            format: int32
        - name: $orderBy
          in: query
          schema:
            type: string
            default: 'ReleaseDateUtc desc,Fid'
        - name: $page
          in: query
          schema:
            pattern: '^-?(?:0|[1-9]\d*)$'
            type:
              - integer
              - string
            format: int32
            default: 1
        - name: $pageSize
          in: query
          schema:
            pattern: '^-?(?:0|[1-9]\d*)$'
            type:
              - integer
              - string
            format: int32
            default: 100
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SubmissionSummary'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SubmissionSummary'
        '403':
          description: Board code is invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '400':
          description: Request is bad
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '401':
          description: Unauthorized
  /connect/token:
    post:
      tags:
        - Token
      summary: Authentication endpoint.
      responses:
        '200':
          description: The Authentication response.
components:
  schemas:
    AccreditedTraining:
      required:
        - accreditationType
        - programCode
        - program
        - specialty
        - programType
        - trainingStatus
      type: object
      properties:
        accreditationType:
          maxLength: 5
          minLength: 1
          type: string
          description: 'The type of accreditation (e.g. ACGME, AOA)'
        programCode:
          maxLength: 10
          minLength: 1
          type: string
          description: Program code
        program:
          description: Program
          $ref: '#/components/schemas/Program'
        specialty:
          description: Specialty
          $ref: '#/components/schemas/Specialty'
        programType:
          maxLength: 100
          minLength: 1
          type: string
          description: Program type
        trainingStatus:
          maxLength: 100
          minLength: 1
          type: string
          description: Training status
        beginDate:
          type: string
          description: Start date
          format: date-time
        endDate:
          type: string
          description: End date
          format: date-time
        percentageClinical:
          pattern: '^-?(?:0|[1-9]\d*)$'
          type:
            - integer
            - string
          description: Percentage of training that was Clinical
          format: int32
        percentageAdministrative:
          pattern: '^-?(?:0|[1-9]\d*)$'
          type:
            - integer
            - string
          description: Percentage of training that was Administrative
          format: int32
        unusualCircumstances:
          oneOf:
            - type: 'null'
            - description: Unusual circumstances
              $ref: '#/components/schemas/UnusualCircumstances'
      description: Accredited training information
    Activity:
      required:
        - type
        - description
      type: object
      properties:
        type:
          maxLength: 100
          minLength: 1
          type: string
          description: Type of activity
        inProgress:
          type: boolean
          description: Is in progress?
        beginDate:
          type: string
          description: Start date
          format: date-time
        endDate:
          type:
            - 'null'
            - string
          description: End date
          format: date-time
        description:
          maxLength: 100
          minLength: 1
          type: string
          description: Description
        addressLines:
          maxItems: 100
          type:
            - 'null'
            - array
          items:
            type: string
          description: Address lines
        city:
          maxLength: 50
          type:
            - 'null'
            - string
          description: City
        stateOrProvince:
          oneOf:
            - type: 'null'
            - description: State/province
              $ref: '#/components/schemas/StateOrProvince'
        postalCode:
          maxLength: 9
          type:
            - 'null'
            - string
          description: Postal code
        position:
          maxLength: 100
          type:
            - 'null'
            - string
          description: Position
        department:
          maxLength: 100
          type:
            - 'null'
            - string
          description: Department
        wasEmployed:
          type: boolean
          description: Was employee?
        hadStaffPrivileges:
          type: boolean
          description: Had staff privileges?
        wasAffiliated:
          type: boolean
          description: Was affiliated?
        percentageClinical:
          pattern: '^-?(?:0|[1-9]\d*)$'
          type:
            - integer
            - string
          description: '% clinical'
          format: int32
        percentageAdministrative:
          pattern: '^-?(?:0|[1-9]\d*)$'
          type:
            - integer
            - string
          description: '% administrative'
          format: int32
      description: Activity information
    Address:
      required:
        - addressType
        - city
        - stateOrProvince
        - postalCode
      type: object
      properties:
        addressType:
          maxLength: 20
          minLength: 1
          type: string
          description: 'Type of address (e.g. Business, Home)'
        lines:
          maxItems: 100
          type: array
          items:
            type: string
          description: Address lines
        city:
          maxLength: 50
          minLength: 1
          type: string
          description: City
        stateOrProvince:
          description: State/province
          $ref: '#/components/schemas/StateOrProvince'
        postalCode:
          maxLength: 9
          minLength: 1
          type: string
          description: Postal code
      description: Mailing address
    Addresses:
      required:
        - primary
      type: object
      properties:
        forPublic:
          oneOf:
            - type: 'null'
            - description: Public address
              $ref: '#/components/schemas/Address'
        forBoard:
          oneOf:
            - type: 'null'
            - description: Board address
              $ref: '#/components/schemas/Address'
        primary:
          description: Primary address
          $ref: '#/components/schemas/Address'
        other:
          type: array
          items:
            $ref: '#/components/schemas/Address'
          description: Other addresses
      description: Mailing addresses
    AmaDemographics:
      required:
        - firstName
        - lastName
      type: object
      properties:
        prefix:
          type:
            - 'null'
            - string
          description: Legal name prefix
        firstName:
          minLength: 1
          type: string
          description: Legal first name
        middleName:
          type:
            - 'null'
            - string
          description: Legal middle name
        lastName:
          minLength: 1
          type: string
          description: Legal last name
        suffix:
          type:
            - 'null'
            - string
          description: Legal name suffix
        birthDate:
          type:
            - 'null'
            - string
          description: Date of birth
          format: date-time
        deathDate:
          type:
            - 'null'
            - string
          description: Date that physician was confirmed deceased
          format: date-time
        isStudent:
          type:
            - 'null'
            - boolean
          description: Indicates if the profile is for a medical student
        amaMembershipStatus:
          type:
            - 'null'
            - string
          description: Membership status (e.g. 'Member')
        degreeCode:
          type:
            - 'null'
            - string
          description: 'Indicates what degree a physician was licensed as (''MD'', ''DO'')'
      description: Physician demographic information
    AmaLicense:
      required:
        - licenseNumber
      type: object
      properties:
        licenseNumber:
          minLength: 1
          type: string
          description: License number
        issueDate:
          type:
            - 'null'
            - string
          description: Issue date
          format: date-time
        expirationDate:
          type:
            - 'null'
            - string
          description: Expiration date
          format: date-time
        lastReportedDate:
          type:
            - 'null'
            - string
          description: Last reported date
          format: date-time
        typeDescription:
          type:
            - 'null'
            - string
          description: 'Type of license (e.g. ''Limited'', ''Pending'', ''Restricted'', ''Temporary'', ''Unlimited'')'
        stateDescription:
          type:
            - 'null'
            - string
          description: State issuing the license
        degreeCode:
          type:
            - 'null'
            - string
          description: 'Licensing degree code (e.g. ''MD'', ''DO'')'
        licenseStatus:
          type:
            - 'null'
            - string
          description: 'Status of license (e.g. ''Active'', ''Inactive'', ''Denied'', ''Unknown'')'
        renewalDate:
          type:
            - 'null'
            - string
          description: Renewal date
          format: date-time
        physicianName:
          oneOf:
            - type: 'null'
            - description: Physician name
              $ref: '#/components/schemas/AmaName'
      description: State medical license information
    AmaMedicalSchool:
      required:
        - schoolName
      type: object
      properties:
        schoolName:
          minLength: 1
          type: string
          description: Name of the medical school
        educationType:
          type:
            - 'null'
            - string
          description: Type of medical education (Degree or Certificate)
        degreeAwarded:
          type:
            - 'null'
            - string
          description: 'Indicates if a degree was awarded (Yes, No, Enrolled, or 5th Pathway)'
        graduationYear:
          type:
            - 'null'
            - string
          description: Graduation year
        graduationDateString:
          type:
            - 'null'
            - string
          description: Graduation year and optionally month in format 'yyyy-mm'
        degreeCode:
          type:
            - 'null'
            - string
          description: 'Degree code (e.g. ''MD'', ''DO'')'
        enrollmentDateString:
          type:
            - 'null'
            - string
          description: Enrollment year and optionally month in format 'yyyy-mm'
      description: Medical education
    AmaMedicalTraining:
      type: object
      properties:
        programName:
          type:
            - 'null'
            - string
          description: Name of the program
        trainingType:
          type:
            - 'null'
            - string
          description: Type of training
        institutionName:
          type:
            - 'null'
            - string
          description: Name of the institution
        institutionState:
          type:
            - 'null'
            - string
          description: State where the institution is located
        beginDate:
          type:
            - 'null'
            - string
          description: Date physician entered residency training program
          format: date-time
        endDate:
          type:
            - 'null'
            - string
          description: Date physician completed or will complete training program
          format: date-time
        primarySpecialty:
          type:
            - 'null'
            - string
          description: Physician's primary medical specialty based upon accredited graduate medical training program information
        confirmationStatus:
          type:
            - 'null'
            - string
          description: 'Indicates that current residency training is (Being Verified, Not Yet Verified, Being Reverified or Verified by primary source)'
        additionalMessage:
          type:
            - 'null'
            - string
          description: Extra messaging pertaining to this medical training record
      description: Medical training
    AmaName:
      required:
        - fullName
      type: object
      properties:
        prefix:
          type:
            - 'null'
            - string
          description: Name prefix
        firstName:
          type:
            - 'null'
            - string
          description: First name
        middleName:
          type:
            - 'null'
            - string
          description: Middle name
        lastName:
          type:
            - 'null'
            - string
          description: Last name
        suffix:
          type:
            - 'null'
            - string
          description: Name suffix
        fullName:
          minLength: 1
          type: string
          description: Full name
      description: Physician name
    AmaNpi:
      required:
        - npiNumber
      type: object
      properties:
        npiNumber:
          minLength: 1
          type: string
          description: NPI number
        deactivationDate:
          type:
            - 'null'
            - string
          description: Date the number was deactivated
          format: date-time
        reactivationDate:
          type:
            - 'null'
            - string
          description: Date the number was reactivated
          format: date-time
        replacementNpiNumber:
          type:
            - 'null'
            - string
          description: Replacement NPI number
        lastReportedDate:
          type:
            - 'null'
            - string
          description: Last reported date
          format: date-time
        endDate:
          type:
            - 'null'
            - string
          description: End date
          format: date-time
      description: NPI information
    AmaReport:
      type: object
      properties:
        id:
          pattern: '^-?(?:0|[1-9]\d*)$'
          type:
            - integer
            - string
          description: AMA unique ID
          format: int64
        asOfDate:
          type: string
          description: Date the report was generated
          format: date-time
        demographics:
          oneOf:
            - type: 'null'
            - description: Demographic information
              $ref: '#/components/schemas/AmaDemographics'
        medicalSchools:
          type: array
          items:
            $ref: '#/components/schemas/AmaMedicalSchool'
          description: Medical education
        medicalTraining:
          type: array
          items:
            $ref: '#/components/schemas/AmaMedicalTraining'
          description: Medical training
        npi:
          type: array
          items:
            $ref: '#/components/schemas/AmaNpi'
          description: NPI information
        licenses:
          type: array
          items:
            $ref: '#/components/schemas/AmaLicense'
          description: Medical licenses
      description: Physician profile
    AmaReportStatus:
      type: integer
      description: AMA report status
    Applicant:
      required:
        - fid
        - application
        - identity
        - names
        - addresses
        - emailAddresses
        - phones
        - pdcReportStatus
      type: object
      properties:
        fid:
          maxLength: 9
          minLength: 9
          pattern: '^\d{9}$'
          type: string
          description: FID of applicant
          format: FID
        application:
          description: Application information
          $ref: '#/components/schemas/Application'
        fcvsProfileStatus:
          description: FCVS profile status
          $ref: '#/components/schemas/FcvsProfileStatus'
        fcvsProfile:
          oneOf:
            - type: 'null'
            - description: 'FCVS profile information, if available'
              $ref: '#/components/schemas/FcvsProfileReport'
        uaStatus:
          description: UA status
          $ref: '#/components/schemas/UaStatus'
        uaSubmission:
          oneOf:
            - type: 'null'
            - description: 'UA submission information, if available'
              $ref: '#/components/schemas/UaSubmission'
        identity:
          description: Identity information
          $ref: '#/components/schemas/Identification'
        names:
          description: Names
          $ref: '#/components/schemas/Names'
        addresses:
          description: Mailing addresses
          $ref: '#/components/schemas/Addresses'
        emailAddresses:
          description: Email addresses
          $ref: '#/components/schemas/EmailAddresses'
        phones:
          description: Phone numbers
          $ref: '#/components/schemas/Phones'
        medicalEducation:
          description: Medical education
          $ref: '#/components/schemas/MedicalEducationTraining'
        postGraduateTraining:
          description: Postgraduate training
          $ref: '#/components/schemas/PostGraduateTraining'
        exams:
          type: array
          items:
            $ref: '#/components/schemas/Exam'
          description: Exams
        licenses:
          type: array
          items:
            $ref: '#/components/schemas/License'
          description: Licenses
        malpractice:
          type: array
          items:
            $ref: '#/components/schemas/Malpractice'
          description: Malpractice information
        activities:
          type: array
          items:
            $ref: '#/components/schemas/Activity'
          description: Chronology of activity
        npdbReportStatus:
          description: 'NPDB report status (`NotAvailable`, `Available`, `Pending`)'
          $ref: '#/components/schemas/NpdbReportStatus'
        npdbReport:
          oneOf:
            - type: 'null'
            - description: 'NPDB report, if available (only available for physicians who have submitted to an NPDB-supported board)'
              $ref: '#/components/schemas/NpdbReport'
        pdcReportStatus:
          description: 'PDC report status (`NotAvailable`, `Available`, `Pending`)'
          $ref: '#/components/schemas/PdcReportStatus'
        pdcReport:
          oneOf:
            - type: 'null'
            - description: 'PDC report, if available'
              $ref: '#/components/schemas/PdcReport'
        amaReportStatus:
          description: 'AMA report status (`NotAvailable`, `Available`, `Pending`, `NotReleased`)'
          $ref: '#/components/schemas/AmaReportStatus'
        ama:
          oneOf:
            - type: 'null'
            - description: 'AMA information, if available'
              $ref: '#/components/schemas/AmaReport'
        stateAddendum:
          oneOf:
            - type: 'null'
            - description: 'State addendum for UA, if applicable'
              $ref: '#/components/schemas/StateAddendum'
      description: Applicant Details
    Application:
      required:
        - boardName
      type: object
      properties:
        boardName:
          maxLength: 100
          minLength: 1
          type: string
          description: Board name
        licenseType:
          maxLength: 5
          type:
            - 'null'
            - string
          description: 'Type of license - MD, DO, PA'
        licenseSubtypeDetails:
          oneOf:
            - type: 'null'
            - description: Subtype of license
              $ref: '#/components/schemas/LicenseSubtype'
      description: Application information
    BoardActionStatus:
      maxLength: 20
      type: integer
      description: 'Board action status (e.g. Alerted, Cleared)'
    Ecfmg:
      required:
        - ecfmgNumber
      type: object
      properties:
        ecfmgNumber:
          maxLength: 8
          minLength: 1
          type: string
          description: ECFMG Number
        issueDate:
          type:
            - 'null'
            - string
          description: Issue date
          format: date-time
      description: ECFMG information
    EmailAddress:
      required:
        - email
      type: object
      properties:
        email:
          maxLength: 100
          minLength: 1
          type: string
          description: Email address
      description: Email address
    EmailAddresses:
      required:
        - primary
      type: object
      properties:
        forPublic:
          oneOf:
            - type: 'null'
            - description: Public email
              $ref: '#/components/schemas/EmailAddress'
        forBoard:
          oneOf:
            - type: 'null'
            - description: Board email
              $ref: '#/components/schemas/EmailAddress'
        primary:
          description: Primary email
          $ref: '#/components/schemas/EmailAddress'
        other:
          type: array
          items:
            $ref: '#/components/schemas/EmailAddress'
          description: Other emails
      description: Email information
    Exam:
      required:
        - examType
        - passFail
      type: object
      properties:
        examType:
          maxLength: 100
          minLength: 1
          type: string
          description: Type of exam
        examDate:
          type: string
          description: Exam date
          format: date-time
        numberOfAttempts:
          pattern: '^-?(?:0|[1-9]\d*)$'
          type:
            - integer
            - string
          description: Number of attempts
          format: int32
        passFail:
          maxLength: 100
          minLength: 1
          type: string
          description: 'Pass/fail status (Pass, Fail, Unknown)'
        stateBoardDetail:
          oneOf:
            - type: 'null'
            - description: State Code and State Board Description
              $ref: '#/components/schemas/ExamStateBoard'
      description: Exam
    ExamStateBoard:
      required:
        - code
        - description
      type: object
      properties:
        code:
          maxLength: 5
          minLength: 1
          type: string
          description: State or province code
        description:
          maxLength: 100
          minLength: 1
          type: string
          description: Description
      description: State board for exam
    FcvsProfileReport:
      required:
        - profileId
        - profileStatus
        - profileSubmitDateUtc
      type: object
      properties:
        profileId:
          maximum: 2147483647
          minimum: 1
          pattern: '^-?(?:0|[1-9]\d*)$'
          type:
            - integer
            - string
          description: Profile ID
          format: int64
        profileStatus:
          description: Profile status
          $ref: '#/components/schemas/FcvsProfileStatus'
        profileSubmitDateUtc:
          type: string
          description: 'Profile submission date/time, in UTC'
          format: date-time
        profileSentDateUtc:
          type:
            - 'null'
            - string
          description: 'Profile sent date/time, in UTC, if any'
          format: date-time
        hasBeenSent:
          type: boolean
          description: Determines if the profile has been sent
      description: FCVS profile information
    FcvsProfileStatus:
      type: integer
      description: Defines the status of an FCVS profile
    FifthPathway:
      required:
        - school
      type: object
      properties:
        school:
          description: School
          $ref: '#/components/schemas/FifthPathwaySchool'
        startDate:
          type: string
          description: Start date
          format: date-time
        endDate:
          type: string
          description: End date
          format: date-time
        certificateDate:
          type: string
          description: Certification date
          format: date-time
      description: 5th Pathway information
    FifthPathwaySchool:
      required:
        - name
        - affiliatedInstitution
      type: object
      properties:
        name:
          maxLength: 100
          minLength: 1
          type: string
          description: School name
        affiliatedInstitution:
          maxLength: 100
          minLength: 1
          type: string
          description: Affiliated institution
        city:
          maxLength: 50
          type:
            - 'null'
            - string
          description: City
        stateOrProvince:
          oneOf:
            - type: 'null'
            - description: State/province
              $ref: '#/components/schemas/StateOrProvince'
      description: 5th Pathway school information
    Identification:
      required:
        - birthDate
        - birthCity
        - birthStateOrProvince
        - gender
      type: object
      properties:
        ssn:
          maxLength: 9
          minLength: 9
          pattern: '^\d{9}$'
          type: string
          description: SSN
          format: SSN
        ssnLast4:
          maxLength: 4
          minLength: 4
          pattern: '^\d{4}$'
          type: string
          description: Last 4 of the SSN
          format: SSN Last 4
        npi:
          maxLength: 10
          minLength: 10
          pattern: '^\d{10}$'
          type: string
          description: NPI
          format: NPI
        usmleId:
          maxLength: 8
          minLength: 8
          pattern: '^\d{8}$'
          type: string
          description: USMLE ID
          format: USMLE ID
        isUSCitizen:
          maxLength: 1
          type:
            - 'null'
            - string
          description: US citizen indicator
        birthDate:
          type: string
          description: Date of birth
          format: date-time
        birthCity:
          maxLength: 40
          minLength: 0
          type: string
          description: City of birth
        birthStateOrProvince:
          description: State/province of birth
          $ref: '#/components/schemas/StateOrProvince'
        gender:
          maxLength: 1
          minLength: 1
          type: string
          description: Gender
      description: Identity information
    License:
      type: object
      properties:
        licenseType:
          maxLength: 100
          type:
            - 'null'
            - string
          description: 'Type of license (e.g. `Active`, `Training`)'
        licensingEntity:
          oneOf:
            - type: 'null'
            - description: Entity issuing license
              $ref: '#/components/schemas/LicensingEntity'
        status:
          maxLength: 100
          type:
            - 'null'
            - string
          description: License status
        practitionerType:
          oneOf:
            - type: 'null'
            - description: Practitioner type
              $ref: '#/components/schemas/PractitionerType'
        licenseNumber:
          maxLength: 20
          type:
            - 'null'
            - string
          description: License number
        issueDate:
          type:
            - 'null'
            - string
          description: Issue date
          format: date-time
        expirationDate:
          type:
            - 'null'
            - string
          description: Expiration date
          format: date-time
      description: License information
    LicenseSubtype:
      required:
        - code
        - description
      type: object
      properties:
        code:
          maxLength: 5
          minLength: 1
          type: string
          description: Code
        description:
          maxLength: 100
          minLength: 1
          type: string
          description: Description of license (e.g. Permanent Medical License
      description: License subtype information
    LicensingEntity:
      required:
        - code
        - description
      type: object
      properties:
        code:
          maxLength: 5
          minLength: 1
          type: string
          description: Entity code
        description:
          maxLength: 100
          minLength: 1
          type: string
          description: Description
      description: Entity issuing license
    Malpractice:
      required:
        - state
        - patientName
        - courtName
        - role
        - claimStatus
        - insuranceName
        - explanation
      type: object
      properties:
        state:
          description: State/province of malpractice
          $ref: '#/components/schemas/StateOrProvince'
        eventDate:
          type: string
          description: Date of event
          format: date-time
        patientName:
          maxLength: 100
          minLength: 1
          type: string
          description: Name of patient
        courtName:
          maxLength: 100
          minLength: 1
          type: string
          description: Name of court
        caseNumber:
          maxLength: 50
          type:
            - 'null'
            - string
          description: Case number
        role:
          maxLength: 100
          minLength: 1
          type: string
          description: Role of practitioner in claim
        lawsuitDate:
          type: string
          description: Date of lawsuit
          format: date-time
        claimStatus:
          maxLength: 100
          minLength: 1
          type: string
          description: Status of claim
        insuranceName:
          maxLength: 100
          minLength: 1
          type: string
          description: Name of insurance
        judgementAmount:
          pattern: '^-?(?:0|[1-9]\d*)(?:\.\d+)?$'
          type:
            - 'null'
            - number
            - string
          description: Amount of judgement
          format: double
        behalfAmount:
          pattern: '^-?(?:0|[1-9]\d*)(?:\.\d+)?$'
          type:
            - 'null'
            - number
            - string
          description: Behalf amount
          format: double
        explanation:
          maxLength: 2000
          minLength: 1
          type: string
          description: Explanation
      description: Malpractice information
    MedicalDegree:
      required:
        - code
        - description
      type: object
      properties:
        code:
          maxLength: 5
          minLength: 1
          type: string
          description: 'Code (e.g. BM, MD, DMCH)'
        description:
          maxLength: 100
          minLength: 1
          type: string
          description: Description
      description: Medical degree
    MedicalEducation:
      required:
        - school
      type: object
      properties:
        school:
          description: Medical school
          $ref: '#/components/schemas/School'
        beginDate:
          type: string
          description: Start date
          format: date-time
        endDate:
          type: string
          description: End date
          format: date-time
        degree:
          oneOf:
            - type: 'null'
            - description: Degree information
              $ref: '#/components/schemas/MedicalDegree'
        graduationDate:
          type:
            - 'null'
            - string
          description: Graduation date
          format: date-time
        unusualCircumstances:
          oneOf:
            - type: 'null'
            - description: Unusual circumstances
              $ref: '#/components/schemas/UnusualCircumstances'
      description: Medical school education
    MedicalEducationTraining:
      required:
        - graduating
      type: object
      properties:
        isInternationalGraduate:
          type: boolean
          description: Is international graduate?
        graduating:
          description: Graduating school
          $ref: '#/components/schemas/MedicalEducation'
        other:
          type: array
          items:
            $ref: '#/components/schemas/MedicalEducation'
          description: Other medical schools
        ecfmg:
          oneOf:
            - type: 'null'
            - description: ECFMG information
              $ref: '#/components/schemas/Ecfmg'
        fifthPathway:
          oneOf:
            - type: 'null'
            - description: 5th Pathway information
              $ref: '#/components/schemas/FifthPathway'
      description: Medical education
    Name:
      required:
        - firstName
        - lastName
        - isSingularName
      type: object
      properties:
        firstName:
          maxLength: 50
          minLength: 1
          type: string
          description: First name
        middleName:
          maxLength: 50
          type:
            - 'null'
            - string
          description: Middle name (optional)
        lastName:
          maxLength: 50
          minLength: 1
          type: string
          description: Last name
        suffix:
          maxLength: 4
          type:
            - 'null'
            - string
          description: 'Suffix (optional, e.g. Jr, Sr)'
        isSingularName:
          type: boolean
          description: Indicates if this is a singular name
      description: Physician name
    Names:
      required:
        - legalName
      type: object
      properties:
        legalName:
          description: Legal name
          $ref: '#/components/schemas/Name'
        other:
          type: array
          items:
            $ref: '#/components/schemas/Name'
          description: Other names
      description: Physician names
    NpdbReport:
      type: object
      properties:
        asOfDate:
          type: string
          description: Date the report was generated.
          format: date-time
        hasAvailableReports:
          type: boolean
          description: Determines if there are any available reports
        availableReports:
          type: array
          items:
            $ref: '#/components/schemas/NpdbReportType'
          description: 'List of available reports, if any'
      description: NPDB report
    NpdbReportStatus:
      type: integer
      description: Defines the status of an NPDB report
    NpdbReportType:
      required:
        - code
        - description
      type: object
      properties:
        code:
          maxLength: 5
          minLength: 1
          type: string
          description: Report code from NPDB
        description:
          maxLength: 200
          minLength: 1
          type: string
          description: Description of report (e.g. LICENSURE)
      description: Type of NPDB report
    OtherTraining:
      required:
        - program
        - specialty
        - programType
        - trainingStatus
      type: object
      properties:
        program:
          description: Program
          $ref: '#/components/schemas/Program'
        specialty:
          description: Specialty
          $ref: '#/components/schemas/Specialty'
        programType:
          maxLength: 100
          minLength: 1
          type: string
          description: Program type
        trainingStatus:
          maxLength: 100
          minLength: 1
          type: string
          description: Training status
        beginDate:
          type: string
          description: Start date
          format: date-time
        endDate:
          type: string
          description: End date
          format: date-time
        percentageClinical:
          pattern: '^-?(?:0|[1-9]\d*)$'
          type:
            - integer
            - string
          description: Percentage of training that was Clinical
          format: int32
        percentageAdministrative:
          pattern: '^-?(?:0|[1-9]\d*)$'
          type:
            - integer
            - string
          description: Percentage of training that was Administrative
          format: int32
        unusualCircumstances:
          oneOf:
            - type: 'null'
            - description: Unusual circumstances
              $ref: '#/components/schemas/UnusualCircumstances'
      description: Non-accredited postgraduate training
    PartialDate:
      type: object
      properties:
        month:
          pattern: '\d{2}'
          type:
            - 'null'
            - string
        day:
          pattern: '\d{2}'
          type:
            - 'null'
            - string
        year:
          pattern: '\d{4}'
          type:
            - 'null'
            - string
        date:
          type:
            - 'null'
            - string
          format: date-time
    PdcAbms:
      type: object
      properties:
        certifications:
          type: array
          items:
            $ref: '#/components/schemas/PdcAbmsCertification'
          description: ABMS certifications
      description: PDC ABMS information
    PdcAbmsCertification:
      required:
        - boardName
        - certificateName
        - certificateType
        - certificateDuration
        - occurrenceType
      type: object
      properties:
        reportDate:
          type: string
          description: Report date
          format: date-time
        boardName:
          maxLength: 100
          minLength: 1
          type: string
          description: Certifying board
        certificateName:
          maxLength: 100
          minLength: 1
          type: string
          description: Certificate name
        meetsMocRequirements:
          maxLength: 20
          type:
            - 'null'
            - string
          description: 'Meets MOC requirements (e.g. Yes, No, Not Required)'
        isCertified:
          type: boolean
          description: Is certified?
        certificateStatus:
          maxLength: 100
          type:
            - 'null'
            - string
          description: 'Status of certificate (e.g. Active, Inactive, Expired)'
        certificateType:
          maxLength: 100
          minLength: 1
          type: string
          description: 'Type of certificate (e.g. General, Subspecialty)'
        certificateDuration:
          maxLength: 20
          minLength: 1
          type: string
          description: 'Duration of the certificate (e.g. Lifetime, MOC, Time Limited)'
        occurrenceType:
          maxLength: 20
          minLength: 1
          type: string
          description: 'Type of occurrence (e.g. Initial, Recertification, Designation)'
        effectiveDate:
          oneOf:
            - type: 'null'
            - description: Effective date
              $ref: '#/components/schemas/PartialDate'
        expirationDate:
          oneOf:
            - type: 'null'
            - description: Expiration date
              $ref: '#/components/schemas/PartialDate'
        reverificationDate:
          type:
            - 'null'
            - string
          description: Reverification date
          format: date-time
        mocPathwayId:
          maxLength: 2
          type:
            - 'null'
            - string
          description: MOC pathway Id
        mocPathwayName:
          maxLength: 100
          type:
            - 'null'
            - string
          description: MOC pathway name
        occupationStatus:
          maxLength: 2
          type:
            - 'null'
            - string
          description: Occupation status (e.g. R)
        occupationStatusNotifyYear:
          pattern: '\d{4}'
          type:
            - 'null'
            - string
          description: Occupation status notification year
      description: PDC ABMS certification
    PdcAoa:
      type: object
      properties:
        certifications:
          type: array
          items:
            $ref: '#/components/schemas/PdcAoaCertification'
          description: AOA certifications
      description: PDC AOA information
    PdcAoaCertification:
      required:
        - aoaId
        - boardName
        - certificationName
        - certificationType
      type: object
      properties:
        aoaId:
          maxLength: 6
          minLength: 1
          type: string
          description: AOA ID
        reportDate:
          type: string
          description: Report date
          format: date-time
        boardName:
          maxLength: 100
          minLength: 1
          type: string
          description: Board name
        certificationName:
          maxLength: 100
          minLength: 1
          type: string
          description: Certification name
        certificationStatus:
          maxLength: 20
          type:
            - 'null'
            - string
          description: 'Certification status (e.g. Active, Inactive, Retired, Deceased)'
        certificationType:
          maxLength: 50
          minLength: 1
          type: string
          description: 'Certification type (e.g. Primary, Subspecialty)'
        isOccParticipating:
          type: boolean
          description: Is OCC participating
        isOccRequired:
          type: boolean
          description: Is OCC required
        certificationIssueDate:
          type:
            - 'null'
            - string
          description: Certification issue date
          format: date-time
        certificationEndDate:
          type:
            - 'null'
            - string
          description: Certification end date
          format: date-time
        recertificationIssueDate:
          type:
            - 'null'
            - string
          description: Recertification issue date
          format: date-time
        recertificationExpireDate:
          type:
            - 'null'
            - string
          description: Recertification expire date
          format: date-time
      description: PDC AOA certification
    PdcGraduationDate:
      required:
        - year
      type: object
      properties:
        year:
          minLength: 1
          type: string
          description: Graduation year
      description: PDC graduation date
    PdcLicense:
      required:
        - issuer
      type: object
      properties:
        reportDate:
          type: string
          description: Report date
          format: date-time
        licenseType:
          maxLength: 100
          type:
            - 'null'
            - string
          description: Type of license
        issuer:
          description: Issuer of license
          $ref: '#/components/schemas/LicensingEntity'
        status:
          maxLength: 100
          type:
            - 'null'
            - string
          description: License status
        licenseNumber:
          maxLength: 20
          type:
            - 'null'
            - string
          description: License number
        issueDate:
          type:
            - 'null'
            - string
          description: Issue date
          format: date-time
        expirationDate:
          type:
            - 'null'
            - string
          description: Expiration date
          format: date-time
      description: PDC license
    PdcMedicalDegree:
      required:
        - code
        - description
      type: object
      properties:
        code:
          maxLength: 5
          minLength: 1
          type: string
          description: Code
        description:
          maxLength: 100
          minLength: 1
          type: string
          description: Description
      description: PDC medical degree
    PdcMedicalEducation:
      type: object
      properties:
        school:
          oneOf:
            - type: 'null'
            - description: Medical school
              $ref: '#/components/schemas/PdcMedicalSchool'
        graduationDate:
          oneOf:
            - type: 'null'
            - description: Graduation date
              $ref: '#/components/schemas/PdcGraduationDate'
        degree:
          oneOf:
            - type: 'null'
            - description: Medical degree
              $ref: '#/components/schemas/PdcMedicalDegree'
      description: PDC medical education
    PdcMedicalSchool:
      required:
        - name
        - cibisCode
        - schoolType
      type: object
      properties:
        name:
          maxLength: 100
          minLength: 1
          type: string
          description: School name
        alternateNames:
          maxItems: 100
          type: array
          items:
            type: string
          description: Alternate school names
        cibisCode:
          maxLength: 6
          minLength: 1
          type: string
          description: CIBIS code
        schoolType:
          description: Type of school
          $ref: '#/components/schemas/SchoolType'
        city:
          maxLength: 50
          type: string
          description: City
        stateOrProvince:
          description: State or province
          $ref: '#/components/schemas/StateOrProvince'
      description: PDC medical school
    PdcName:
      required:
        - lastName
      type: object
      properties:
        firstName:
          maxLength: 50
          type:
            - 'null'
            - string
          description: First name
        middleName:
          maxLength: 50
          type:
            - 'null'
            - string
          description: Middle name
        lastName:
          maxLength: 50
          minLength: 1
          type: string
          description: Last name
        suffix:
          maxLength: 4
          type:
            - 'null'
            - string
          description: Suffix
      description: PDC Name
    PdcNames:
      required:
        - legal
      type: object
      properties:
        legal:
          description: Legal name
          $ref: '#/components/schemas/PdcName'
        other:
          type: array
          items:
            $ref: '#/components/schemas/PdcName'
          description: Other names
      description: PDC names
    PdcNpi:
      required:
        - npiNumber
        - entityType
      type: object
      properties:
        npiNumber:
          maxLength: 10
          minLength: 1
          type: string
          description: NPI number
        entityType:
          maxLength: 20
          minLength: 1
          type: string
          description: 'Entity type (e.g. Individual, Group)'
      description: PDC NPI
    PdcReport:
      required:
        - names
        - medicalEducation
      type: object
      properties:
        asOfDate:
          type: string
          description: Date the report was generated
          format: date-time
        boardActionStatus:
          description: Board action status
          $ref: '#/components/schemas/BoardActionStatus'
        names:
          description: Names
          $ref: '#/components/schemas/PdcNames'
        birthDate:
          oneOf:
            - type: 'null'
            - description: Birth date
              $ref: '#/components/schemas/PartialDate'
        medicalEducation:
          description: Medical education
          $ref: '#/components/schemas/PdcMedicalEducation'
        licenses:
          type: array
          items:
            $ref: '#/components/schemas/PdcLicense'
          description: License information
        npi:
          type: array
          items:
            $ref: '#/components/schemas/PdcNpi'
          description: NPI information
        abms:
          oneOf:
            - type: 'null'
            - description: ABMS information
              $ref: '#/components/schemas/PdcAbms'
        aoa:
          oneOf:
            - type: 'null'
            - description: AOA information
              $ref: '#/components/schemas/PdcAoa'
      description: PDC report
    PdcReportStatus:
      type: integer
      description: 'Defines the status of a PDC report (e.g. `NotAvailable`, `Pending`, `Available`).'
    Phone:
      required:
        - phoneType
        - phoneNumber
      type: object
      properties:
        phoneType:
          maxLength: 20
          minLength: 1
          type: string
          description: 'Type of phone (Business, Home, Mobile)'
        phoneNumber:
          maxLength: 10
          minLength: 1
          type: string
          description: Phone number
        extension:
          maxLength: 4
          type:
            - 'null'
            - string
          description: Phone extension
      description: Phone number
    Phones:
      required:
        - primary
      type: object
      properties:
        forPublic:
          oneOf:
            - type: 'null'
            - description: Public phone
              $ref: '#/components/schemas/Phone'
        forBoard:
          oneOf:
            - type: 'null'
            - description: Board phone
              $ref: '#/components/schemas/Phone'
        primary:
          description: Primary phone
          $ref: '#/components/schemas/Phone'
        other:
          type: array
          items:
            $ref: '#/components/schemas/Phone'
          description: Other phone numbers
      description: Phone information
    PostGraduateTraining:
      type: object
      properties:
        accreditedTraining:
          type: array
          items:
            $ref: '#/components/schemas/AccreditedTraining'
          description: Accredited training
        otherTraining:
          type: array
          items:
            $ref: '#/components/schemas/OtherTraining'
          description: Unaccredited training
      description: Post graduate training
    PractitionerType:
      required:
        - code
        - description
      type: object
      properties:
        code:
          maxLength: 5
          minLength: 1
          type: string
          description: Code
        description:
          maxLength: 100
          minLength: 1
          type: string
          description: Description
      description: Practitioner type
    ProblemDetails:
      type: object
      properties:
        type:
          type:
            - 'null'
            - string
        title:
          type:
            - 'null'
            - string
        status:
          pattern: '^-?(?:0|[1-9]\d*)$'
          type:
            - 'null'
            - integer
            - string
          format: int32
        detail:
          type:
            - 'null'
            - string
        instance:
          type:
            - 'null'
            - string
    Program:
      required:
        - hospitalName
        - city
        - stateOrProvince
      type: object
      properties:
        hospitalName:
          maxLength: 200
          minLength: 1
          type: string
          description: Hospital name
        affiliatedInstitution:
          maxLength: 200
          type:
            - 'null'
            - string
          description: Affiliated institution
        city:
          maxLength: 50
          minLength: 1
          type: string
          description: City
        stateOrProvince:
          description: State/province
          $ref: '#/components/schemas/StateOrProvince'
      description: Postgraduate training program
    School:
      required:
        - name
        - schoolType
      type: object
      properties:
        name:
          maxLength: 100
          minLength: 1
          type: string
          description: School name
        cibisCode:
          maxLength: 6
          type:
            - 'null'
            - string
          description: CIBIS code
        schoolType:
          description: Type of school
          $ref: '#/components/schemas/SchoolType'
        city:
          maxLength: 50
          type:
            - 'null'
            - string
          description: City
        stateOrProvince:
          oneOf:
            - type: 'null'
            - description: State/province
              $ref: '#/components/schemas/StateOrProvince'
      description: Medical school
    SchoolType:
      required:
        - code
        - description
      type: object
      properties:
        code:
          maxLength: 5
          minLength: 1
          type: string
          description: 'Code (e.g. `MD`, `DO`)'
        description:
          maxLength: 100
          minLength: 1
          type: string
          description: Description
      description: Type of medical school
    Specialty:
      required:
        - description
      type: object
      properties:
        description:
          maxLength: 200
          minLength: 1
          type: string
          description: Description
      description: Training specialty
    StateAddendum:
      required:
        - completedDateUtc
        - questions
      type: object
      properties:
        completedDateUtc:
          type: string
          description: 'Date and time the addendum was completed, in UTC.'
          format: date-time
        questions:
          type: array
          items:
            $ref: '#/components/schemas/StateAddendumQuestion'
          description: List of questions and answers.
      description: State addendum.
    StateAddendumQuestion:
      required:
        - name
      type: object
      properties:
        name:
          minLength: 1
          type: string
          description: Question name
        answer:
          type:
            - 'null'
            - string
          description: Answer
      description: State addendum question.
    StateOrProvince:
      required:
        - code
        - description
      type: object
      properties:
        code:
          maxLength: 3
          minLength: 1
          type: string
          description: State or province code
        description:
          maxLength: 100
          minLength: 1
          type: string
          description: Description
        countryCode:
          maxLength: 2
          type:
            - 'null'
            - string
          description: ISO Country code
        countryDescription:
          maxLength: 100
          type:
            - 'null'
            - string
          description: Country description
      description: State or province
    SubmissionSummary:
      required:
        - isFcvsAvailable
        - isUaAvailable
      type: object
      properties:
        fid:
          maxLength: 9
          minLength: 9
          pattern: '^\d{9}$'
          type: string
          description: FID of practitioner
          format: FID
        name:
          description: Practitioner name
          $ref: '#/components/schemas/Name'
        isFcvsAvailable:
          type: boolean
          description: Is FCVS Profile available?
        fcvsReleaseDateUtc:
          type:
            - 'null'
            - string
          description: FCVS Profile release date
          format: date-time
        isUaAvailable:
          type: boolean
          description: Is UA available?
        uaReleaseDateUtc:
          type:
            - 'null'
            - string
          description: UA release date
          format: date-time
        releaseDateUtc:
          type:
            - 'null'
            - string
          description: Aggregated release date
          format: date-time
      description: Summary of a submission
    UaStatus:
      type: integer
      description: Defines the status of a UA
    UaSubmission:
      required:
        - submissionId
        - submissionStatus
        - submissionDateUtc
      type: object
      properties:
        submissionId:
          maximum: 2147483647
          minimum: 1
          pattern: '^-?(?:0|[1-9]\d*)$'
          type:
            - integer
            - string
          description: Submission ID
          format: int64
        submissionStatus:
          description: Submission status
          $ref: '#/components/schemas/UaStatus'
        submissionDateUtc:
          type: string
          description: 'Submission date/time, in UTC'
          format: date-time
      description: UA Submission information
    UnusualCircumstances:
      type: object
      properties:
        hasInterruptions:
          type: boolean
          description: Has an interruption
        interruptionsDescription:
          type:
            - 'null'
            - string
          description: Interruption description
        interruptionStartMonth:
          pattern: '^-?(?:0|[1-9]\d*)$'
          type:
            - 'null'
            - integer
            - string
          description: Interruption start month
          format: int32
        interruptionStartYear:
          pattern: '^-?(?:0|[1-9]\d*)$'
          type:
            - 'null'
            - integer
            - string
          description: Interruption start year
          format: int32
        interruptionEndMonth:
          pattern: '^-?(?:0|[1-9]\d*)$'
          type:
            - 'null'
            - integer
            - string
          description: Interruption end month
          format: int32
        interruptionEndYear:
          pattern: '^-?(?:0|[1-9]\d*)$'
          type:
            - 'null'
            - integer
            - string
          description: Interruption end year
          format: int32
        hasProbation:
          type: boolean
          description: Has a probation
        probationDescription:
          type:
            - 'null'
            - string
          description: Probation description
        hasInvestigation:
          type: boolean
          description: Has an investigation
        investigationDescription:
          type:
            - 'null'
            - string
          description: Investigation description
        hasBehavior:
          type: boolean
          description: Has negative behavior
        behaviorDescription:
          type:
            - 'null'
            - string
          description: Behavior description
        hasRequirements:
          type: boolean
          description: Has special requirements
        requirementsDescription:
          type:
            - 'null'
            - string
          description: Special requirements description
      description: Represents the UCs for an institution or program.
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        clientCredentials:
          authorizationUrl: https://services-fcvsua-demo.fsmb.org/connect/token
          tokenUrl: https://services-fcvsua-demo.fsmb.org/connect/token
          scopes:
            fcvs.read: Read information.
tags:
  - name: Applicant
  - name: Token