{
  "id": "INTERCHANGEABILITY-ALTERNATIVES",
  "title": "List products FDA rates interchangeable",
  "shortTitle": "List alternatives",
  "method": "GET",
  "path": "/v1/interchangeability/alternatives",
  "queryPath": null,
  "group": "approvals",
  "unsupportedFields": [],
  "availability": "preview",
  "request": {
    "additionalProperties": false,
    "properties": {
      "code": {
        "maxLength": 512,
        "minLength": 1,
        "title": "Code",
        "type": "string"
      },
      "include_not_interchangeable": {
        "default": false,
        "title": "Include Not Interchangeable",
        "type": "boolean"
      },
      "limit": {
        "default": 20,
        "maximum": 100,
        "minimum": 1,
        "title": "Limit",
        "type": "integer"
      },
      "cursor": {
        "type": "string",
        "title": "Cursor"
      }
    },
    "required": [
      "code"
    ],
    "title": "AlternativesRequest",
    "type": "object"
  },
  "response": {
    "$defs": {
      "Alternative": {
        "additionalProperties": false,
        "properties": {
          "product": {
            "$ref": "#/$defs/ProductSummary"
          },
          "rating": {
            "$ref": "#/$defs/Rating"
          },
          "interchangeable": {
            "type": "boolean",
            "title": "Interchangeable"
          },
          "outcome": {
            "enum": [
              "biosimilar_not_interchangeable",
              "biosimilars_of_one_reference",
              "different_books",
              "different_formulation",
              "different_te_group",
              "equivalent",
              "interchangeable_biologic",
              "not_equivalent_rating",
              "not_evaluated",
              "not_rated",
              "not_related",
              "presentation_differs",
              "presentation_unverified",
              "reference_ambiguous",
              "same_biologic_license",
              "same_product"
            ],
            "title": "Outcome",
            "type": "string"
          },
          "reason": {
            "type": "string",
            "title": "Reason"
          },
          "is_reference": {
            "title": "Is Reference",
            "type": "boolean"
          }
        },
        "required": [
          "is_reference",
          "outcome",
          "product",
          "rating"
        ],
        "title": "Alternative",
        "type": "object"
      },
      "OrangeBookExclusivity": {
        "additionalProperties": false,
        "properties": {
          "code": {
            "title": "Code",
            "type": "string"
          },
          "expiration_date": {
            "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
            "title": "Expiration Date",
            "type": "string"
          }
        },
        "required": [
          "code",
          "expiration_date"
        ],
        "title": "OrangeBookExclusivity",
        "type": "object"
      },
      "OrangeBookFacts": {
        "additionalProperties": false,
        "properties": {
          "application": {
            "title": "Application",
            "type": "string"
          },
          "te_codes": {
            "items": {
              "type": "string"
            },
            "title": "Te Codes",
            "type": "array"
          },
          "reference_listed_drug": {
            "type": "boolean",
            "title": "Reference Listed Drug"
          },
          "reference_standard": {
            "type": "boolean",
            "title": "Reference Standard"
          },
          "approval_date": {
            "type": "string",
            "title": "Approval Date"
          },
          "exclusivity": {
            "items": {
              "$ref": "#/$defs/OrangeBookExclusivity"
            },
            "type": "array",
            "title": "Exclusivity"
          }
        },
        "required": [
          "application",
          "te_codes"
        ],
        "title": "OrangeBookFacts",
        "type": "object"
      },
      "ProductSummary": {
        "additionalProperties": false,
        "properties": {
          "product_ndc": {
            "title": "Product Ndc",
            "type": "string"
          },
          "product_name": {
            "title": "Product Name",
            "type": "string"
          },
          "labeler": {
            "type": "string",
            "title": "Labeler"
          },
          "dosage_form": {
            "type": "string",
            "title": "Dosage Form"
          },
          "listing_status": {
            "enum": [
              "active_listing",
              "ended",
              "future",
              "not_fda_listed",
              "unknown"
            ],
            "title": "Listing Status",
            "type": "string"
          },
          "set_ids": {
            "items": {
              "type": "string"
            },
            "minItems": 1,
            "title": "Set Ids",
            "type": "array"
          }
        },
        "required": [
          "listing_status",
          "product_name",
          "product_ndc",
          "set_ids"
        ],
        "title": "ProductSummary",
        "type": "object"
      },
      "PurpleBookFacts": {
        "additionalProperties": false,
        "properties": {
          "bla": {
            "title": "Bla",
            "type": "string"
          },
          "designation": {
            "enum": [
              "biosimilar",
              "interchangeable",
              "reference"
            ],
            "type": "string",
            "title": "Designation"
          },
          "licensure": {
            "type": "string",
            "title": "Licensure"
          },
          "reference_product": {
            "$ref": "#/$defs/ReferenceProduct"
          },
          "exclusivity_expiration": {
            "type": "string",
            "title": "Exclusivity Expiration"
          },
          "first_interchangeable_exclusivity": {
            "type": "string",
            "title": "First Interchangeable Exclusivity"
          },
          "reference_product_exclusivity": {
            "type": "string",
            "title": "Reference Product Exclusivity"
          }
        },
        "required": [
          "bla"
        ],
        "title": "PurpleBookFacts",
        "type": "object"
      },
      "RatedProduct": {
        "additionalProperties": false,
        "properties": {
          "product": {
            "$ref": "#/$defs/ProductSummary"
          },
          "rating": {
            "$ref": "#/$defs/Rating"
          }
        },
        "required": [
          "product",
          "rating"
        ],
        "title": "RatedProduct",
        "type": "object"
      },
      "Rating": {
        "additionalProperties": false,
        "properties": {
          "book": {
            "enum": [
              "orange_book",
              "purple_book"
            ],
            "type": "string",
            "title": "Book"
          },
          "rated": {
            "title": "Rated",
            "type": "boolean"
          },
          "reason": {
            "type": "string",
            "title": "Reason"
          },
          "orange_book": {
            "$ref": "#/$defs/OrangeBookFacts"
          },
          "purple_book": {
            "$ref": "#/$defs/PurpleBookFacts"
          }
        },
        "required": [
          "rated"
        ],
        "title": "Rating",
        "type": "object"
      },
      "ReferenceProduct": {
        "additionalProperties": false,
        "properties": {
          "name": {
            "title": "Name",
            "type": "string"
          },
          "bla": {
            "type": "string",
            "title": "Bla"
          },
          "bla_ambiguous": {
            "type": "boolean",
            "title": "Bla Ambiguous"
          }
        },
        "required": [
          "name"
        ],
        "title": "ReferenceProduct",
        "type": "object"
      }
    },
    "additionalProperties": false,
    "properties": {
      "subject": {
        "$ref": "#/$defs/RatedProduct"
      },
      "alternatives": {
        "items": {
          "$ref": "#/$defs/Alternative"
        },
        "title": "Alternatives",
        "type": "array"
      }
    },
    "required": [
      "alternatives",
      "subject"
    ],
    "title": "Alternatives",
    "type": "object"
  }
}
