Requisitions and Orders

Create or update a requisition

Submits a new requisition or updates an existing one. Returns a requisition ID for use with GET requisition/{requisition_id} and related order endpoints.

Request body

OR

Example request

{
  "order": {
    "product_data": {
      "PR-4001": {
        "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"
        }
      },
      "PR41003": {
        "weight": 95.25,
        "height": 1.65
      },
      "PR42009": {
        "weight": 95.25,
        "height": 1.65
      },
      "PR41027": {
        "glucose": {
          "fasting_glucose_level": 85.5
        },
        "triglyceride": {
          "triglyceride_level": 150.5
        },
        "body_mass_index": {
          "body_mass_index": 22.5
        },
        "waist_circumference": {
          "waist_circumference": 90
        }
      },
      "PR42023": {
        "glucose": {
          "fasting_glucose_level": 85.5
        },
        "triglyceride": {
          "triglyceride_level": 150.5
        },
        "body_mass_index": {
          "body_mass_index": 22.5
        },
        "waist_circumference": {
          "waist_circumference": 90
        }
      }
    }
  }
}

Response

Clinician, consent(s), order(s), and subject information associated with a given requisition ID. Status updates are provided for each individual order.

requisition_idstring required

individual_idstring

provider_verification_status'VERIFIED' | 'PENDING'

Verification state of the ordering provider for requisitions created with an embedded ordering_provider. VERIFIED means the provider was matched/verified and the order proceeds normally. PENDING means the provider could not be verified automatically; the requisition is accepted (HTTP 202) and held for manual review. Absent for requisitions that do not use an embedded ordering provider.

consents_grantedConsentUri[] required

ancestrystring[] nullable

clinic_namestring nullable

remote_mrnstring nullable

indicationsstring nullable

post_test_counseling'NO_COUNSELING' | 'ANY_RESULT' | 'POSITIVE_RESULT' | 'VUS_OR_POSITIVE_RESULT'

preferred_report_delivery'FAX' | 'EMAIL'

submitted_atstring date-time

UTC timestamp in ISO-8601 format. e.g., 2018-11-13T20:20:39+00:00

clinician_review_status'PENDING' | 'IN_REVIEW' | 'COMPLETED' | 'INELIGIBLE'

order_datestring

rerequisition_type'NEW_ORDER' | 'REANALYSIS' | 'METHYLATION_REFLEX'

is_eligible_for_methylation_reanalysisboolean

Whether this requisition is eligible for methylation reanalysis

Example response

{
  "clinical_summary_letter": {
    "completed_on": "1999-12-31"
  },
  "orders": [
    {
      "created_at": "1999-12-31",
      "reported_at": "1999-12-31"
    }
  ],
  "consent_grants": [
    {
      "granted_on": "1999-12-31",
      "valid_until": "1999-12-31"
    }
  ],
  "case_requisitions": [
    {
      "sample_received_at": "1999-12-31",
      "orders": [
        {
          "created_at": "1999-12-31",
          "reported_at": "1999-12-31"
        }
      ]
    }
  ],
  "order_date": "1999-12-31"
}

Create or update a requisition

Request

Request body

Example request

Response

Example response

Changes