MyOme Requisitions and Orders API

openapi: 3.2.0
info:
  title: MyOme Requisitions and Orders API
  version: 2.51.0
  contact:
    email: support@myome.com
  description: "The MyOme API enables clients to:\n- List sequencing and analysis products available to the client.\n- Submit requisitions for sequencing for new samples.\n- Check status of requisitions and orders.\n- Retrieve order results, including sequencing data, structured interpretation\n  data, and PDF reports.\n\n# API Overview\n\n## Terminology\n\n- A *Product* is a specific assay or intepretation service. Product\n  identifiers begin with `PR`.\n- A *Requisition* is a request for one or more Products for a single sample.\n  Requisition identifiers begin with `RQ`.\n- An *Order* is\n  a request for a specific service for a specific sample.  An Order is created for each\n  Product requested in a Requisition Order identifiers\n  begin with `OR`.   \n- A *Report* is the end result of a successful Order. An Order typically has one\n  associated Report, but may have zero in the case of failure or multiple in\n  the case of amended or corrected reports.\n\n## Typical flow\n\n- Client obtains JWT from auth.myome.com. All of the following interactions with the MyOme API include\n  this JWT for authorization (details below).\n- Client sends a requisition to MyOme with product ID(s). Each product will generate a distinct order attached to that requisition. \n  The MyOme API returns a MyOme requisition id.\n- Client fetches information about the Requisition. The response includes an order id for each Order placed.\n- Client fetches information about each Order. The response includes the status and, if\n  available, links to results.\n\n## Order Statuses\n\nOrder status:\n- SUBMITTED - Order has been received\n- DENIED - Denied by physician of record (only relevant for patient-initiated testing requests)\n- CANCELED - Order was canceled\n- AWAITING_SAMPLE - Sample has not arrived yet\n- ANALYZING - Order is being processed\n- CLINICIAN_REVIEW - Order results sent to clinician and waiting for review\n- COMPLETED - Order has been completed\n\n# API Conventions\n\n## Authorization\n\nAll endpoints require authorization using JSON Web Tokens (JWT) using the header: `Authorization: Bearer <token>`. `<token>` is a JWT generated using Keycloak with partner-specific credientials. \nNote that the token refreshes every hour. MyOme will provide credentials to partners via secure email during account creation. Those credentials should be kept confidential.\n\n## HTTP Status Codes\n\nThe MyOme API uses the following standard HTTP status codes to indicate the success or failure\nof an API request.\n\n    200 Success\n    201 Created\n    204 No Content\n    400 Bad Request\n    401 Unauthorized\n    403 Forbidden\n    404 Resource Not Found\n    415 Unsupported Media Type\n    500 Internal Server Error\n\nA successful create request returns 201 Created along with the created object identifier. A successful\nupdate request returns 200 OK along with the updated object. An unsuccessful API request returns\na relevant HTTP status code along with an error response."
servers:
- url: /0/
  description: local development server
- url: https://api.sbx.myome.com/0/
  description: External sandbox instance for partner testing/development
- url: https://api.myome.com/0/
  description: Production API
tags:
- name: Requisitions and Orders
  description: Submit, list, and fetch requisitions and orders; get order results; list re-requisitionable products.
