Requisitions and Orders

Get requisition by ID

Returns full requisition details for the given requisition_id. For order status and results only, use GET /order/{order_id} instead.

get/requisition/{requisition_id}

Request

  • Base URL: https://api.myome.com/0
  • URL: https://api.myome.com/0/requisition/{requisition_id}
  • Auth: HTTP bearer

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

external_status'SUBMITTED' | 'APPROVED' | 'DENIED' | 'AWAITING_SAMPLE' | 'ANALYZING' | 'REFERRAL_LAB_LD_REVIEW' | 'CLINICIAN_REVIEW' | 'COMPLETED' | 'CANCELED' | 'FAILED'
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"
}

Changes

No recorded changes to this operation across all 1 revision of this API.