Certifyos Shared Credentialing Practitioner Status API

openapi: 3.2.0
info:
  description: API for Certify application
  title: Certify API Layer Shared Credentialing Practitioner Status…
  version: 1.0.0
servers:
- url: http://localhost:9000
  description: Local Development Server
- url: https://api-service.staging.certifyos.com
  description: Staging Server
- url: https://api-service.internal.certifyos.com
  description: Internal Server
- url: https://api-service.test.certifyos.com
  description: Test Server
- url: https://api-service.demo.certifyos.com
  description: Demo Server
- url: https://api-service.certifyos.com
  description: Production Server
tags:
- name: SharedCredentialingPractitionerStatus
  description: A practitioner's shared credentialing status.
paths:
  /api/v1/shared-credentialing/practitioners/{npi}/status:
    get:
      summary: A practitioner's shared credentialing status by NPI
      description: Each visible plan's stored eligibility verdict and current credentialing workflow, and each visible anchor group's current shared workflow. Only anchor groups in which the caller reads every plan are included; an unknown or hidden NPI answers 200 with empty lists.
      operationId: sharedCredentialingPractitionerStatusGet
      tags:
      - SharedCredentialingPractitionerStatus
      parameters:
      - description: The practitioner's 10-digit NPI
        required: true
        name: npi
        in: path
        schema:
          type: string
      - name: tenant-id
        in: header
        required: true
        description: Tenant ID
        schema:
          type: string
      responses:
        '200':
          description: The practitioner's status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PractitionerSharedStatusResponse'
        '400':
          description: The NPI is not exactly 10 digits
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Not authenticated
        '500':
          description: A read failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      security:
      - jwt: []
components:
  schemas:
    ApiError:
      type: object
      description: Standard API error response containing a list of error objects
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ErrorObject'
          description: List of error objects describing validation or processing failures
    Instant:
      type: string
      format: date-time
      examples:
      - '2022-03-10T16:15:50Z'
    PractitionerSharedStatusEligibility:
      type: object
      required:
      - status
      description: A plan's stored eligibility verdict.
      properties:
        status:
          type: string
          examples:
          - INELIGIBLE
          description: ELIGIBLE or INELIGIBLE.
        reasonCode:
          type: string
          examples:
          - STATE_NOT_ELIGIBLE
          description: Exclusion reason code; null when none is stored.
        reasonDescription:
          type: string
          description: Exclusion reason wording; null when there is no reason code.
    ErrorObject:
      type: object
      description: Individual error object containing details about a specific validation or processing error
      properties:
        httpStatus:
          type: integer
          format: int32
          examples:
          - 400
          description: HTTP status code for this error
        reason:
          type: string
          examples:
          - VALIDATION_ERROR
          description: Error reason/code
        title:
          type: string
          examples:
          - 'Validation failed for field: eventTypes'
          description: Error title/summary
        detail:
          type: string
          examples:
          - eventTypes is required and cannot be empty or null
          description: Detailed error message
        rejectedValue:
          type: string
          description: The value that was rejected, omitted for sensitive fields such as SSN
    PractitionerSharedStatusResponse:
      type: object
      required:
      - npi
      - tenants
      - sharedWorkflows
      description: 'A practitioner''s shared credentialing status across the plans the caller can see: each plan''s eligibility verdict and current credentialing workflow, and each anchor group''s current shared workflow.'
      properties:
        npi:
          type: string
          examples:
          - '1234567893'
          description: The NPI that was looked up.
        tenants:
          type: array
          items:
            $ref: '#/components/schemas/PractitionerSharedStatusTenant'
          description: One entry per plan that has an eligibility verdict for the practitioner, sorted by plan name. Empty when the NPI is unknown or nothing is visible.
        sharedWorkflows:
          type: array
          items:
            $ref: '#/components/schemas/PractitionerSharedStatusSharedWorkflow'
          description: 'Each visible anchor group''s current shared workflow: the active one, else the newest. Empty when none exists.'
    PractitionerSharedStatusSharedWorkflow:
      type: object
      required:
      - sharedCredWorkflowId
      - anchorGroupId
      - status
      - active
      - memberTenantIds
      description: An anchor group's current shared workflow.
      properties:
        sharedCredWorkflowId:
          type: string
          description: The shared workflow id.
        anchorGroupId:
          type: string
          description: The anchor group it belongs to.
        status:
          type: string
          examples:
          - OUTREACH_IN_PROGRESS
          description: The stored shared workflow status.
        active:
          type: boolean
          description: Whether the shared workflow still accepts new tenants.
        credentialingCycle:
          type: string
          description: INITIAL or RECREDENTIALING; null until derived.
        memberTenantIds:
          type: array
          items:
            type: string
          description: Tenant ids with a member workflow in it, withdrawn members included, sorted ascending.
    PractitionerSharedStatusCurrentWorkflow:
      type: object
      required:
      - workflowId
      - status
      description: A plan's current workflow.
      properties:
        workflowId:
          type: string
          description: The workflow id.
        status:
          type: string
          examples:
          - OUTREACH_IN_PROGRESS
          description: The latest status event name as stored, normally a TimelineStatus name; NOT_STARTED when there are no events.
        statusUpdatedAt:
          $ref: '#/components/schemas/Instant'
          type: string
          description: When the latest status event was written; null when there is none.
        sharedCredWorkflowId:
          type: string
          description: The shared workflow this workflow belongs to; null for the plan's own workflow.
    PractitionerSharedStatusTenant:
      type: object
      required:
      - tenantId
      - anchorGroupId
      - practitionerRegistryId
      - eligibility
      - participating
      description: One plan's eligibility and current workflow.
      properties:
        tenantId:
          type: string
          description: The plan's tenant id.
        tenantName:
          type: string
          description: The plan's display name; null when it has none.
        anchorGroupId:
          type: string
          description: The anchor group the verdict sits in.
        practitionerRegistryId:
          type: string
          description: The registry practitioner behind the NPI.
        eligibility:
          $ref: '#/components/schemas/PractitionerSharedStatusEligibility'
          type: object
          description: The stored eligibility verdict.
        participating:
          type: boolean
          description: 'Whether the plan takes part in the shared workflow: the operator override when set, else true while the plan''s current workflow is an unfinished member of a shared workflow, else whether it is eligible. True can also mean eligible to join, not yet a member.'
        currentWorkflow:
          $ref: '#/components/schemas/PractitionerSharedStatusCurrentWorkflow'
          type: object
          description: The plan's current workflow; null when it has none.
  securitySchemes:
    jwt:
      type: http
      description: JWT Authentication - Provide only the raw token without Bearer prefix
      scheme: bearer
      bearerFormat: JWT
x-provenance:
  method: harvested
  publisher: Certifyos
  source: https://api-service.internal.certifyos.com/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)