paths:
  /institutional/partner-requisition:
    post:
      operationId: myome.api.endpoints.institutional.requisition.partner_requisition_post
      security:
      - jwt: []
      summary: Create requisition with a custom schema
      description: Requisition creation endpoint for partner-specific payload schemata.
      parameters:
      - name: id
        in: query
        required: false
        description: Partner order identifier.
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '201':
          $ref: '#/components/responses/RequisitionResponse'
        '400':
          $ref: '#/components/responses/StructuredError'
        '401':
          $ref: '#/components/responses/StructuredError'
        '404':
          $ref: '#/components/responses/StructuredError'
      tags:
      - Requisitions and Orders
      x-private: false
  /order/{order_id}:
    parameters:
    - name: order_id
      in: path
      description: MyOme order id
      required: true
      example: OR123456
      schema:
        $ref: '#/components/schemas/OrderId'
    get:
      operationId: myome.api.endpoints.order.order_get
      security:
      - jwt: []
      tags:
      - Requisitions and Orders
      summary: Get order status and results (caller's context)
      description: 'Returns order status and, when complete, result access (e.g. pre-signed URLs) for the given order_id.

        Orders are created via POST `/requisition`; this endpoint is for status and results lookup.

        '
      responses:
        '200':
          $ref: '#/components/responses/OrderGetResponse'
        '401':
          $ref: '#/components/responses/StructuredError'
  /requisition/{requisition_id}:
    parameters:
    - name: requisition_id
      in: path
      description: MyOme requisition id returned from submission
      required: true
      schema:
        type: string
        $ref: '#/components/schemas/RequisitionId'
      example: RQ123456
    get:
      operationId: myome.api.endpoints.requisition.requisition_get
      security:
      - jwt: []
      tags:
      - Requisitions and Orders
      summary: Get requisition by ID
      description: 'Returns full requisition details for the given requisition_id. For order status and results only, use GET

        `/order/{order_id}` instead.

        '
      responses:
        '201':
          $ref: '#/components/responses/RequisitionResponse'
        '401':
          $ref: '#/components/responses/StructuredError'
  /requisition:
    get:
      operationId: myome.api.endpoints.requisition.requisition_list
      security:
      - jwt: []
      summary: List requisitions (caller's context)
      description: Returns a paginated, sortable list of open requisitions for the authenticated caller. Use POST to create a new requisition.
      tags:
      - Requisitions and Orders
      responses:
        '200':
          $ref: '#/components/responses/RequisitionListResultsResponse'
        '401':
          $ref: '#/components/responses/StructuredError'
      parameters:
      - $ref: '#/components/parameters/PaginationPageNumber'
      - $ref: '#/components/parameters/PaginationPageSize'
      - name: sort_field
        in: query
        description: Field used to sort results
        schema:
          type: string
          enum:
          - clinician_id
          - clinician_name
          - external_mrn
          - patient_id
          - patient_name
          - requisition_id
          - result
          - sample_received_at
          - status
          - submitted_at
      - $ref: '#/components/parameters/SortOrder'
      - $ref: '#/components/parameters/ClinicianId'
      - $ref: '#/components/parameters/ClinicianName'
      - $ref: '#/components/parameters/ExternalMRN'
      - $ref: '#/components/parameters/ExternalOrderStatus'
      - $ref: '#/components/parameters/OrderSubmittedAt'
      - $ref: '#/components/parameters/PatientId'
      - $ref: '#/components/parameters/PatientName'
      - $ref: '#/components/parameters/RequisitionId'
      - $ref: '#/components/parameters/RequisitionToplineFindings'
      - $ref: '#/components/parameters/SampleReceivedAt'
    post:
      operationId: myome.api.endpoints.requisition.requisition_post
      security:
      - jwt: []
      summary: Create or update a requisition
      description: 'Submits a new requisition or updates an existing one. Returns a requisition ID for use with GET

        `requisition/{requisition_id}` and related order endpoints.

        '
      requestBody:
        $ref: '#/components/requestBodies/Requisition'
      responses:
        '201':
          $ref: '#/components/responses/RequisitionResponse'
        '202':
          $ref: '#/components/responses/RequisitionResponse'
        '401':
          $ref: '#/components/responses/StructuredError'
      tags:
      - Requisitions and Orders
components:
  schemas:
    ClinicianReviewStatus:
      type: string
      enum:
      - PENDING
      - IN_REVIEW
      - COMPLETED
      - INELIGIBLE
    genetic_testing:
      title: Genetic Testing Of The Woman
      $ref: '#/components/schemas/BreastCancerGeneticTesting'
    BodyMassIndex:
      title: Body Mass Index (kg/m^2)
      description: must be between 15 - 50
      type: number
      minimum: 15
      maximum: 50
      example: 22.5
    age_at_diagnosis_of_ovarian_cancer:
      title: Age At Diagnosis Of Ovarian Cancer
      type: integer
      minimum: 0
      maximum: 99
    ProductDataPR42023:
      $ref: '#/components/schemas/ProductDataPR41027'
    tyrer_cuzick_inputs:
      $schema: https://json-schema.org/draft/2020-12/schema
      title: Tyrer-Cuzick Risk Score Inputs
      type: object
      additionalProperties: false
      properties:
        age_at_menarche:
          $ref: '#/components/schemas/age_at_menarche'
        number_of_live_births:
          $ref: '#/components/schemas/number_of_live_births'
        age_at_first_birth:
          $ref: '#/components/schemas/age_at_first_birth'
        menopausal_status:
          $ref: '#/components/schemas/menopausal_status'
        age_at_menopause:
          $ref: '#/components/schemas/age_at_menopause'
        history_of_hyperplasia:
          $ref: '#/components/schemas/history_of_hyperplasia'
        history_of_atypical_hyperplasia:
          $ref: '#/components/schemas/history_of_atypical_hyperplasia'
        history_of_lcis:
          $ref: '#/components/schemas/history_of_lcis'
        history_of_ovarian_cancer:
          $ref: '#/components/schemas/history_of_ovarian_cancer'
        age_at_diagnosis_of_ovarian_cancer:
          $ref: '#/components/schemas/age_at_diagnosis_of_ovarian_cancer'
        hormone_replacement_therapy_use:
          $ref: '#/components/schemas/hormone_replacement_therapy_use'
        type_of_hormone_replacement_therapy_taken:
          $ref: '#/components/schemas/type_of_hormone_replacement_therapy_taken'
        length_of_time_taking_hormone_replacement_therapy:
          $ref: '#/components/schemas/length_of_time_taking_hormone_replacement_therapy'
        length_of_future_time_intended_to_take_hormone_replacement_therapy:
          $ref: '#/components/schemas/length_of_future_time_intended_to_take_hormone_replacement_therapy'
        length_of_time_since_last_taking_hormone_replacement_therapy:
          $ref: '#/components/schemas/length_of_time_since_last_taking_hormone_replacement_therapy'
        genetic_testing:
          $ref: '#/components/schemas/genetic_testing'
        genetic_testing_of_father:
          $ref: '#/components/schemas/genetic_testing_of_father'
        father_had_breast_cancer:
          $ref: '#/components/schemas/father_had_breast_cancer'
        brother_had_breast_cancer:
          $ref: '#/components/schemas/brother_had_breast_cancer'
        breast_density_measure:
          $ref: '#/components/schemas/breast_density_measure'
        breast_density_value_decimal:
          $ref: '#/components/schemas/breast_density_value_decimal'
        breast_density_value_birads:
          $ref: '#/components/schemas/breast_density_value_birads'
        polygenic_snp_score:
          $ref: '#/components/schemas/polygenic_snp_score'
        mother:
          title: Mother
          $ref: '#/components/schemas/TyrerCuzickFamilyHistory'
        paternal_grandmother:
          title: Paternal Grandmother
          $ref: '#/components/schemas/TyrerCuzickFamilyHistory'
        maternal_grandmother:
          title: Maternal Grandmother
          $ref: '#/components/schemas/TyrerCuzickFamilyHistory'
        sisters:
          title: Sisters
          type: array
          items:
            type: object
            properties:
              personal_history:
                title: Personal History
                $ref: '#/components/schemas/TyrerCuzickFamilyHistory'
              daughters:
                title: Daughters (Nieces)
                type: array
                items:
                  $ref: '#/components/schemas/TyrerCuzickFamilyHistory'
        paternal_aunts:
          title: Paternal Aunts
          type: array
          items:
            type: object
            properties:
              personal_history:
                title: Personal History
                $ref: '#/components/schemas/TyrerCuzickFamilyHistory'
              daughters:
                title: Daughters (Cousins)
                type: array
                items:
                  $ref: '#/components/schemas/TyrerCuzickFamilyHistory'
        maternal_aunts:
          title: Maternal Aunts
          type: array
          items:
            type: object
            properties:
              personal_history:
                title: Personal History
                $ref: '#/components/schemas/TyrerCuzickFamilyHistory'
              daughters:
                title: Daughters (Cousins)
                type: array
                items:
                  $ref: '#/components/schemas/TyrerCuzickFamilyHistory'
        daughters:
          title: Daughters
          type: array
          items:
            $ref: '#/components/schemas/TyrerCuzickFamilyHistory'
        brothers_daughters:
          title: Brothers' Daughters With Breast Cancer
          type: array
          items:
            $ref: '#/components/schemas/TyrerCuzickFamilyHistory'
        paternal_half_sisters:
          title: Paternal Half Sisters
          type: array
          items:
            $ref: '#/components/schemas/TyrerCuzickFamilyHistory'
        maternal_half_sisters:
          title: Maternal Half Sisters
          type: array
          items:
            $ref: '#/components/schemas/TyrerCuzickFamilyHistory'
        paternal_uncles_daughters:
          title: Paternal Uncles' Daughters (Cousins)
          type: array
          items:
            $ref: '#/components/schemas/TyrerCuzickFamilyHistory'
        maternal_uncles_daughters:
          title: Maternal Uncles' Daughters (Cousins)
          type: array
          items:
            $ref: '#/components/schemas/TyrerCuzickFamilyHistory'
    ProductDataRareDisease:
      type: object
      additionalProperties: false
      title: Inputs for Rare Disease
      required:
      - ndd_icd10_codes
      - secondary_findings_opt_out
      properties:
        secondary_findings_opt_out:
          title: Secondary Findings Opt Out
          description: true for opt-out, false for opt-in
          type: boolean
        ndd_icd10_codes:
          type: array
          items:
            type: string
          title: ICD10 Codes
          description: 'For Example: Q75.3 Macrocephaly'
        clinical_phenotypes__other:
          type:
          - array
          - 'null'
          items:
            type: string
          title: Clinical Phenotypes
    Date:
      type: string
      format: date
    YMDDate:
      type: string
      pattern: '[12]\d{3}-[01]\d-[0123]\d'
      example: '1999-12-31'
    Subject:
      $schema: https://json-schema.org/draft/2020-12/schema
      title: Subject
      type: object
      properties:
        name:
          $ref: '#/components/schemas/Name'
        contact_info:
          type: array
          items:
            $ref: '#/components/schemas/ContactInfo'
        demographics:
          $ref: '#/components/schemas/Demographics'
    ProductDataPR4001Empower:
      type: object
      description: Additional data needed for product ID PR4001 with TC outputs and a data sample
      required:
      - tc_data
      - data_files
      - data_sample_info
      properties:
        tc_data:
          type: object
          description: Extra data required for computation. The content requirements depend on the selected product ID.
          additionalProperties: false
          required:
          - five_year_risk
          - lifetime_risk
          - n_first_degree_affected
          properties:
            five_year_risk:
              description: Five year risk score in decimal format.
              type: number
              minimum: 0
              maximum: 1
            lifetime_risk:
              description: Lifetime year risk score in decimal format.
              type: number
              minimum: 0
              maximum: 1
            n_first_degree_affected:
              description: Number of first degree
              type: integer
        data_files:
          type: array
          items:
            type: object
            $ref: '#/components/schemas/File'
        data_sample_info:
          type: object
          additionalProperties: false
          required:
          - collection_date
          - received_date
          - sample_type
          properties:
            sample_type:
              type: string
              enum:
              - DATA
            collection_date:
              type: string
              pattern: '[12]\d{3}-[01]\d-[0123]\d'
            received_date:
              type: string
              pattern: '[12]\d{3}-[01]\d-[0123]\d'
      example:
        tc_data:
          five_year_risk: 0.012
          lifetime_risk: 0.022
          n_first_degree_affected: 2
        data_files:
        - uri: s3://bucket/R1.fastq
          sha512: 3b7fc7cc370707c1df045c35342f3d64ea7076
          description: R1 Fastq sequence
          mimetype: application/x.seq-na-fastq;type=paired_end;direction=R1
        - uri: s3://bucket/R2.fastq
          sha512: 3b7fc7cc370707c1df045c35342f3d64ea7076
          description: R2 Fastq sequence
          mimetype: application/x.seq-na-fastq;type=paired_end;direction=R2
        data_sample_info:
          sample_type: DATA
          collection_date: '2022-12-21'
          received_date: '2022-12-23'
    DnavisitServiceRequest:
      $schema: https://json-schema.org/draft/2020-12/schema
      title: DnavisitServiceRequest
      type: object
      properties:
        requisition_id:
          $ref: '#/components/schemas/RequisitionId'
        appointment_url:
          type: string
          format: uri
          description: Link to a scheduled genetic counseling appointment
        appointment_date:
          $ref: '#/components/schemas/UTCTimestamp'
        access_code:
          type: string
          description: Access code required to schedule new genetic counseling appointments
        external_status:
          type: string
        service_type:
          $ref: '#/components/schemas/DNAVisitServiceType'
        requested_on:
          $ref: '#/components/schemas/Date'
        completed_on:
          $ref: '#/components/schemas/Date'
        dnavisit_order_id:
          type: string
      additionalProperties: false
    IndividualId:
      type: string
      pattern: ^IN-?([a-z]{3,5}-?)?\d+$
      examples:
      - IN-dev-123456
      - IN-123456
      - INdev123456
      - IN123456
    ContactInfoOptional:
      type: object
      additionalProperties: false
      properties:
        address:
          title: Address
          oneOf:
          - $ref: '#/components/schemas/AddressOptional'
          - type: 'null'
        email:
          anyOf:
          - $ref: '#/components/schemas/EmailAddress'
          - const: ''
          - type: 'null'
        phone:
          type:
          - string
          - 'null'
          title: Phone Number
        fax:
          type:
          - string
          - 'null'
          title: Fax Number
    ProductDataPR42014:
      $ref: '#/components/schemas/ProductDataPR41016'
    BillingSelf:
      title: Patient Pay
      additionalProperties: false
      type: object
      properties:
        billing_type:
          type: string
          title: Billing Type
          default: SELF
          enum:
          - SELF
        stripe_paymentintent_id:
          type: string
        promo_code:
          type: string
      required:
      - billing_type
    had_breast_cancer:
      title: Did They Have Breast Cancer?
      $ref: '#/components/schemas/YesNoUnknown'
    PRSToplineFinding:
      type: string
      enum:
      - AVERAGE_RISK
      - ELEVATED_RISK
      - HIGH_RISK
      - LOW_RISK
      - INTERMEDIATE_RISK
      - BORDERLINE_RISK
      - NOT_ANALYZED
      - INCREASED_RISK
      - NOT_INCREASED_RISK
    ClinicalSummaryLetter:
      type: object
      description: '"Clinical summary letter provided by physician of record. Only relevant if physician of record services were requested."

        '
      properties:
        completed_on:
          allOf:
          - $ref: '#/components/schemas/YMDDate'
        description:
          type:
          - string
          - 'null'
        mimetype:
          type:
          - string
          - 'null'
        uri:
          type:
          - string
          - 'null'
    menopausal_status:
      $ref: '#/components/schemas/MenopausalStatus'
    WaistCircumference:
      title: Waist Circumference (cm)
      description: must be between 50 - 200
      type: number
      minimum: 50
      maximum: 200
      example: 90
    breast_density_measure:
      title: Breast Density Measure
      type: string
      anyOf:
      - title: Volpara® Volumetric Density (%)
        type: string
        enum:
        - VOLPARA
      - title: VAS Percentage Density
        type: string
        enum:
        - VAS
      - title: BI-RADS® ATLAS Density
        type: string
        enum:
        - BIRADS
      - title: Not Available
        type: string
        enum:
        - NOT_AVAILABLE
    Name:
      type: object
      title: Name
      additionalProperties: false
      properties:
        first:
          type: string
          title: First
        middle:
          type:
          - string
          - 'null'
          title: Middle
        last:
          type: string
          title: Last
        credentials:
          type:
          - string
          - 'null'
          title: Credentials
          description: e.g. M.D., Ph.D.
      examples:
      - first: Zaphod
        middle: Vogon
        last: Beeblebrox
        credentials: M.D., Ph.D.
    FirstDegreeFamilyWithType2Diabetes:
      title: Has a First Degree Family Member Been Diagnosed with Type 2 Diabetes?
      type: boolean
    FastingGlucoseLevel:
      title: Fasting Glucose Level (mg/dL)
      description: must be between 50 - 250gs; levels >250 (diabetic) not eligible
      type: number
      minimum: 50
      maximum: 250
      example: 85.5
    ClinicId:
      type: string
      pattern: ^CL-?([a-z]{3,5}-?)?\d+$
      examples:
      - CL-0123456
      - CL-dev-123456
      - CL0123456
      - CLdev123456
    ProductDataPR41016:
      type: object
      title: Inputs for IPRS CAD
      additionalProperties: false
      required:
      - smoking
      - diabetes
      - cholesterol
      - blood_pressure
      properties:
        diagnosed_with_coronary_artery_disease:
          $ref: '#/components/schemas/diagnosed_with_coronary_artery_disease'
        smoking:
          $ref: '#/components/schemas/smoking'
        diabetes:
          $ref: '#/components/schemas/diabetes'
        cholesterol:
          $ref: '#/components/schemas/cholesterol'
        blood_pressure:
          $ref: '#/components/schemas/blood_pressure'
    TotalCholesterol:
      title: Total Cholesterol Level (mg/dL)
      description: must be between 130 - 320
      type: number
      minimum: 130
      maximum: 320
    UUID:
      description: Python UUID
      type: string
      pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}
      examples:
      - 90cd1561-bcc4-46bc-9ba2-19bb2521a28e
      - c2a78d62-969f-455e-8b8f-bd5f0efd9273
    SystolicBloodPressure:
      title: Systolic Blood Pressure (mm HG)
      description: must be between 90 - 200
      type: number
      minimum: 90
      maximum: 200
    age_at_ovarian_cancer:
      title: Age At Which They Developed Ovarian Cancer?
      description: If unknown, then their current age or the age at which they died.
      type: integer
      minimum: 0
    CaseRequisition:
      type: object
      properties:
        requisition_id:
          allOf:
          - $ref: '#/components/schemas/RequisitionId'
        name:
          allOf:
          - $ref: '#/components/schemas/Name'
        individual_id:
          allOf:
          - $ref: '#/components/schemas/IndividualId'
        sample_received_at:
          allOf:
          - $ref: '#/components/schemas/YMDDate'
        relationship:
          allOf:
          - $ref: '#/components/schemas/BiologicalRelationshipWithReverse'
        is_primary_requisition:
          type:
          - boolean
          - 'null'
        orders:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/RequisitionOrderDetails'
    ProductId:
      type: string
      description: A reference to an ordered product.
      pattern: ^PR-?\d+$
      examples:
      - PR-0123456
      - PR0123456
    BiologicalSex:
      description: Sex assigned at birth
      type: string
      enum:
      - FEMALE
      - MALE
      - OTHER
    ProductDataPR41034:
      type: object
      title: Inputs for IPRS PRC
      additionalProperties: false
      required:
      - diagnosed_with_prostate_cancer
      - prostate_cancer_family_history
      properties:
        diagnosed_with_prostate_cancer:
          $ref: '#/components/schemas/diagnosed_with_prostate_cancer'
        prostate_cancer_family_history:
          $ref: '#/components/schemas/prostate_cancer_family_history'
    weight:
      $schema: https://json-schema.org/draft/2020-12/schema
      title: Weight (kg)
      description: Enter to two decimal points (e.g. 95.25)
      type: number
      minimum: 0
      maximum: 500
      example: 95.25
    waist_circumference:
      $schema: https://json-schema.org/draft/2020-12/schema
      title: Waist Circumference
      type: object
      required:
      - waist_circumference
      properties:
        waist_circumference:
          $ref: '#/components/schemas/WaistCircumference'
      additionalProperties: false
      definitions:
        WaistCircumference:
          title: Waist Circumference (cm)
          description: must be between 50 - 200
          type: number
          minimum: 50
          maximum: 200
          example: 90
    breast_density_value_birads:
      title: Breast Density Value
      description: Value for BI-RADS
      type: string
      enum:
      - ALMOST_ENTIRELY_FATTY
      - SCATTERED_FIBROGLANDULAR DENSITY
      - HETEROGENEOUSLY_DENSE
      - EXTREMELY_DENSE
    ClinicianId:
      title: Clinician ID
      type: string
      pattern: ^CN-?([a-z]{3,5}-?)?\d+$
      examples:
      - CN-0123456
      - CN-dev-0123456
      - CN0123456
      - CNdev0123456
    type_of_hormone_replacement_therapy_taken:
      title: Type Of Hormone Replacement Therapy (HRT) Taken
      type: string
      enum:
      - OESTROGEN
      - COMBINED
      - UNKNOWN
    age_at_first_birth:
      title: Age At First Birth
      description: Leave blank if unknown.
      type: integer
      minimum: 0
      maximum: 99
    age_at_breast_cancer:
      title: Age At Which They Developed Breast Cancer?
      description: If unknown, then their current age or the age at which they died.
      type: integer
      minimum: 0
    body_mass_index:
      $schema: https://json-schema.org/draft/2020-12/schema
      title: Body Mass Index
      type: object
      required:
      - body_mass_index
      properties:
        body_mass_index:
          $ref: '#/components/schemas/BodyMassIndex'
      additionalProperties: false
      definitions:
        BodyMassIndex:
          title: Body Mass Index (kg/m^2)
          description: must be between 15 - 50
          type: number
          minimum: 15
          maximum: 50
          example: 22.5
    BillingInsurance:
      title: Insurance Billing (Commercial, Medicaid, Medicare)
      additionalProperties: false
      type: object
      properties:
        billing_type:
          type: string
          title: Billing Type
          default: INSURANCE
          enum:
          - INSURANCE
        insurance:
          type: array
          minItems: 1
          maxItems: 2
          items:
            $ref: '#/components/schemas/Insurance'
      required:
      - billing_type
      - insurance
    age_at_breast_cancer_bilateral:
      title: Age At Which They Developed Bilateral Breast Cancer?
      description: If unknown, then their current age or the age at which they died.
      type: integer
      minimum: 0
    PGxImpactToplineFinding:
      type: string
      enum:
      - MINIMAL_IMPACT
      - ALTERED_DOSE
      - MAJOR_IMPACT
      - CONTRAINDICATED
    ProductDataPR42038:
      $ref: '#/components/schemas/ProductDataPR41034'
    ProviderLicenseStatus:
      type: string
      enum:
      - UNVERIFIED
      - VERIFIED
      - REVOKED
      - DENIED
    BillingInstitutional:
      title: Institutional Billing
      additionalProperties: false
      type: object
      properties:
        billing_type:
          type: string
          title: Billing Type
          default: INSTITUTIONAL
          enum:
          - INSTITUTIONAL
        billing_code:
          type: string
          maxLength: 64
          title: Billing Code
          description: Institutional code for billing
      required:
      - billing_type
    MonogenicToplineFinding:
      type: string
      enum:
      - POSITIVE
      - NEGATIVE
    breast_cancer_bilateral:
      title: Was Breast Cancer Bilateral?
      $ref: '#/components/schemas/YesNoUnknown'
    name:
      title: Name
      type: string
    had_ovarian_cancer:
      title: Did They Have Ovarian Cancer?
      $ref: '#/components/schemas/YesNoUnknown'
    Campaign:
      $schema: https://json-schema.org/draft/2020-12/schema
      title: Campaign
      type: object
      required:
      - campaign_code
      - name
      - is_active
      properties:
        name:
          type: string
          examples:
          - Example Partnership
        campaign_code:
          type: string
          examples:
          - EXAMPLE
        description:
          type: string
          examples:
          - by Example Partner
        is_active:
          type: boolean
      additionalProperties: false
    Billing:
      title: Billing Information
      description: Options are currently self-pay, insurance, and institutional billing.
      type: array
      maxItems: 1
      items:
        oneOf:
        - $ref: '#/components/schemas/BillingSelf'
        - $ref: '#/components/schemas/BillingInsurance'
        - $ref: '#/components/schemas/BillingInstitutional'
    RequisitionId:
      type: string
      pattern: ^RQ-?([a-z]{3,5}-?)?\d+$
      examples:
      - RQ-0123456
      - RQ-dev-0123456
      - RQ0123456
      - RQdev0123456
    EmailAddress:
      type: string
      title: Email Address
      format: email
    age_at_menarche:
      title: Age At Menarche
      description: Age at first menstrual period. Leave blank if unknown.
      type: integer
      minimum: 0
      maximum: 99
    SubjectOptionalAddress:
      $schema: https://json-schema.org/draft/2020-12/schema
      title: SubjectOptionalAddress
      type: object
      properties:
        name:
          oneOf:
          - $ref: '#/components/schemas/Name'
          - type: 'null'
        contact_info:
          type: array
          items:
            $ref: '#/components/schemas/ContactInfoOptional'
        demographics:
          oneOf:
          - $ref: '#/components/schemas/Demographics'
          - type: 'null'
    TyrerCuzickFamilyHistory:
      type: object
      properties:
        name:
          $ref: '#/components/schemas/name'
        had_breast_cancer:
          $ref: '#/components/schemas/had_breast_cancer'
        breast_cancer_bilateral:
          $ref: '#/components/schemas/breast_cancer_bilateral'
        age_at_breast_cancer:
          $ref: '#/components/schemas/age_at_breast_cancer'
        age_at_breast_cancer_bilateral:
          $ref: '#/components/schemas/age_at_breast_cancer_bilateral'
        had_ovarian_cancer:
          $ref: '#/components/schemas

# --- truncated at 32 KB (91 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/myome/refs/heads/main/openapi/myome-requisitions-and-orders-api-openapi.yml