Guardant Health Orders API

Electronic ordering of Guardant assays from the EMR.

OpenAPI Specification

guardant-health-orders-api-openapi.yml Raw ↑
openapi: 3.0.1
info:
  title: Guardant Health EMR Integration API (Illustrative Model) Orders API
  description: Illustrative, unofficial model of Guardant Health's EMR-integrated ordering and results-delivery interface. Guardant Health does NOT publish a public, self-serve developer API or an official OpenAPI specification. Test ordering and results delivery are provisioned per institutional partner through EMR integrations such as Epic Aura and Flatiron OncoEMR, using interface standards (HL7 v2 / FHIR) negotiated during onboarding. The paths below are a representative model of the documented capabilities (electronic test ordering, order status, results retrieval) and are NOT confirmed public endpoints. There is no documented public base URL; contact Guardant Key Accounts for partner integration.
  termsOfService: https://guardanthealth.com/terms-of-use/
  contact:
    name: Guardant Health Key Accounts
    url: https://guardanthealth.com/precision-oncology/for-institutional-partners/
  version: '0.1'
servers:
- url: https://example.invalid/guardant-health/emr
  description: Placeholder only. No public base URL is documented; integration endpoints are provisioned per institutional partner.
security:
- partnerOAuth2: []
tags:
- name: Orders
  description: Electronic ordering of Guardant assays from the EMR.
paths:
  /orders:
    post:
      operationId: createOrder
      tags:
      - Orders
      summary: Place a Guardant assay order
      description: Illustrative representation of electronic ordering of a Guardant assay (e.g., Guardant360 CDx, Guardant360 Response, Guardant Reveal, Guardant Shield) from an integrated EMR. Not a confirmed public endpoint.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderRequest'
      responses:
        '201':
          description: Order accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Order'
  /orders/{orderId}:
    get:
      operationId: getOrder
      tags:
      - Orders
      summary: Retrieve order status
      description: Illustrative representation of retrieving the status of a previously placed order. Not a confirmed public endpoint.
      parameters:
      - name: orderId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Order
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Order'
components:
  schemas:
    Order:
      type: object
      properties:
        orderId:
          type: string
        assay:
          type: string
        status:
          type: string
          enum:
          - received
          - in_process
          - resulted
          - cancelled
        createdAt:
          type: string
          format: date-time
    OrderRequest:
      type: object
      properties:
        assay:
          type: string
          description: Guardant assay to order.
          enum:
          - Guardant360 CDx
          - Guardant360 Response
          - Guardant Reveal
          - Guardant Shield
          - GuardantINFINITY
        patientReference:
          type: string
          description: EMR reference / identifier for the patient.
        orderingProvider:
          type: string
          description: Ordering clinician identifier.
        specimenType:
          type: string
          enum:
          - blood
          - tissue
      required:
      - assay
      - patientReference
  securitySchemes:
    partnerOAuth2:
      type: oauth2
      description: Placeholder. Partner-provisioned authentication is negotiated during EMR onboarding; no public auth flow is documented.
      flows:
        clientCredentials:
          tokenUrl: https://example.invalid/guardant-health/oauth/token
          scopes: {}