DOCSEARCHbyAlgolia
Submit Docs

Prospyrmed GraphQL API Documentation

website·Indexed 34 days ago

https://docs.prospyrmed.com

Technical reference for the Prospyrmed GraphQL API, including detailed specifications for input types, ordering options, and aggregate functions for entities such as service providers, location services, and promotion services.

Tokens
106.9K
Snippets
615
Records
1.1K
Agent score
53%

What's inside Prospyrmed

  2. AvailableProviderOutput GraphQL object definition

    The AvailableProviderOutput object is used to return details about an available provider. It contains the provider's identity, name, profile image, and a list of associated service IDs.
    type AvailableProviderOutput {
  firstName: String!
  id: uuid!
  lastName: String!
  profilePicture: String
  serviceIds: [uuid]!
}

  3. Understand the externalAiChatSession_mutation_response object

    The externalAiChatSession_mutation_response object is the standard response returned by mutations on the externalAiChatSession table, such as the insert_externalAiChatSession mutation. It provides metadata about the operation's impact and the resulting data.
    type externalAiChatSession_mutation_response {
  affected_rows: Int!
  returning: [externalAiChatSession!]!
}

  4. Understand the user_mutation_response GraphQL object

    The user_mutation_response object is returned by mutations performed on the user table, such as insert_user, update_user, and update_user_many. It provides metadata about the operation's impact and the resulting data.
    type user_mutation_response {
  affected_rows: Int!
  returning: [user!]!
}

  5. Reference the externalAiChatSession GraphQL object

    The externalAiChatSession object represents an AI chat session and contains metadata about the session's creation, updates, and its association with a workspace. It includes a messages field that supports JSON path selection to retrieve specific data from the chat history.
    type externalAiChatSession {
  createdAt: timestamptz!
  id: uuid!
  messages(path: String): jsonb
  updatedAt: timestamptz!
  workspace: workspace!
  workspaceId: uuid!
}

  6. Use AvailableProviderInput for GraphQL mutations

    The AvailableProviderInput is a GraphQL input object used to provide details about a healthcare provider. It is required as part of the BookExternalAppointmentInput input type.
    input AvailableProviderInput {
  firstName: String
  id: uuid!
  lastName: String
  profilePicture: String
  serviceIds: [uuid]
}

  7. Use the payment_mutation_response type for payment mutations

    The payment_mutation_response object is the standard response type for mutations performed on the payment table (e.g., the insert_payment mutation). It provides metadata about the operation's impact and the resulting data.
    type payment_mutation_response {
  affected_rows: Int!
  returning: [payment!]!
}

  8. Use the promotion GraphQL object

    The promotion object represents a promotional entity within the system. It contains metadata about the promotion, its active status, scheduling, and associated workspace and location details. The price field is a computed field that executes the calculate_promotion_price function.
    type promotion {
  allowPreview: Boolean
  createdAt: timestamptz!
  description: String!
  displayOrder: Int
  endsAt: timestamptz
  id: uuid!
  image: String
  isActive: Boolean!
  isArchived: Boolean!
  isShippable: Boolean!
  location: location
  locationId: uuid
  price: numeric
  promotionServices(
    distinct_on: [promotionServices_select_column!]
    limit: Int
    offset: Int
    order_by: [promotionServices_order_by!]
    where: promotionServices_bool_exp
  ): [promotionServices!]!
  shippingFee: float8
  startsAt: timestamptz
  title: String!
  updatedAt: timestamptz!
  workspace: workspace!
  workspaceId: uuid!
}

  9. Prospyr API Overview

    Prospyr is a HIPAA-compliant healthcare practice management platform providing a GraphQL API for patient management, appointment scheduling, provider operations, and insurance processing. It supports real-time updates via GraphQL subscriptions and adheres to medical coding standards like ICD-10 and CPT.

  10. Use paymentMethod_mutation_response to handle paymentMethod mutation results

    The paymentMethod_mutation_response object is returned by mutations acting on the paymentMethod table (such as the insert_paymentMethod mutation). It provides metadata about the operation's impact and the resulting data.
    type paymentMethod_mutation_response {
  affected_rows: Int!
  returning: [paymentMethod!]!
}

  11. Reference the promotionServices GraphQL object

    The promotionServices object represents the association between a promotion and the specific services it applies to. It contains details about the discount applied, the quantity of the service, and relational links to the promotion, service, and workspace.
    type promotionServices {
  createdAt: timestamptz!
  discountAmount: float8!
  discountType: String!
  id: uuid!
  promotionId: uuid!
  quantity: Int
  service: service!
  serviceId: uuid!
  updatedAt: timestamptz!
  workspaceId: uuid!
}

  12. CouponRuleOutput GraphQL Object Reference

    The CouponRuleOutput object is used to return details about a coupon rule, including its discount value, type, and the specific entity it applies to (such as a service, package, or membership). It is a member of the GetActivePatientDiscountsOutput object.
    type CouponRuleOutput {
  categoryId: String
  couponId: String!
  discountAmount: Float!
  discountType: String!
  id: String!
  membershipId: String
  name: String!
  packageId: String
  promotionId: String
  serviceId: String
  type: String!
}