CarrierResponseSchema

Response with carrier findings.

BioinformaticsGenomicsClinicalHealthcareData Science

Properties

Name Type Description
session_id string
total_carriers integer
ar_carrier_count integer
xl_carrier_count integer
carriers array
View JSON Schema on GitHub

JSON Schema

helena-bio-carrier-response-schema-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/helena-bio/json-schema/helena-bio-carrier-response-schema-schema.json",
  "title": "CarrierResponseSchema",
  "description": "Response with carrier findings.",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/helena-bio-carrier-status-api-openapi.yml#/components/schemas/CarrierResponseSchema",
  "properties": {
    "session_id": {
      "type": "string",
      "format": "uuid",
      "title": "Session Id"
    },
    "total_carriers": {
      "type": "integer",
      "title": "Total Carriers"
    },
    "ar_carrier_count": {
      "type": "integer",
      "title": "Ar Carrier Count"
    },
    "xl_carrier_count": {
      "type": "integer",
      "title": "Xl Carrier Count"
    },
    "carriers": {
      "items": {
        "$ref": "#/$defs/CarrierResultSchema"
      },
      "type": "array",
      "title": "Carriers"
    }
  },
  "type": "object",
  "required": [
    "session_id",
    "total_carriers",
    "ar_carrier_count",
    "xl_carrier_count",
    "carriers"
  ],
  "$defs": {
    "CarrierResultSchema": {
      "properties": {
        "variant_idx": {
          "type": "integer",
          "title": "Variant Idx"
        },
        "gene_symbol": {
          "type": "string",
          "title": "Gene Symbol"
        },
        "carrier_type": {
          "type": "string",
          "title": "Carrier Type",
          "description": "AR_CARRIER or XL_CARRIER"
        },
        "inheritance_mode": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Inheritance Mode"
        },
        "disease_name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Disease Name"
        },
        "clinical_note": {
          "type": "string",
          "title": "Clinical Note"
        },
        "confidence": {
          "type": "string",
          "title": "Confidence",
          "description": "HIGH or MODERATE"
        },
        "acmg_class": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Acmg Class"
        },
        "chromosome": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Chromosome"
        },
        "position": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "title": "Position"
        },
        "genotype": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Genotype"
        },
        "hgvs_protein": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Hgvs Protein"
        },
        "transcript_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Transcript Id"
        },
        "transcript_representations": {
          "anyOf": [
            {
              "additionalProperties": true,
              "type": "object"
            },
            {
              "type": "null"
            }
          ],
          "title": "Transcript Representations"
        },
        "hgvs_cdna": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Hgvs Cdna"
        },
        "rsid": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Rsid"
        },
        "global_af": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "title": "Global Af"
        },
        "review_stars": {
          "anyOf": [
            {
              "type": "integer"
            },
            {
              "type": "null"
            }
          ],
          "title": "Review Stars"
        }
      },
      "type": "object",
      "required": [
        "variant_idx",
        "gene_symbol",
        "carrier_type",
        "clinical_note",
        "confidence"
      ],
      "title": "CarrierResultSchema",
      "description": "Single carrier finding."
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/helena-bio-carrier-response-schema"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.