{"openapi":"3.0.2","info":{"title":"MyOme API","version":"2.63.2","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."},{"name":"Resources","description":"Reference data\u2014orderable products and consent types (general and product-specific)."},{"name":"Profile","description":"Current authenticated user identity (individual_id or clinician_id and profile type)."},{"name":"Providers","description":"Look up providers by ID or list affiliated providers; no provider auth required."},{"name":"Draft Requisitions","description":"Create, read, update, and delete draft requisitions before final submission."},{"name":"Patients","description":"Provider view of patient records\u2014details, consents, and genetic counseling requests for an individual."},{"name":"Reports","description":"Download reports (e.g. collated PDF) for a requisition."},{"name":"Billing & Payments","description":"Create or retrieve payment intents, fetch payment details for a requisition, submit financial assistance requests."},{"name":"Patient Requests","description":"Patient-initiated actions\u2014request testing, request genetic counseling, submit Cures Act release."},{"name":"Share History","description":"View and create records of the patient sharing results with others."},{"name":"Campaigns","description":"Campaign eligibility checks and institutional campaign management (individuals, clinics, requisitions, providers)."},{"name":"Provider Administration","description":"Manage clinics (details, fax verification), organizations, providers, and clinician delegates; submit provider onboarding."},{"name":"Institutional Interface","description":"Institution onboarding and institution-scoped operations (requisitions, orders, campaigns)."},{"name":"Providers Portal","description":"Endpoints that require an authenticated provider (optional secondary tag)."},{"name":"Patients Portal","description":"Endpoints that require an authenticated patient (optional secondary tag)."}],"components":{"parameters":{"PaginationPageNumber":{"in":"query","name":"page","description":"Page number","schema":{"type":"integer","minimum":1}},"PaginationPageSize":{"in":"query","name":"per_page","description":"Number of items per page","schema":{"type":"integer","minimum":1}},"SortField":{"in":"query","name":"sort_field","description":"Field used to sort results","schema":{"type":"string"}},"SortOrder":{"in":"query","name":"sort_order","description":"Order in which results are sorted","schema":{"$ref":"#/components/schemas/SortOrder"}},"ClinicianId":{"in":"query","name":"clinician_id","description":"ID of the clinician","schema":{"$ref":"#/components/schemas/ClinicianId"}},"ClinicianName":{"in":"query","name":"clinician_name","description":"Name of the clinician","schema":{"type":"string"}},"ExternalMRN":{"in":"query","name":"external_mrn","description":"Clinic's medical record number for the patient","schema":{"type":"string"}},"ExternalOrderStatus":{"in":"query","name":"status","description":"Status of the Order","schema":{"$ref":"#/components/schemas/ExternalOrderStatus"}},"OrderDate":{"in":"query","name":"order_date","description":"Date the order was placed, which may predate submission for partner-supplied orders","schema":{"$ref":"#/components/schemas/YMDDate"}},"OrderSubmittedAt":{"in":"query","name":"submitted_at","description":"Date which the order was submitted","schema":{"$ref":"#/components/schemas/YMDDate"}},"PatientId":{"in":"query","name":"patient_id","description":"ID of the patient","schema":{"$ref":"#/components/schemas/IndividualId"}},"PatientName":{"in":"query","name":"patient_name","description":"Name of the patient","schema":{"type":"string"}},"RequisitionId":{"in":"query","name":"requisition_id","description":"MyOme requisition id","schema":{"$ref":"#/components/schemas/RequisitionId"}},"RequisitionToplineFinding":{"in":"query","name":"result","description":"Test result finding","schema":{"$ref":"#/components/schemas/RequisitionToplineFinding"}},"RequisitionToplineFindings":{"in":"query","name":"result","description":"Test result findings","schema":{"type":"array","items":{"$ref":"#/components/schemas/RequisitionToplineFinding"}}},"SampleReceivedAt":{"in":"query","name":"sample_received_at","description":"Date which the sample was received","schema":{"$ref":"#/components/schemas/YMDDate"}},"GuardianViewIndividualId":{"in":"query","name":"individual","description":"Individual identifier of a minor family member whose records to return instead of the caller's own (guardian access).","schema":{"$ref":"#/components/schemas/IndividualId"},"example":"IN123456"}},"requestBodies":{"ChangeOrderingProvider":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["partner_clinic_id","new_ordering_provider"],"additionalProperties":false,"properties":{"partner_clinic_id":{"type":"string","description":"The partner clinic ID of the requisition's ordering clinic"},"new_ordering_provider":{"type":"object","properties":{"npi":{"$ref":"#/components/schemas/NPI"},"name":{"type":"object","properties":{"first":{"type":"string"},"last":{"type":"string"},"credentials":{"type":"string"}},"required":["first","last"]}},"required":["npi","name"]}}},"example":[{"partner_clinic_id":"CLINIC-001","new_ordering_provider":{"npi":"9876543210","name":{"first":"Doctor","last":"NewProvider","credentials":"M.D."}}}]}}},"ChangeProduct":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["new_product_code"],"additionalProperties":false,"properties":{"new_product_code":{"description":"The new primary product ID to swap to (must be cross-family with same order size)","$ref":"#/components/schemas/ProductId"}}},"example":[{"new_product_code":"PR51105"}]}}},"CliniciansFormsRequisitionPostBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"product_ids":{"type":"array","items":{"$ref":"#/components/schemas/ProductId"}}},"required":["product_ids"]}}}},"CuresRelease":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["requisition_id"],"properties":{"requisition_id":{"$ref":"#/components/schemas/RequisitionId"}}},"example":[{"requisition_id":"RQ12345"}]}}},"DraftRequisition":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["name","formdata","ordering_provider"],"properties":{"name":{"type":"string"},"formdata":{"type":"object"},"ordering_provider":{"$ref":"#/components/schemas/ClinicianId"},"ordering_clinic":{"$ref":"#/components/schemas/ClinicId"},"rerequisition_from":{"$ref":"#/components/schemas/RequisitionId"},"rerequisition_type":{"$ref":"#/components/schemas/RerequisitionType"}}},"example":[{"name":"Patient Name Draft","formdata":{"field1":"value1","field2":"value2"},"ordering_provider":"CN123456","ordering_clinic":"CL123456","rerequisition_from":"RQ2001234","rerequisition_type":"REANALYSIS"}]}}},"FaxVerifyConfirm":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["code"],"properties":{"code":{"type":"string","description":"The 6-letter verification code received via fax","minLength":6,"maxLength":6}}},"example":[{"code":"ABC123"}]}}},"GeneticCounseling":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["requisition_id","product_ids"],"properties":{"requisition_id":{"$ref":"#/components/schemas/RequisitionId"},"product_ids":{"description":"Product codes (referring to a specific set of test results) in which the patient \nseeks counseling on.\n","type":"array","items":{"$ref":"#/components/schemas/ProductId"}}}},"example":[{"requisition_id":"RQ12345","product_ids":["PR-2019","PR-3009"]}]}}},"InstitutionalCampaignClinicUpdate":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"efax_enabled":{"type":"boolean"},"phone":{"type":"string"},"fax":{"type":"string"},"fax_number_verification_status":{"$ref":"#/components/schemas/FaxVerificationStatus","nullable":true}}}}}},"InstitutionalCampaignIndividualPost":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"first":{"type":"string"},"last":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"street_address_1":{"type":"string"},"street_address_2":{"type":"string"},"city":{"type":"string"},"region":{"type":"string"},"postal_code":{"type":"string"},"dob":{"type":"string"},"sex":{"type":"string","enum":["MALE","FEMALE"]},"external_member_id":{"type":"string"},"external_group_id":{"type":"string"},"removed":{"type":"boolean","nullable":true}},"required":["first","last","email","dob"]},"example":[{"first":"John","last":"Doe","email":"john.doe@example.com","phone":"123-456-7890","street_address_1":"123 Main St","street_address_2":"Apt 1","city":"Anytown","region":"CA","postal_code":"12345","dob":"1990-01-01","sex":"MALE","external_member_id":"1234567890","external_group_id":"1234567890"}]}}},"InstitutionalOnboarding":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["provider","has_teammates"],"oneOf":[{"required":["clinic_id","signup_code"]},{"required":["organization"]}],"properties":{"signup_code":{"type":"string"},"provider":{"$ref":"#/components/schemas/OnboardingProvider"},"has_teammates":{"type":"boolean"},"teammates":{"type":"array","items":{"$ref":"#/components/schemas/OnboardingProvider"}},"clinic_id":{"$ref":"#/components/schemas/ClinicId"},"organization":{"type":"object","additionalProperties":false,"required":["name","phone","address"],"properties":{"name":{"type":"string"},"phone":{"type":"string"},"fax":{"type":"string"},"address":{"$ref":"#/components/schemas/Address"},"efax_enabled":{"type":"boolean","default":false},"fax_number_verification_status":{"$ref":"#/components/schemas/FaxVerificationStatus","nullable":true}}}}},"example":[{"signup_code":"CATALYST","provider":{"name":{"first":"Admin","last":"Admin"},"role":"LAB_MANAGER","email":"lab_manager@org.com"},"has_teammates":true,"teammates":[{"name":{"first":"Doctor","last":"DoLittle","credentials":"M.D."},"role":"ORDERING_PROVIDER","npi":"0123456789","email":"doc@org.com"}],"clinic_id":"CL12345"}]}}},"NateraRequisition":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["order","subject","billing","natera_case_id","natera_ordering_clinic","natera_ordering_provider"],"additionalProperties":false,"properties":{"billing":{"$ref":"#/components/schemas/Billing"},"campaign":{"type":"string"},"consents_granted":{"description":"Consents asserted by the client.\n\nConsent IDs available to the client may be obtained from the `/consents/`\nendpoint.\n","type":"array","items":{"$ref":"#/components/schemas/ConsentUri"}},"hie_opt_in":{"description":"true for opt-in, false for opt-out","type":"boolean","nullable":true},"research_contact_opt_in":{"description":"true for opt-in, false for opt-out","type":"boolean","nullable":true},"transactional_sms_opt_in":{"description":"true for opt-in, false for opt-out","type":"boolean","nullable":true},"marketing_opt_in":{"description":"true for opt-in, false for opt-out","type":"boolean","nullable":true},"bypass_duplicate_validation":{"description":"Whether to allow a requisition when one already exists for the same patient.","type":"boolean","default":false},"order":{"description":"Order information","type":"object","properties":{"send_kit":{"description":"Whether MyOme should send a kit to the subject.","type":"boolean"},"declared_specimen_type":{"$ref":"#/components/schemas/SampleType"},"product_ids":{"description":"Product codes specifying the desired tests or analyses.\n\nProduct codes available to the client may be obtained from the `/products/`\nendpoint.\n","type":"array","items":{"$ref":"#/components/schemas/ProductId"}},"pre_test_counseling":{"description":"Whether the subject will undergo pre-test genetic counseling","type":"boolean","default":false},"post_test_counseling":{"description":"Whether the subject will undergo post-test genetic counseling","type":"boolean","default":false},"product_data":{"description":"Additional data required for ordered products","type":"object","additionalProperties":false,"properties":{"PR-4001":{"$ref":"#/components/schemas/ProductDataPR4001Empower"},"PR41003":{"$ref":"#/components/schemas/ProductDataPR41003"},"PR41016":{"$ref":"#/components/schemas/ProductDataPR41016"},"PR42014":{"$ref":"#/components/schemas/ProductDataPR42014"},"PR51063":{"$ref":"#/components/schemas/ProductDataRareDisease"},"PR51058":{"$ref":"#/components/schemas/ProductDataRareDisease"},"PR51049":{"$ref":"#/components/schemas/ProductDataRareDisease"},"PR51030":{"$ref":"#/components/schemas/ProductDataRareDisease"},"PR51025":{"$ref":"#/components/schemas/ProductDataRareDisease"},"PR51017":{"$ref":"#/components/schemas/ProductDataRareDisease"},"PR51074":{"$ref":"#/components/schemas/ProductDataRareDisease"},"PR51082":{"$ref":"#/components/schemas/ProductDataRareDisease"},"PR51096":{"$ref":"#/components/schemas/ProductDataRareDisease"},"PR51105":{"$ref":"#/components/schemas/ProductDataRareDisease"},"PR51118":{"$ref":"#/components/schemas/ProductDataRareDisease"},"PR51126":{"$ref":"#/components/schemas/ProductDataRareDisease"},"PR51311":{"$ref":"#/components/schemas/ProductDataCNA"},"PR51322":{"$ref":"#/components/schemas/ProductDataCNA"},"PR11014":{"$ref":"#/components/schemas/ProductDataPR11014"}}}},"required":["send_kit","product_ids"]},"lab_referral":{"$ref":"#/components/schemas/LabReferral"},"subject":{"$ref":"#/components/schemas/SubjectOptionalAddress"},"physician_of_record_services":{"$ref":"#/components/schemas/PhysicianOfRecord"},"family_history":{"$ref":"#/components/schemas/FamilyHistory"},"guardian_info":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/Name"},"relationship_with_patient":{"type":"string"}},"required":["name","relationship_with_patient"]},"requisition_id":{"$ref":"#/components/schemas/RequisitionId"},"natera_case_id":{"type":"string"},"natera_ordering_clinic":{"type":"object","properties":{"name":{"type":"string"},"phone":{"type":"string"},"fax":{"type":"string"},"clinic_id":{"$ref":"#/components/schemas/ClinicId"},"address":{"$ref":"#/components/schemas/Address"},"partner_clinic_id":{"type":"string"}},"required":["name","phone","address"]},"natera_ordering_provider":{"type":"object","properties":{"npi":{"$ref":"#/components/schemas/NPI"},"name":{"type":"object","properties":{"first":{"type":"string"},"last":{"type":"string"},"middle":{"type":"string"},"credentials":{"type":"string"}},"required":["first","last"]}},"required":["npi","name"]},"samples":{"description":"External sample information. Required for initial orders but\ngenerally not for rerequisitions. Methylation reflex orders\nrequire a blood sample.\n","type":"array","items":{"$ref":"#/components/schemas/ExternalSample"}},"case_requisitions":{"description":"Must be omitted for methylation reflex orders.","type":"array","items":{"type":"object","properties":{"natera_case_id":{"description":"Present when this family member has a Natera case ID. Omit\nor send null when only requisition_id is known.\n","type":"string","nullable":true},"requisition_id":{"$ref":"#/components/schemas/RequisitionId"},"relationship":{"type":"string","enum":["PROBAND","PARENT","SIBLING"]}},"required":["relationship"]}},"fvt":{"description":"Familial variant testing details. Optional; when supplied on an FVT\norder, MyOme resolves the source requisition and variants\nautomatically instead of holding the order for manual resolution.\n\nVariant classification is never accepted here \u2014 each `hgvs` is\nmatched against a variant already reported on the source\nrequisition, and its existing classification is carried forward. An\n`hgvs` that matches no variant, or more than one, is rejected.\n","type":"object","additionalProperties":false,"required":["source_identifier","relationship","variants"],"properties":{"source_identifier":{"description":"Identifier of the requisition the variants were reported on.\nAccepts either a MyOme requisition ID or a Natera case ID.\n","type":"string"},"relationship":{"description":"Relationship of the subject of this order to the subject of the\nsource requisition.\n","allOf":[{"$ref":"#/components/schemas/BiologicalRelationshipExtended"}]},"variants":{"description":"Variants to test for, as reported on the source requisition.","type":"array","minItems":1,"items":{"type":"object","additionalProperties":false,"required":["hgvs"],"properties":{"hgvs":{"description":"HGVS expression, either `ACCESSION:variant`\n(`NM_000466.3:c.1359+601A>G`) or a bare `c.` / `n.` / `g.` /\n`p.` / `t.` expression.\n","type":"string","minLength":1},"gene_symbol":{"description":"HGNC gene symbol. Required when `hgvs` has no accession.\n","type":"string","nullable":true}}}}}},"files":{"type":"array","items":{"type":"string"}},"original_requisition_id":{"description":"The requisition ID of the original requisition being\nrerequisitioned. When provided, this order is treated as a\nrerequisition. Samples are generally not required, except for\nmethylation reflex orders.\n","allOf":[{"$ref":"#/components/schemas/RequisitionId"}],"nullable":true},"rerequisition_type":{"description":"Kind of rerequisition when `original_requisition_id` is set.\n`NEW_ORDER` is a follow-on order of additional products against\nthe original sample. `REANALYSIS` is a reanalysis of the same\nproduct previously ordered. `METHYLATION_REFLEX` is a follow-on\nanalysis of a blood sample for the same product previously\nordered, to attempt to resolve a VUS finding. If omitted, the\ntype is inferred from the ordered products.\n","allOf":[{"$ref":"#/components/schemas/RerequisitionType"}],"nullable":true},"original_natera_case_id":{"description":"The Natera case ID of the original requisition being\nrerequisitioned. Must match the natera_case_id of the\nrequisition referenced by original_requisition_id.\n","type":"string","nullable":true},"clinical_indications":{"description":"Free-text clinical indications for the order.","type":"string","nullable":true},"order_date":{"$ref":"#/components/schemas/YMDDate"}}},"example":[{"billing":[{"billing_type":"INSURANCE","insurance":[{"policyholder_name":{"first":"John","last":"Doe"},"company":"Best Health","member_id":"123456789","prior_auth_number":"29484758","relationship_to_policyholder":"SELF"}]}],"campaign":"CAMPAIGN_CODE","consents_granted":["myome:consent:GENERAL-0.0.1","myome:consent:PR2019-0.0.1","myome:consent:PR3009-0.0.1"],"order":{"send_kit":false,"product_ids":["PR-2019","PR-3009"],"declared_specimen_type":"BLOOD","pre_test_counseling":false,"post_test_counseling":true},"subject":{"name":{"first":"Ford","last":"Prefect"},"demographics":{"dob":"1999-01-01","sex":"MALE"},"contact_info":[{"email":"ford@prefect.com","phone":"+1-415-555-1212","address":{"street_address":"42 Improbability Dr","city":"San Francisco","region":"CA","postal_code":"94105","country":"US"}}]},"lab_referral":true,"natera_case_id":"123456789","natera_ordering_clinic":{"name":"Natera Clinic","phone":"4155551212","address":{"street_address":"201 Industrial Rd","city":"San Carlos","region":"CA","postal_code":"94070","country":"US"}},"natera_ordering_provider":{"npi":"0123456789","name":{"first":"Doctor","last":"DoLittle","credentials":"M.D."}},"samples":[{"sample_id":"sample_1","sample_type":"BLOOD","collection_date":"2021-01-01","accessioned_date":"2021-01-02"}],"case_requisitions":[{"natera_case_id":"123456789","relationship":"PROBAND"},{"natera_case_id":"987654321","relationship":"PARENT"},{"natera_case_id":"122456789","relationship":"SIBLING"}],"clinical_indications":"Patient presents with developmental delay and seizures.","files":["base64encodedfile"]}]}}},"Onboarding":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["provider","has_teammates","organization"],"properties":{"signup_code":{"type":"string"},"provider":{"$ref":"#/components/schemas/OnboardingProvider"},"has_teammates":{"type":"boolean"},"teammates":{"type":"array","items":{"$ref":"#/components/schemas/OnboardingProvider"}},"organization":{"type":"object","additionalProperties":false,"required":["name","phone","address"],"properties":{"name":{"type":"string"},"phone":{"type":"string"},"fax":{"type":"string"},"address":{"$ref":"#/components/schemas/Address"},"partner_clinic_id":{"type":"string"}}}}},"example":[{"signup_code":"CATALYST","provider":{"name":{"first":"Admin","last":"Admin"},"role":"LAB_MANAGER","email":"lab_manager@org.com"},"has_teammates":true,"teammates":[{"name":{"first":"Doctor","last":"DoLittle","credentials":"M.D."},"role":"ORDERING_PROVIDER","npi":"0123456789","email":"doc@org.com"}],"organization":{"name":"Health Inc","phone":"123-123-1234","address":{"street_address":"123 Main St","city":"Death Valley","region":"NV","postal_code":"55555","country":"US"},"partner_clinic_id":"123456"}}]}}},"OrganizationClinicianDelegatePostBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["provider_id"],"properties":{"provider_id":{"$ref":"#/components/schemas/ClinicianId"}}},"example":[{"provider_id":"CL12345"}]}}},"OrganizationProviderPatchBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"provider_roles":{"type":"array","items":{"$ref":"#/components/schemas/OrganizationProviderRole"}},"communication_preferences":{"type":"object"}}},"example":[{"provider_roles":["ADMIN","DELEGATE"],"communication_preferences":{"receives_results_email":true}}]}}},"OrganizationProviderPostBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["provider","organization_provider_roles"],"properties":{"provider":{"$ref":"#/components/schemas/OnboardingProvider"},"organization_provider_roles":{"type":"array","items":{"$ref":"#/components/schemas/OrganizationProviderRole"}}}},"example":[{"provider":{"name":{"first":"Admin","last":"Admin"},"email":"lab_manager@org.com","npi":"0123456789"},"organization_provider_roles":["ADMIN","DELEGATE"]}]}}},"PatientConsent":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"consents_granted":{"type":"array","items":{"$ref":"#/components/schemas/ConsentUri"}},"consents_revoked":{"type":"array","items":{"$ref":"#/components/schemas/ConsentUri"}}}},"example":[{"consents_granted":["myome:consent:GENERAL-0.0.1","myome:consent:PR2019-0.0.1"],"consents_revoked":["myome:consent:PRODUCT_NOTIFICATIONS-0.0.1"]}]}}},"ProviderClinicDetailsPatchBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","maxLength":100},"phone":{"type":"string","maxLength":64},"fax":{"type":"string","maxLength":64},"is_fax_enabled":{"type":"boolean"},"address":{"$ref":"#/components/schemas/Address"}}},"example":[{"name":"Acme Health Clinic","phone":"555-555-5555","fax":"555-555-5556","is_fax_enabled":true,"address":{"street_address":"123 Example Ave","street_address_2":"Suite 100","city":"San Francisco","region":"CA","postal_code":"94102","country":"US"}}]}}},"ProviderRequisitionNotificationSettings":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["mode","selected_provider_ids"],"properties":{"mode":{"type":"string","enum":["DEFAULT","CUSTOM"]},"selected_provider_ids":{"type":"array","items":{"$ref":"#/components/schemas/ClinicianId"}}}},"example":[{"mode":"CUSTOM","selected_provider_ids":["CN123456"]}]}}},"ProvidersFormsGetRequisitionFormPostBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"selected_product_ids":{"type":"array","items":{"$ref":"#/components/schemas/ProductId"}},"requisition_id":{"$ref":"#/components/schemas/RequisitionId"},"campaign_code":{"type":"string","description":"Campaign code if applicable","example":"CATALYST"},"relative_requisition":{"type":"string","description":"Requisition identifier for FVT family member"},"relative_dob":{"type":"string","description":"DOB for FVT family member"},"rerequisition_type":{"allOf":[{"$ref":"#/components/schemas/RerequisitionType","x-nullable":true}],"nullable":true},"subject_demographics":{"type":"object","description":"Patient demographics, used to filter the orderable tests","nullable":true,"properties":{"dob":{"allOf":[{"$ref":"#/components/schemas/YMDDate","x-nullable":true}],"nullable":true,"description":"Patient date of birth"},"sex":{"allOf":[{"$ref":"#/components/schemas/BiologicalSex","x-nullable":true}],"nullable":true},"address_region":{"type":"string","description":"Patient address region"},"address_country":{"type":"string","description":"Patient address country"}}}}},"example":{"selected_product_ids":["PR-2019"],"requisition_id":"RQ123456","campaign_code":"CATALYST","relative_requisition":"RQ123456","relative_dob":"1999-01-01","subject_demographics":{"dob":"1980-01-01","sex":"FEMALE","address_region":"CA","address_country":"US"}}}}},"ReferringLabRedraw":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"Request body for the Natera redraw endpoint.\n\nConditional requirements (enforced server-side):\n  * When `natera_case_id` is a non-empty string, `order_date` and\n    `samples` are required.\n  * When `natera_case_id` is `null`, missing, or empty, the case id\n    is cleared from the requisition. `samples` must be empty or\n    omitted in that case, but `remove_samples` is still allowed and\n    `order_date`, if omitted, leaves the requisition's existing\n    order date unchanged.\n","additionalProperties":false,"properties":{"order_date":{"allOf":[{"$ref":"#/components/schemas/YMDDate","x-nullable":true}],"nullable":true},"natera_case_id":{"type":"string","nullable":true},"samples":{"type":"array","items":{"$ref":"#/components/schemas/ExternalSample"}},"remove_samples":{"type":"array","items":{"$ref":"#/components/schemas/ExternalSample"}}}},"example":[{"order_date":"2026-03-27","natera_case_id":"123456789","samples":[{"sample_id":"sample_2","sample_type":"BLOOD","collection_date":"2026-03-25","accessioned_date":"2026-03-26"}],"remove_samples":[{"sample_id":"sample_1","sample_type":"BLOOD","collection_date":"2026-03-20","accessioned_date":"2026-03-21"}]},{"natera_case_id":null,"remove_samples":[{"sample_id":"sample_1","sample_type":"BLOOD","collection_date":"2026-03-20","accessioned_date":"2026-03-21"}]}]}}},"Requisition":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["order","subject","billing"],"additionalProperties":false,"properties":{"billing":{"$ref":"#/components/schemas/Billing"},"campaign":{"type":"string"},"original_requisition_id":{"allOf":[{"$ref":"#/components/schemas/RequisitionId"}],"nullable":true},"rerequisition_type":{"description":"Kind of rerequisition when `original_requisition_id` is set.\nAlways send `NEW_ORDER`. If omitted, the type is inferred from\nthe ordered products.\n","allOf":[{"$ref":"#/components/schemas/RerequisitionType"}],"nullable":true},"ordering_provider_npi":{"$ref":"#/components/schemas/NPI"},"ordering_provider":{"description":"Embedded ordering provider details. Use this instead of\n`ordering_provider_npi` when the provider may not yet exist at the\nclinic. If the NPI does not resolve to a verified provider, MyOme\nverifies it against the NPPES registry. On a successful match the\nprovider is created/used as verified and the requisition proceeds\nnormally. If verification cannot be completed automatically, the\nrequisition is accepted (HTTP 202) with\n`provider_verification_status: PENDING` and held for manual review.\n","type":"object","required":["npi","name"],"properties":{"npi":{"$ref":"#/components/schemas/NPI"},"name":{"$ref":"#/components/schemas/Name"}}},"ordering_clinic":{"$ref":"#/components/schemas/ClinicId"},"sharing_providers":{"description":"Providers with whom the order will be shared.\n","type":"array","items":{"type":"object","required":["provider_npi","clinic_id"],"properties":{"provider_npi":{"$ref":"#/components/schemas/NPI"},"clinic_id":{"$ref":"#/components/schemas/ClinicId"}}}},"consents_granted":{"description":"Consents asserted by the client.\n\nConsent IDs available to the client may be obtained from the `/consents/`\nendpoint.\n","type":"array","items":{"$ref":"#/components/schemas/ConsentUri"}},"hie_opt_in":{"description":"true for opt-in, false for opt-out","type":"boolean","nullable":true},"research_contact_opt_in":{"description":"true for opt-in, false for opt-out","type":"boolean","nullable":true},"transactional_sms_opt_in":{"description":"true for opt-in, false for opt-out","type":"boolean","nullable":true},"marketing_opt_in":{"description":"true for opt-in, false for opt-out","type":"boolean","nullable":true},"order":{"description":"Order information","type":"object","properties":{"send_kit":{"description":"Whether MyOme should send a kit to the subject.","type":"boolean"},"declared_specimen_type":{"$ref":"#/components/schemas/SampleType"},"product_ids":{"description":"Product codes specifying the desired tests or analyses.\n\nProduct codes available to the client may be obtained from the `/products/`\nendpoint.\n","type":"array","items":{"$ref":"#/components/schemas/ProductId"}},"pre_test_counseling":{"description":"Whether the subject will undergo pre-test genetic counseling","type":"boolean","default":false},"post_test_counseling":{"description":"Whether the subject will undergo post-test genetic counseling","type":"boolean","default":false},"product_data":{"description":"Additional data required for ordered products","type":"object","additionalProperties":false,"properties":{"PR-4001":{"$ref":"#/components/schemas/ProductDataPR4001Empower"},"PR41003":{"$ref":"#/components/schemas/ProductDataPR41003"},"PR42009":{"$ref":"#/components/schemas/ProductDataPR42009"},"PR41016":{"$ref":"#/components/schemas/ProductDataPR41016"},"PR42014":{"$ref":"#/components/schemas/ProductDataPR42014"},"PR41027":{"$ref":"#/components/schemas/ProductDataPR41027"},"PR42023":{"$ref":"#/components/schemas/ProductDataPR42023"},"PR41034":{"$ref":"#/components/schemas/ProductDataPR41034"},"PR42038":{"$ref":"#/components/schemas/ProductDataPR42038"},"PR51049":{"$ref":"#/components/schemas/ProductDataRareDisease"},"PR51017":{"$ref":"#/components/schemas/ProductDataRareDisease"}}}},"required":["send_kit","declared_specimen_type","product_ids"]},"lab_referral":{"$ref":"#/components/schemas/LabReferral"},"subject":{"$ref":"#/components/schemas/Subject"},"physician_of_record_services":{"$ref":"#/components/schemas/PhysicianOfRecord"},"family_history":{"$ref":"#/components/schemas/FamilyHistory"},"campaign_information":{"type":"object","additionalProperties":false,"properties":{"participant_id":{"description":"Campaign participant ID","type":"string"}},"required":["participant_id"]},"clinical_indications":{"description":"Free-text clinical indications for the order.","type":"string","nullable":true}},"oneOf":[{"required":["ordering_provider_npi","ordering_clinic","consents_granted"],"properties":{"ordering_provider_npi":{"$ref":"#/components/schemas/NPI"},"ordering_clinic":{"$ref":"#/components/schemas/ClinicId"},"consents_granted":{"description":"Consents asserted by the client.\n\nConsent IDs available to the client may be obtained from the `/consents/`\nendpoint.\n","type":"array","items":{"$ref":"#/components/schemas/ConsentUri"}}}},{"required":["ordering_provider","ordering_clinic","consents_granted"],"properties":{"ordering_provider":{"type":"object","required":["npi","name"],"properties":{"npi":{"$ref":"#/components/schemas/NPI"},"name":{"$ref":"#/components/schemas/Name"}}},"ordering_clinic":{"$ref":"#/components/schemas/ClinicId"},"consents_granted":{"description":"Consents asserted by the client.\n\nConsent IDs available to the client may be obtained from the `/consents/`\nendpoint.\n","type":"array","items":{"$ref":"#/components/schemas/ConsentUri"}}}},{"required":["lab_referral"],"properties":{"lab_referral":{"$ref":"#/components/schemas/LabReferral"}}},{"required":["physician_of_record_services","consents_granted","family_history"],"properties":{"physician_of_record_services":{"$ref":"#/components/schemas/PhysicianOfRecord"},"consents_granted":{"description":"Consents asserted by the client.\n\nConsent IDs available to the client may be obtained from the `/consents/`\nendpoint.\n","type":"array","items":{"$ref":"#/components/schemas/ConsentUri"}},"family_history":{"$ref":"#/components/schemas/FamilyHistory"}}}]},"example":[{"billing":[{"billing_type":"INSURANCE","insurance":[{"policyholder_name":{"first":"John","last":"Doe"},"company":"Best Health","member_id":"123456789","prior_auth_number":"29484758","relationship_to_policyholder":"SELF"}]}],"campaign":"CAMPAIGN_CODE","ordering_provider_npi":"0123456789","ordering_clinic":"CL1234","sharing_providers":[{"provider_npi":"9876543210","clinic_id":"CL9876"}],"consents_granted":["myome:consent:GENERAL-0.0.1","myome:consent:PR2019-0.0.1"],"order":{"send_kit":false,"product_ids":["PR-2019","PR-3009"],"declared_specimen_type":"SALIVA","pre_test_counseling":false,"post_test_counseling":true},"subject":{"name":{"first":"Ford","last":"Prefect"},"demographics":{"dob":"1999-01-01","sex":"MALE"},"contact_info":[{"email":"ford@prefect.com","phone":"+1-415-555-1212","address":{"street_address":"1 Main St.","city":"San Francisco","region":"CA","postal_code":"94105","country":"US"}}]}}]}}},"RequisitionDowngrade":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["support_requisition_ids"],"additionalProperties":false,"properties":{"support_requisition_ids":{"type":"array","minItems":1,"maxItems":2,"items":{"$ref":"#/components/schemas/RequisitionId"}}}},"example":[{"support_requisition_ids":["RQ123456","RQ234567"]}]}}},"SubmissionFormSchema":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["first_name","last_name","date_of_birth","household_size","household_income","insurance_status","estimated_max_cost","tos_consent","signature","datetime_signed"],"additionalProperties":false,"properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"date_of_birth":{"format":"date","type":"string"},"requisition_id":{"$ref":"#/components/schemas/RequisitionId"},"phone_number":{"type":"string"},"email":{"type":"string"},"datetime_signed":{"format":"date-time","type":"string"},"estimated_max_cost":{"type":"integer"},"household_income":{"type":"integer"},"household_size":{"type":"integer"},"insurance_status":{"$ref":"#/components/schemas/InsuranceStatus"},"signature":{"type":"string"},"tos_consent":{"type":"boolean"}}},"example":[{"first_name":"John","last_name":"Doe","date_of_birth":"2000-01-01","phone_number":"555-555-5555","email":"john.doe@example.com","requisition_id":"RQ123456","household_size":4,"household_income":55000,"estimated_max_cost":1000,"insurance_status":"NOT_INSURED","tos_consent":true,"signature":"John Doe","datetime_signed":"2025-06-05T22:37:23.726516+00:00"}]}}}},"responses":{"ClinicianFormRequisitionPostResponse":{"description":"Requisition ID, Clinician, consent(s), order(s), and subject information associated with a given newly created requisition.","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["requisition_id","clinicians","orders","consents_granted","subject"],"properties":{"requisition_id":{"$ref":"#/components/schemas/RequisitionId"},"individual_id":{"$ref":"#/components/schemas/IndividualId"},"clinicians":{"type":"array","items":{"$ref":"#/components/schemas/Clinician"}},"collated_report":{"type":"object","description":"MyOme report consisting of a cover page, report for each order, and a\nclinical summary letter. Currently only available for patient initiated\ntest requests.\n","properties":{"uri":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"mimetype":{"type":"string","nullable":true}},"nullable":true},"consents_granted":{"type":"array","items":{"$ref":"#/components/schemas/ConsentUri"}},"orders":{"type":"array","items":{"$ref":"#/components/schemas/RequisitionOrderDetails"}},"referring_lab":{"type":"object","properties":{"name":{"type":"string","nullable":true},"clia_numbers":{"type":"array","items":{"type":"string"},"nullable":true},"contact_info":{"type":"array","items":{"type":"object","properties":{"phone":{"type":"string","nullable":true}}},"nullable":true}},"nullable":true},"subject":{"$ref":"#/components/schemas/SubjectOptionalAddress"},"ancestry":{"type":"array","items":{"type":"string"},"nullable":true},"clinic_name":{"type":"string","nullable":true},"guardian":{"allOf":[{"$ref":"#/components/schemas/RequisitionGuardian"}],"nullable":true},"remote_mrn":{"type":"string","nullable":true},"sample_request":{"allOf":[{"$ref":"#/components/schemas/RequisitionSampleRequest"}],"nullable":true},"indications":{"type":"string","nullable":true},"post_test_counseling":{"allOf":[{"$ref":"#/components/schemas/PostTestCounselingType"}],"nullable":true},"preferred_report_delivery":{"allOf":[{"$ref":"#/components/schemas/PreferredReportDeliveryMethod"}],"nullable":true},"billing":{"allOf":[{"$ref":"#/components/schemas/RequisitionBilling"}],"nullable":true},"consent_grants":{"type":"array","items":{"$ref":"#/components/schemas/RequisitionConsentGrant"},"nullable":true},"order_observations":{"type":"array","items":{"$ref":"#/components/schemas/RequisitionOrderObservation"},"nullable":true},"family_members":{"type":"array","items":{"$ref":"#/components/schemas/RequisitionFamilyMember"},"nullable":true},"submitted_at":{"allOf":[{"$ref":"#/components/schemas/UTCTimestamp"}],"nullable":true},"case_requisitions":{"type":"array","description":"A list of any connected requisitions for duo and trio products\n","items":{"$ref":"#/components/schemas/CaseRequisition"},"nullable":true},"fvt":{"allOf":[{"$ref":"#/components/schemas/FVTRequisitionDetails"}],"nullable":true},"external_status":{"allOf":[{"$ref":"#/components/schemas/ExternalOrderStatus"}],"nullable":true},"clinician_review_status":{"allOf":[{"$ref":"#/components/schemas/ClinicianReviewStatus"}],"nullable":true},"order_date":{"allOf":[{"$ref":"#/components/schemas/YMDDate"}],"nullable":true},"rerequisition_type":{"allOf":[{"$ref":"#/components/schemas/RerequisitionType"}],"nullable":true},"is_eligible_for_methylation_reanalysis":{"type":"boolean","description":"Whether this requisition is eligible for methylation reanalysis"}}},"example":[{"requisition_id":"RQ123","individual_id":"IN123","clinicians":[{"clinic_name":"Acme Health","contact_info":[{"address":{"city":"San Francisco","country":"US","postal_code":"12345","region":"CA","street_address":"123 Example Ln"},"email":"clinician@example.com","phone":"+1-415-555-1212"}],"name":{"first":"Zaphod","last":"Beeblebrox","credentials":"M.D."},"npi":"012345678"}],"consents_granted":["myome:consent:GENERAL-0.0.1","myome:consent:PR2019-0.0.1"],"orders":[{"order_id":"OR2000308","product_id":"PR-2019","product_name":"MyOme Personal Genome, Proactive Health, 81 Genes","report_type":"MONOGENIC","status":"ANALYZING","results":[{"finding":"POSITIVE","text":"A pathogenic variant was identified in the BRCA2 gene."}],"created_at":"2023-05-16T04:59:01.169271+00:00","reported_at":"2023-11-12T22:07:34.557423Z"}],"subject":{"demographics":{"sex":"MALE","dob":"1999-01-01"},"contact_info":[{"address":{"city":"San Francisco","country":"US","postal_code":"98765","region":"CA","street_address":"456 Open Rd"},"email":"patient@example.com","phone":"+1-415-555-9090"}],"name":{"first":"Ford","last":"Prefect"}},"submitted_at":"2023-05-15T04:59:01.169271+00:00","external_status":"COMPLETED","clinician_review_status":"COMPLETED","order_date":"2023-05-15","fvt":{"source_requisition":"RQ123","source_relationship":"PARENT","variants":[{"value":"1","display":"BTD NM_007294.4(BRCA1):c.5585A>G NP_009225.1:p.His1862Arg (Pathogenic)"}]}}]}}},"ClinicianGetResponse":{"description":"Details on a specific clinician","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Clinician"},"example":[{"clinic_name":"Acme Health","clinician_id":"CNtst123456","contact_info":[{"address":{"city":"San Francisco","country":"US","postal_code":"99999","region":"CA","street_address":"123 Example Ave"},"email":"example@clinician.com","fax":"123456789","phone":"555-555-5555"}],"name":{"credentials":"M.D.","first":"Jon","last":"Doe","middle":"Example"},"npi":"8765432100","clinics":[{"name":"Acme Health","clinic_id":"CL12345","roles":["CLINICIAN"]}],"communication_preferences":{"receives_results_email":true},"campaigns":[{"campaign_code":"ANVIL","name":"Anvil","description":"by Acme Health","is_active":true}],"is_active":true}]}}},"ClinicianListResponse":{"description":"listing of affiliated clinicians","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["count","next","previous","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true},"previous":{"type":"string","nullable":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/Clinician"}}}},"example":[{"count":1,"next":null,"previous":null,"results":[{"clinic_name":"Acme Health","clinician_id":"CNtst123456","contact_info":[{"address":{"city":"San Francisco","country":"US","postal_code":"99999","region":"CA","street_address":"123 Example Ave"},"email":"example@clinician.com","fax":"123456789","phone":"555-555-5555"}],"name":{"credentials":"M.D.","first":"Jon","last":"Doe","middle":"Example"},"npi":"8765432100","clinics":[{"name":"Acme Health","clinic_id":"CL12345","roles":["CLINICIAN"]}],"communication_preferences":{"receives_results_email":true},"campaigns":[{"campaign_code":"ANVIL","name":"Anvil","description":"by Acme Health","is_active":true}],"is_active":true}]}]}}},"CliniciansFormsRequisitionGetResponse":{"description":"Schema for generating a form for clinician requisition creation, see https://rjsf-team.github.io/react-jsonschema-form/docs/","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"jsonschema":{"type":"object","additionalProperties":true,"nullable":true},"uischema":{"type":"object","additionalProperties":true,"nullable":true},"formdata":{"type":"object","additionalProperties":true,"nullable":true},"campaign":{"allOf":[{"$ref":"#/components/schemas/Campaign"}],"nullable":true},"errors":{"type":"array","items":{"type":"string"},"nullable":true}}},"example":[{"jsonschema":{"product_ids":[{"id":"PR-2019","label":"MyOme Proactive Health Panel, 81 Genes"}]},"uischema":{},"formdata":{},"errors":["error string"]}]}}},"ConsentListResponse":{"description":"List of general and product specific consents","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"consent_uri":{"allOf":[{"$ref":"#/components/schemas/ConsentUri"}],"nullable":true},"name":{"type":"string","nullable":true,"description":"Consent name"},"consent_text":{"type":"string","nullable":true}}}},"example":[[{"consent_uri":"myome:consent:GENERAL-0.0.1","name":"MyOme General Consent","consent_text":"Example consent text"}]]}}},"DraftRequisitionGetResponse":{"description":"draft response data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DraftRequisition"},"example":[{"identifier":"DR123456","name":"Patient Name Draft","status":"ACTIVE","formdata":{"products_ids":["PR123"]},"created_at":"2018-11-13T20:20:39.0123Z","updated_at":"2018-11-13T20:20:39.0123Z","created_by":{"clinic_name":"Acme Health","clinician_id":"CNtst123456","contact_info":[{"address":{"city":"San Francisco","country":"US","postal_code":"99999","region":"CA","street_address":"123 Example Ave"},"email":"example@clinician.com","fax":"123456789","phone":"555-555-5555"}],"name":{"credentials":"M.D.","first":"Jon","last":"Doe","middle":"Example"},"npi":"8765432100","clinics":[{"name":"Acme Health","clinic_id":"CL12345","roles":["CLINICIAN"]}],"campaigns":[{"campaign_code":"ANVIL","name":"Anvil","description":"by Acme Health","is_active":true}]},"ordering_provider":{"clinic_name":"Acme Health","clinician_id":"CNtst123456","contact_info":[{"address":{"city":"San Francisco","country":"US","postal_code":"99999","region":"CA","street_address":"123 Example Ave"},"email":"example@clinician.com","fax":"123456789","phone":"555-555-5555"}],"name":{"credentials":"M.D.","first":"Jon","last":"Doe","middle":"Example"},"npi":"8765432100","clinics":[{"name":"Acme Health","clinic_id":"CL12345","roles":["CLINICIAN"]}],"campaigns":[{"campaign_code":"ANVIL","name":"Anvil","description":"by Acme Health","is_active":true}]},"ordering_clinic":{"name":"Acme Health","clinic_id":"CL12345","department":"Anvils"},"rerequisition_from":"RQ2001234","rerequisition_type":"REANALYSIS"}]}}},"DraftRequisitionListResponse":{"description":"List of available requisitions and corresponding details.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DraftRequisition"}},"example":[[{"identifier":"DR123456","name":"Patient Name Draft","status":"ACTIVE","formdata":{"products_ids":["PR123"]},"created_at":"2018-11-13T20:20:39.0123Z","updated_at":"2018-11-13T20:20:39.0123Z","created_by":{"clinic_name":"Acme Health","clinician_id":"CNtst123456","contact_info":[{"address":{"city":"San Francisco","country":"US","postal_code":"99999","region":"CA","street_address":"123 Example Ave"},"email":"example@clinician.com","fax":"123456789","phone":"555-555-5555"}],"name":{"credentials":"M.D.","first":"Jon","last":"Doe","middle":"Example"},"npi":"8765432100","clinics":[{"name":"Acme Health","clinic_id":"CL12345","roles":["CLINICIAN"]}],"campaigns":[{"campaign_code":"ANVIL","name":"Anvil","description":"by Acme Health","is_active":true}]},"ordering_provider":{"clinic_name":"Acme Health","clinician_id":"CNtst123456","contact_info":[{"address":{"city":"San Francisco","country":"US","postal_code":"99999","region":"CA","street_address":"123 Example Ave"},"email":"example@clinician.com","fax":"123456789","phone":"555-555-5555"}],"name":{"credentials":"M.D.","first":"Jon","last":"Doe","middle":"Example"},"npi":"8765432100","clinics":[{"name":"Acme Health","clinic_id":"CL12345","roles":["CLINICIAN"]}],"campaigns":[{"campaign_code":"ANVIL","name":"Anvil","description":"by Acme Health","is_active":true}]},"ordering_clinic":{"name":"Acme Health","clinic_id":"CL12345","department":"Anvils"}}]]}}},"DraftRequisitionPostResponse":{"description":"ID of newly-created draft requisition","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["identifier"],"properties":{"identifier":{"$ref":"#/components/schemas/DraftRequisitionId"}}},"example":[{"identifier":"DR123456"}]}}},"IndividualDetailGetResponse":{"description":"Get multiple pieces of data needed for the patient detail page","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["individual","requisitions","has_pgx_guidelines"],"properties":{"individual":{"$ref":"#/components/schemas/SubjectOptionalAddress"},"requisitions":{"type":"array","items":{"$ref":"#/components/schemas/RequisitionListItem"}},"has_pgx_guidelines":{"type":"boolean"},"rerequisition_eligibility":{"allOf":[{"$ref":"#/components/schemas/ProviderPortalIndividualRerequisitionEligibility"}],"description":"Rerequisition eligibility details for an individual","nullable":true}}},"example":[{"individual":{"demographics":{"sex":"MALE","dob":"1999-01-01"},"contact_info":[{"address":{"city":"San Francisco","country":"US","postal_code":"98765","region":"CA","street_address":"456 Open Rd"},"email":"patient@example.com","phone":"+1-415-555-9090"}],"name":{"first":"Ford","last":"Prefect"}},"has_pgx_guidelines":false,"requisitions":[{"requisition_id":"RQ2001234","individual_id":"IN2001234","orders":[{"order_id":"OR2000308","product_id":"PR41003","product_name":"Atlas Cancer Plus, Breast Cancer Integrated Risk","product_family_name":"Atlas Cancer Plus","product_test_name":"Breast Cancer Integrated Risk","product_test_type":"Breast Cancer","product_test_subclass":"Integrated Risk","report_type":"MONOGENIC","status":"ANALYZING","results":[{"finding":"POSITIVE","text":"A pathogenic variant was identified in the BRCA2 gene."}],"created_at":"2023-05-16T04:59:01.169271+00:00","reported_at":"2022-11-12T22:07:34.557423Z"}],"submitted_at":"2022-12-12T22:07:34.557423Z","sample_received_at":"2022-12-12T22:07:34.557423Z","updated_at":"2022-12-12T22:07:34.557423Z","first_reported_at":"2022-11-12","clinical_summary_letter_ready_at":"2022-11-15","name":{"first":"John","last":"Doe"},"clinicians":[{"clinic_name":"Acme Health","clinician_id":"CNtst123456","contact_info":[{"address":{"city":"San Francisco","country":"US","postal_code":"99999","region":"CA","street_address":"123 Example Ave"},"email":"example@clinician.com","fax":"123456789","phone":"555-555-5555"}],"name":{"credentials":"M.D.","first":"Jon","last":"Doe","middle":"Example"},"npi":"8765432100","clinics":[{"name":"Acme Health","clinic_id":"CL12345","roles":["CLINICIAN"]}],"campaigns":[{"campaign_code":"ANVIL","name":"Anvil","description":"by Acme Health","is_active":true}]}],"external_mrn":"ABC123"}]}]}}},"InstitutionalCampaignNightlyManifestResponse":{"description":"Nightly requisition manifest rows for a campaign date","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["requisition_id","requisition_date"],"properties":{"requisition_id":{"type":"string"},"participant_id":{"type":"string","nullable":true},"requisition_date":{"type":"string","format":"date"},"tube_barcode_id":{"type":"string","nullable":true},"sample_type":{"type":"string","nullable":true},"participant_initials":{"type":"string","nullable":true},"participant_year_of_birth":{"type":"string","nullable":true}}}},"example":[[{"requisition_id":"RQ123456","participant_id":"P123456","requisition_date":"2026-09-03","tube_barcode_id":"SM123456","sample_type":"SALIVA","participant_initials":"JD","participant_year_of_birth":"1980"}]]}}},"InstitutionalCampaignProviderListResponse":{"description":"List of ordering providers that are associated with the campaign","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["count","next","previous","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true},"previous":{"type":"string","nullable":true},"results":{"type":"array","items":{"type":"object","required":["account_activated","name","npi"],"additionalProperties":true,"description":"A list of ordering providers associated with the given campaign code.\nThe response format is nearly identical to ClinicianListResponse with the\naddition of clinic contact information and whether the ordering provider\nhas activated their account.\n","properties":{"name":{"$ref":"#/components/schemas/Name"},"npi":{"type":"string"},"contact_info":{"type":"array","items":{"$ref":"#/components/schemas/ContactInfo"},"nullable":true},"account_activated":{"type":"boolean"},"clinics":{"type":"array","items":{"type":"object","additionalProperties":true,"properties":{"contact_info":{"type":"array","items":{"$ref":"#/components/schemas/ContactInfo"},"nullable":true}}},"nullable":true}}}}}},"example":[{"count":1,"next":null,"previous":null,"results":[{"clinician_id":"CNtst123456","contact_info":[{"address":{"city":"San Francisco","country":"US","postal_code":"99999","region":"CA","street_address":"123 Example Ave"},"email":"example@clinician.com","fax":"123456789","phone":"555-555-5555"}],"name":{"credentials":"M.D.","first":"Jon","last":"Doe","middle":"Example"},"npi":"8765432100","clinics":[{"name":"Acme Health","clinic_id":"CL12345","contact_info":[{"address":{"city":"San Jose","country":"US","postal_code":"11111","region":"CA","street_address":"10 Street Rd."},"email":"contact@acmehealth.org","fax":"111-222-3333","phone":"999-888-7777"}]}],"account_activated":true}]}]}}},"InstitutionalCampaignRequisitionListResponse":{"description":"listing of all requisitions in the campaign","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"last_updated_at":{"allOf":[{"$ref":"#/components/schemas/YMDDate"}],"nullable":true},"participant_id":{"type":"string","nullable":true},"participant_initials":{"type":"string","nullable":true},"participant_year_of_birth":{"type":"string","nullable":true},"individual_id":{"allOf":[{"$ref":"#/components/schemas/IndividualId"}],"nullable":true,"description":"Identifier of the patient individual linked to the requisition"},"requisition_date":{"allOf":[{"$ref":"#/components/schemas/YMDDate"}],"nullable":true},"requisition_id":{"allOf":[{"$ref":"#/components/schemas/RequisitionId"}],"nullable":true},"is_rerequisition":{"type":"boolean","nullable":true,"description":"Whether the requisition is a re-requisition"},"requisition_type":{"type":"string","enum":["original","rerequisition"],"description":"Whether the requisition is an original requisition or a re-requisition of an earlier one."},"external_status":{"allOf":[{"$ref":"#/components/schemas/ExternalOrderStatus"}],"nullable":true},"sequencing_status":{"type":"string","enum":["SUCCESS","FAILURE"],"nullable":true},"report_released_at":{"allOf":[{"$ref":"#/components/schemas/YMDDate"}],"nullable":true},"samples":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"sample_id":{"allOf":[{"$ref":"#/components/schemas/SampleId"}],"nullable":true},"sample_received_at":{"allOf":[{"$ref":"#/components/schemas/YMDDate"}],"nullable":true},"tube_barcode_id":{"type":"string","nullable":true}}},"nullable":true},"orders":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"order_id":{"allOf":[{"$ref":"#/components/schemas/OrderId"}],"nullable":true},"product_id":{"allOf":[{"$ref":"#/components/schemas/ProductId"}],"nullable":true},"product_name":{"type":"string","nullable":true},"report_type":{"type":"string","nullable":true},"external_status":{"allOf":[{"$ref":"#/components/schemas/ExternalOrderStatus"}],"nullable":true},"status_reason":{"type":"string","nullable":true,"description":"When the order is canceled, the technical cancellation reason (LIMS order status_reason; e.g. OrderStatusReason values)."},"status_message":{"type":"string","nullable":true,"description":"Human-readable status message, typically set when an order is canceled (e.g. \"Order was canceled due to: \u2026\")."}}},"nullable":true},"declared_specimen_type":{"allOf":[{"$ref":"#/components/schemas/SampleType"}],"nullable":true},"patient_first_viewed_results_on":{"allOf":[{"$ref":"#/components/schemas/YMDDate"}],"nullable":true,"description":"The first calendar date (UTC) on which the patient viewed their released results in the patient portal. Null until the patient has viewed results at least once."}}}},"example":[[{"requisition_id":"RQ123456","requisition_date":"2025-01-01","requisition_type":"original","participant_id":"SM123456","participant_initials":"JD","participant_year_of_birth":"1980","individual_id":"IN123456","sequencing_status":"SUCCESS","report_released_at":"2025-01-15","external_status":"ANALYZING","orders":[{"order_id":"OR123456","product_id":"PR22020","product_name":"MyOme Proactive Health, Single-Gene Risk, 84 Genes","report_type":"MONOGENIC","external_status":"ANALYZING","status_reason":null,"status_message":null},{"order_id":"OR123457","product_id":"PR32005","product_name":"MyOme Proactive Health","report_type":"POLYGENIC","external_status":"CANCELED","status_reason":"SAMPLE_NOT_RECEIVED","status_message":"Order was canceled due to: SAMPLE_NOT_RECEIVED"}],"samples":[{"sample_id":"SM123456","sample_received_at":"2025-01-05","tube_barcode_id":"SM123456"}],"last_updated_at":"2025-01-20","declared_specimen_type":"BLOOD"}]]}}},"MedicationResponseResponse":{"description":"List of available requisitions and corresponding details.","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["pharmgkb"],"properties":{"pharmgkb":{"type":"object","additionalProperties":true,"required":["drugs"],"properties":{"drugs":{"type":"object","additionalProperties":{"type":"object","properties":{"cpic":{"type":"object","properties":{"annotations":{"type":"array","items":{"type":"object"},"nullable":true},"description":{"type":"string","nullable":true},"notActionable":{"type":"boolean","nullable":true},"objectType":{"type":"string","nullable":true},"source":{"type":"string","nullable":true}},"nullable":true},"ddrxMode":{"type":"boolean","nullable":true},"dpwg":{"type":"object","properties":{"annotations":{"type":"array","items":{"type":"object"},"nullable":true},"description":{"type":"string","nullable":true},"notActionable":{"type":"boolean","nullable":true},"objectType":{"type":"string","nullable":true},"source":{"type":"string","nullable":true}},"nullable":true},"drug":{"type":"object","properties":{"objCls":{"type":"string","nullable":true},"id":{"type":"string","nullable":true},"name":{"type":"string","nullable":true}},"nullable":true},"fda":{"type":"object","nullable":true},"fdaPgx":{"type":"object","nullable":true},"groups":{"type":"array","items":{"type":"array","items":{"type":"string"}},"nullable":true},"notActionable":{"type":"boolean","nullable":true}}}},"errors":{"type":"object","additionalProperties":true,"nullable":true},"geneAlleleMap":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"nullable":true},"phenotypes":{"type":"object","additionalProperties":{"type":"string"},"nullable":true}}}}},"example":{"pharmgkb":{"drugs":{"abrocitinib":{"cpic":{"annotations":[],"description":"CPIC has no guidance for abrocitinib and the genes selected.","notActionable":true,"objectType":"GuidelineAnnotation","source":"CPIC"},"ddrxMode":true,"drug":{"objCls":"Chemical","id":"PA166272921","name":"abrocitinib"},"groups":[["DERMATOLOGICALS","OTHER DERMATOLOGICAL PREPARATIONS in ATC"]],"notActionable":true}},"errors":{},"geneAlleleMap":{"CYP2B6":["*6","*22"],"CYP2C19":["*1","*1"]},"phenotypes":{"CYP2B6":"Indeterminate","CYP2C19":"Normal Metabolizer"}}}}}},"OnboardingIssuesResponse":{"description":"Issues encountered during an onboarding request","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["provider_email_conflicts","unverified_providers"],"properties":{"provider_email_conflicts":{"description":"List of provider emails that are already onboarded, these providers will need to be resubmitted with a \ndifferent email\n","type":"array","items":{"type":"string"}},"unverified_providers":{"description":"List of providers NPIs that could not be automatically verified, these providers will be able to login but\nwill not be able to be an ordering provider until MyOme complete manual NPI validation.\n","type":"array","items":{"type":"string"}}}},"example":[{"provider_email_conflicts":["john.doe@example.com","jane.doe@example.com"],"unverified_providers":["0123456789","0129834765"]}]}}},"OrderGetResponse":{"description":"status of request, and result if available","content":{"application/json":{"schema":{"type":"object","properties":{"order_id":{"allOf":[{"$ref":"#/components/schemas/OrderId"}],"nullable":true},"requisition_id":{"allOf":[{"$ref":"#/components/schemas/RequisitionId"}],"nullable":true},"product_id":{"allOf":[{"$ref":"#/components/schemas/ProductId"}],"nullable":true},"product_name":{"type":"string","nullable":true},"report_type":{"allOf":[{"$ref":"#/components/schemas/ReportType"}],"nullable":true},"status":{"allOf":[{"$ref":"#/components/schemas/ExternalOrderStatus"}],"nullable":true},"submitted_at":{"allOf":[{"$ref":"#/components/schemas/UTCTimestamp"}],"nullable":true},"updated_at":{"allOf":[{"$ref":"#/components/schemas/UTCTimestamp"}],"nullable":true},"results":{"description":"Results files returned for return to Patients and Providers","type":"array","items":{"properties":{"uri":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"mimetype":{"type":"string","nullable":true},"reported_date":{"allOf":[{"$ref":"#/components/schemas/UTCTimestamp"}],"nullable":true}}},"nullable":true},"myome_results":{"description":"MyOmes original results files if cobranded files are returned in results","type":"array","items":{"properties":{"uri":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"mimetype":{"type":"string","nullable":true},"reported_date":{"allOf":[{"$ref":"#/components/schemas/UTCTimestamp"}],"nullable":true}}},"nullable":true},"status_detail":{"type":"object","nullable":true,"properties":{"status_reason":{"type":"string","enum":["QC_FAILURE_DATA","QC_FAILURE_SEX_MISMATCH"],"nullable":true},"status_message":{"type":"string","nullable":true}}},"results_json":{"type":"object","additionalProperties":true,"nullable":true},"result_json":{"description":"Report JSON, included when the request sets expand=true and a report exists","type":"object","additionalProperties":true,"nullable":true}}},"example":[{"order_id":"ORtst001234","product_id":"PR-2019","product_name":"MyOme Personal Genome, Proactive Health, 81 Genes","report_type":"MONOGENIC","requisition_id":"RQtst001234","status":"COMPLETED","submitted_at":"2022-09-01T16:18:03.460384+00:00","updated_at":"2022-09-03T16:18:03.460384+00:00","results":[{"uri":"s3://somebucket/path/to/RP-0001234.pdf","description":"signed pdf with pii","mimetype":"application/pdf","reported_date":"2022-09-03T16:18:03.460384+00:00"}],"status_detail":{"status_reason":"QC_FAILURE_DATA","status_message":"Import failure: data downloaded does not match sha512"}}]}}},"PatientConsentGetResponse":{"description":"Returns consents granted by a patient","content":{"application/json":{"schema":{"type":"object","properties":{"consents":{"type":"array","items":{"required":["consent_uri","name","is_active"],"properties":{"consent_uri":{"$ref":"#/components/schemas/ConsentUri"},"name":{"type":"string","nullable":true},"is_active":{"type":"boolean"},"granted_on":{"allOf":[{"$ref":"#/components/schemas/YMDDate"}],"nullable":true}}},"nullable":true}}},"example":[{"consents":[{"consent_uri":"myome:consent:GENERAL-0.0.1","name":"MyOme General Consent","is_active":true,"granted_on":"2023-07-11"},{"consent_uri":"myome:consent:PR2008-0.0.1","name":"MyOme Personal Genome, Proactive Health Consent","is_active":true,"granted_on":"2023-07-11"},{"consent_uri":"myome:consent:PRODUCT_NOTIFICATIONS-0.0.1","name":"Product Notification Consent","is_active":false}]}]}}},"PatientGeneticCounselingListResponse":{"description":"Lists of genetic counseling requests for a patient","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["count","next","previous","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true},"previous":{"type":"string","nullable":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/DnavisitServiceRequest"}}}},"example":[{"count":2,"next":null,"previous":null,"results":[{"requisition_id":"RQ2001234","appointment_url":"https://example.appointment/","appointment_date":"2018-11-13T20:20:39+00:00","access_code":"C12345","external_status":"IN_PROGRESS","service_type":"POST_TEST_COUNSELING","requested_on":"2023-11-08","completed_on":"2023-11-10"},{"requisition_id":"RQ2005678","access_code":"C67890","external_status":"COMPLETED","service_type":"POST_TEST_REVIEW_ONLY","requested_on":"2023-11-09","completed_on":"2023-11-12"}]}]}}},"PatientGetResponse":{"description":"Get patient details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatientProfile"},"example":[{"demographics":{"sex":"MALE","dob":"1999-01-01"},"contact_info":[{"address":{"city":"San Francisco","country":"US","postal_code":"98765","region":"CA","street_address":"456 Open Rd"},"email":"patient@example.com","phone":"+1-415-555-9090"}],"name":{"first":"Ford","last":"Prefect"}}]}}},"PatientProductGetResponse":{"description":"Get eligible products for a patient","content":{"application/json":{"schema":{"type":"object","properties":{"eligible_products":{"type":"array","items":{"$ref":"#/components/schemas/ProductId"},"nullable":true}}},"example":[{"eligible_products":["PR-3009"]}]}}},"PaymentDetailGetResponse":{"description":"Details about the patient payment for the requisition","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["payment_status","total_cost","charge_date"],"properties":{"payment_status":{"$ref":"#/components/schemas/PaymentStatus"},"total_cost":{"type":"number"},"charge_date":{"type":"string","nullable":true}}},"example":[{"payment_status":"FREE","total_cost":0.0,"charge_date":"2024-02-14"}]}}},"ProductListResponse":{"description":"List of products","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Product"}},"example":[[{"description":"Single-gene risk screening panel covering 84 genes using BGE sequencing","name":"Atlas Select, Curated Screen\u2122, 84 Genes","product_family_name":"Atlas Select","product_test_name":"Curated Screen\u2122, 84 Genes","product_test_type":"Curated Screen\u2122","product_test_subclass":"84 Genes","product_id":"PR22020"}]]}}},"ProfileGetResponse":{"description":"Get details of a user profile","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"identifiers":{"type":"object","properties":{"individual_id":{"allOf":[{"$ref":"#/components/schemas/IndividualId"}],"nullable":true},"clinician_id":{"allOf":[{"$ref":"#/components/schemas/ClinicianId"}],"nullable":true}},"nullable":true}}},"example":[{"identifiers":{"individual_id":"IN2000011"}}]}}},"ProviderClinicDetailsResponse":{"description":"Clinic details response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClinicDetails"},"example":[{"clinic_id":"CL123456","name":"Acme Health Clinic","phone":"555-555-5555","fax":"555-555-5556","is_fax_enabled":true,"fax_number_verified":false,"address":{"street_address":"123 Example Ave","street_address_2":"Suite 100","city":"San Francisco","region":"CA","postal_code":"94102","country":"US"}}]}}},"ProviderRequisitionMetricsResponse":{"description":"Aggregate counts of requisitions by status group.","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["total","reported","outstanding"],"properties":{"total":{"$ref":"#/components/schemas/NonNegativeInteger","description":"Total number of requisitions."},"reported":{"$ref":"#/components/schemas/NonNegativeInteger","description":"Number of requisitions in completed or clinician review status."},"outstanding":{"$ref":"#/components/schemas/NonNegativeInteger","description":"Number of requisitions that are not completed, in clinician review, canceled, denied, or failed."}}},"example":{"total":150,"reported":85,"outstanding":55}}}},"ProviderRequisitionNotificationSettingsResponse":{"description":"Notification settings for a requisition","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["mode","recipients"],"properties":{"mode":{"type":"string","enum":["DEFAULT","CUSTOM"]},"recipients":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["provider_id","name","email","selected"],"properties":{"provider_id":{"$ref":"#/components/schemas/ClinicianId"},"name":{"type":"string"},"email":{"type":"string","format":"email"},"selected":{"type":"boolean"}}}}}},"example":[{"mode":"DEFAULT","recipients":[{"provider_id":"CN123456","name":"Joseph Solomon, M.D.","email":"joseph@example.com","selected":true}]}]}}},"ReRequisitionResponse":{"description":"List of product IDs available for re-requisitioning.","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["eligible_products","eligible_reanalysis_products"],"properties":{"eligible_products":{"description":"Products eligible to rerequisition as a new order","type":"array","items":{"$ref":"#/components/schemas/Product"}},"eligible_reanalysis_products":{"description":"Products eligible to rerequisition as for reanalysis","type":"array","items":{"$ref":"#/components/schemas/Product"}},"eligible_methylation_reflex_products":{"description":"Products eligible for methylation reflex ordering","type":"array","items":{"$ref":"#/components/schemas/Product"}},"eligible_campaign_products":{"type":"object","nullable":true,"required":["campaign","products"],"properties":{"campaign":{"$ref":"#/components/schemas/Campaign"},"products":{"type":"array","items":{"$ref":"#/components/schemas/Product"}}}}}},"example":[{"eligible_products":[{"product_id":"PR51208","name":"MyOme Rare Disease, Exome Analysis, Duo","description":"MyOme product for analysis of variants associated with an indicated rare disease"}],"eligible_reanalysis_products":[{"product_id":"PR51194","name":"MyOme Rare Disease, Exome Analysis, Proband","description":"MyOme product for analysis of variants associated with an indicated rare disease"}],"eligible_methylation_reflex_products":[{"product_id":"PR51194","name":"MyOme Rare Disease, Exome Analysis, Proband","description":"MyOme product for analysis of variants associated with an indicated rare disease"}],"eligible_campaign_products":{"campaign":{"campaign_code":"CATALYST","name":"Catalyst","description":"Catalyst Program","is_active":true},"products":[{"product_id":"PR42014","name":"MyOme Proactive Health, Integrated Risk, Coronary Artery Disease","description":"MyOme product for estimating risk of developing CAD based on integrating PCE and PRS generated from BGE sequencing"}]}}]}}},"RequisitionListResponse":{"description":"List of available requisitions and corresponding details.","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["count","next","previous","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true},"previous":{"type":"string","nullable":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/RequisitionListItem"}}}},"example":[{"count":1,"next":null,"previous":null,"results":[{"requisition_id":"RQ2001234","individual_id":"IN2001234","orders":[{"order_id":"OR2000308","product_id":"PR-2019","product_name":"MyOme Personal Genome, Proactive Health, 81 Genes","report_type":"MONOGENIC","status":"ANALYZING","results":[{"finding":"POSITIVE","text":"A pathogenic variant was identified in the BRCA2 gene."}],"created_at":"2023-05-16T04:59:01.169271+00:00","reported_at":"2022-11-12T22:07:34.557423Z"}],"submitted_at":"2022-12-12T22:07:34.557423Z","sample_received_at":"2022-12-12T22:07:34.557423Z","updated_at":"2022-12-12T22:07:34.557423Z","name":{"first":"John","last":"Doe"},"clinicians":[{"clinic_name":"Acme Health","clinician_id":"CNtst123456","contact_info":[{"address":{"city":"San Francisco","country":"US","postal_code":"99999","region":"CA","street_address":"123 Example Ave"},"email":"example@clinician.com","fax":"123456789","phone":"555-555-5555"}],"name":{"credentials":"M.D.","first":"Jon","last":"Doe","middle":"Example"},"npi":"8765432100","clinics":[{"name":"Acme Health","clinic_id":"CL12345","roles":["CLINICIAN"]}],"campaigns":[{"campaign_code":"ANVIL","name":"Anvil","description":"by Acme Health","is_active":true}]}],"external_mrn":"ABC123","external_status":"COMPLETED","clinician_review_status":"COMPLETED"}]}]}}},"RequisitionListResultsResponse":{"description":"List of available requisitions and corresponding details.","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["count","next","previous","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true},"previous":{"type":"string","nullable":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/RequisitionListResultItem"}}}},"example":[{"count":1,"next":null,"previous":null,"results":[{"requisition_id":"RQ2001234","individual_id":"IN2001234","external_mrn":"ABC123","clinician_review_status":"COMPLETED","external_status":"COMPLETED","order_date":"2025-12-23","sample_received_at":"2022-12-23T22:07:34.557423Z","submitted_at":"2025-12-23T22:07:34.557423Z","updated_at":"2025-12-23T22:07:34.557423Z","first_reported_at":"2025-12-27","clinical_summary_letter_ready_at":"2025-12-27","name":{"first":"John","last":"Doe"},"clinical_summary_letter":{"uri":"https://example.myome.com/clinical-summary-letter.pdf","description":"Clinical summary letter for the requisition","mimetype":"application/pdf","completed_on":"2025-12-27"},"orders":[{"order_id":"OR2000308","product_id":"PR41003","product_name":"Atlas Cancer Plus, Breast Cancer Integrated Risk","product_family_name":"Atlas Cancer Plus","product_test_name":"Breast Cancer Integrated Risk","product_test_type":"Breast Cancer","product_test_subclass":"Integrated Risk","report_type":"MONOGENIC","created_at":"2025-05-16T04:59:01.169271+00:00","reported_at":"2025-12-27","status":"ANALYZING","results":[{"finding":"POSITIVE","text":"A pathogenic variant was identified in the BRCA2 gene."}]}],"ordering_provider":{"clinician_id":"CNtst123456","npi":"8765432100","name":{"credentials":"M.D.","first":"Jon","last":"Doe","middle":"Example"},"contact_info":[{"address":{"city":"San Francisco","country":"US","postal_code":"99999","region":"CA","street_address":"123 Example Ave"},"email":"example@clinician.com","fax":"123456789","phone":"555-555-5555"}]}}]}]}}},"RequisitionResponse":{"description":"Clinician, consent(s), order(s), and subject information associated with a given requisition ID. Status updates are provided for each individual order.","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["requisition_id","orders","consents_granted","subject"],"properties":{"requisition_id":{"$ref":"#/components/schemas/RequisitionId"},"individual_id":{"$ref":"#/components/schemas/IndividualId"},"provider_verification_status":{"description":"Verification state of the ordering provider for requisitions\ncreated with an embedded `ordering_provider`. `VERIFIED` means the\nprovider was matched/verified and the order proceeds normally.\n`PENDING` means the provider could not be verified automatically;\nthe requisition is accepted (HTTP 202) and held for manual review.\nAbsent for requisitions that do not use an embedded ordering\nprovider.\n","type":"string","enum":["VERIFIED","PENDING"]},"clinicians":{"type":"array","items":{"$ref":"#/components/schemas/Clinician"},"nullable":true},"collated_report":{"type":"object","description":"MyOme report consisting of a cover page, report for each order, and a\nclinical summary letter. Currently only available for patient initiated\ntest requests.\n","properties":{"uri":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"mimetype":{"type":"string","nullable":true}},"nullable":true},"clinical_summary_letter":{"allOf":[{"$ref":"#/components/schemas/ClinicalSummaryLetter"}],"description":"Clinical summary letter for the requisition if available. Absent otherwise.\n","nullable":true},"vcf":{"allOf":[{"$ref":"#/components/schemas/File"}],"description":"Presigned VCF for institution callers when `vcf_api_enabled` and the object\nis currently downloadable. Omitted otherwise; never null.\n"},"vcf_index":{"allOf":[{"$ref":"#/components/schemas/File"}],"description":"Presigned VCF index (`.tbi`) when present. Omitted otherwise."},"gvcf":{"allOf":[{"$ref":"#/components/schemas/File"}],"description":"Presigned gVCF for institution callers when `gvcf_api_enabled` and the object\nis currently downloadable. Omitted otherwise; never null.\n"},"gvcf_index":{"allOf":[{"$ref":"#/components/schemas/File"}],"description":"Presigned gVCF index (`.tbi`) when present. Omitted otherwise."},"cram":{"allOf":[{"$ref":"#/components/schemas/File"}],"description":"Presigned CRAM for institution callers when `cram_api_enabled` and the object\nis currently downloadable. Omitted otherwise; never null.\n"},"cram_index":{"allOf":[{"$ref":"#/components/schemas/File"}],"description":"Presigned CRAM index (`.crai`) when present. Omitted otherwise."},"genetic_counseling":{"allOf":[{"$ref":"#/components/schemas/DnavisitServiceRequest"}],"description":"Most recent post-test-genetic counseling request for the requisition. Contains\nthe genetic counseling scheduling link when available. Absent when no post-test\ncounseling was requested.\n\n`appointment_url` and `access_code` are used independently, not combined into a\nsingle URL: open `appointment_url` directly (do not append the code as a query\nparam) to view or manage the appointment, and present `access_code` to the\npatient to enter on DNAvisit's scheduling site.\n","nullable":true},"consents_granted":{"type":"array","items":{"$ref":"#/components/schemas/ConsentUri"}},"orders":{"type":"array","items":{"$ref":"#/components/schemas/RequisitionOrderDetails"}},"subject":{"$ref":"#/components/schemas/SubjectOptionalAddress"},"ancestry":{"type":"array","items":{"type":"string"},"nullable":true},"clinic_name":{"type":"string","nullable":true},"guardian":{"allOf":[{"$ref":"#/components/schemas/RequisitionGuardian"}],"nullable":true},"remote_mrn":{"type":"string","nullable":true},"sample_request":{"allOf":[{"$ref":"#/components/schemas/RequisitionSampleRequest"}],"nullable":true},"indications":{"type":"string","nullable":true},"post_test_counseling":{"allOf":[{"$ref":"#/components/schemas/PostTestCounselingType"}],"nullable":true},"preferred_report_delivery":{"allOf":[{"$ref":"#/components/schemas/PreferredReportDeliveryMethod"}],"nullable":true},"billing":{"allOf":[{"$ref":"#/components/schemas/RequisitionBilling"}],"nullable":true},"consent_grants":{"type":"array","items":{"$ref":"#/components/schemas/RequisitionConsentGrant"},"nullable":true},"order_observations":{"type":"array","items":{"$ref":"#/components/schemas/RequisitionOrderObservation"},"nullable":true},"family_members":{"type":"array","items":{"$ref":"#/components/schemas/RequisitionFamilyMember"},"nullable":true},"submitted_at":{"allOf":[{"$ref":"#/components/schemas/UTCTimestamp"}],"nullable":true},"referring_lab":{"allOf":[{"$ref":"#/components/schemas/Institution"}],"nullable":true},"institution":{"allOf":[{"$ref":"#/components/schemas/Institution"}],"nullable":true},"case_requisitions":{"type":"array","description":"A list of any connected requisitions for duo and trio products\n","items":{"$ref":"#/components/schemas/CaseRequisition"},"nullable":true},"fvt":{"allOf":[{"$ref":"#/components/schemas/FVTRequisitionDetails"}],"nullable":true},"external_status":{"allOf":[{"$ref":"#/components/schemas/ExternalOrderStatus"}],"nullable":true},"clinician_review_status":{"allOf":[{"$ref":"#/components/schemas/ClinicianReviewStatus"}],"nullable":true},"order_date":{"allOf":[{"$ref":"#/components/schemas/YMDDate"}],"nullable":true},"rerequisition_type":{"allOf":[{"$ref":"#/components/schemas/RerequisitionType"}],"nullable":true},"is_eligible_for_methylation_reanalysis":{"type":"boolean","description":"Whether this requisition is eligible for methylation reanalysis"}}},"example":[{"requisition_id":"RQ2000042","individual_id":"IN2000042","clinicians":[{"clinic_name":"Acme Health","contact_info":[{"address":{"city":"San Francisco","country":"US","postal_code":"12345","region":"CA","street_address":"123 Example Ln"},"email":"clinician@example.com","phone":"+1-415-555-1212"}],"name":{"first":"Zaphod","last":"Beeblebrox","credentials":"M.D."},"npi":"012345678","clinics":[{"name":"Acme Health","clinic_id":"CL12345","roles":["CLINICIAN"]}],"campaigns":[{"campaign_code":"ANVIL","name":"Anvil","description":"by Acme Health","is_active":true}]}],"consents_granted":["myome:consent:GENERAL-0.0.1","myome:consent:PR2019-0.0.1"],"orders":[{"order_id":"OR2000308","product_id":"PR-2019","product_name":"MyOme Personal Genome, Proactive Health, 81 Genes","report_type":"MONOGENIC","status":"ANALYZING","results":[{"finding":"POSITIVE","text":"A pathogenic variant was identified in the BRCA2 gene."}],"created_at":"2023-05-16T04:59:01.169271+00:00","reported_at":"2022-11-12T22:07:34.557423Z"}],"referring_lab":{"name":"Acme Referring Lab","clia_numbers":["19D0000000"],"contact_info":[{"phone":"555-123-4567"}]},"subject":{"demographics":{"sex":"MALE","dob":"1999-01-01"},"contact_info":[{"address":{"city":"San Francisco","country":"US","postal_code":"98765","region":"CA","street_address":"456 Open Rd"},"email":"patient@example.com","phone":"+1-415-555-9090"}],"name":{"first":"Ford","last":"Prefect"}},"submitted_at":"2023-05-15T04:59:01.169271+00:00","external_status":"COMPLETED","clinician_review_status":"COMPLETED","clinical_summary_letter":{"completed_on":"2026-01-21","description":"post_test_letter","mimetype":"application/pdf","uri":"https://example.myome.com/clinical-summary-letter.pdf"},"genetic_counseling":{"requisition_id":"RQ2000042","appointment_url":"https://appointment.dnavisit.com/example","access_code":"ABC123","external_status":"COMPLETED","service_type":"POST_TEST_COUNSELING","requested_on":"2026-01-15","completed_on":"2026-01-21","dnavisit_order_id":"DNAV-123"},"fvt":{"source_requisition":"RQ123","source_relationship":"PARENT","variants":[{"value":"1","display":"BTD NM_007294.4(BRCA1):c.5585A>G NP_009225.1:p.His1862Arg (Pathogenic)"}]}}]}}},"ShareHistoryListResponse":{"description":"A list of share history records","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Dr. Smith"},"email":{"type":"string","example":"test@example.com","nullable":true},"created_at":{"type":"string","format":"date-time","example":"2025-12-19T01:09:29.324Z","nullable":true},"is_up_to_date":{"type":"boolean","example":true,"nullable":true},"shared_identifiers":{"type":"array","items":{"type":"string"},"example":[],"nullable":true}}}},"example":[[{"name":"Dr. Smith","email":"test@example.com","created_at":"2025-12-19T01:09:29.324Z","is_up_to_date":true,"shared_identifiers":[]}]]}}},"ShareReportResponse":{"description":"Response for sharing a report","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Dr. Smith"},"email":{"type":"string","example":"test@example.com","nullable":true},"created_at":{"type":"string","format":"date-time","example":"2025-12-19T01:05:31.616000+00:00","nullable":true},"is_up_to_date":{"type":"boolean","example":true,"nullable":true},"shared_identifiers":{"type":"array","items":{"type":"string"},"example":[],"nullable":true}}},"example":[{"name":"Dr. Smith","email":"test@example.com","created_at":"2025-12-19T01:05:31.616000+00:00","is_up_to_date":true,"shared_identifiers":[]}]}}},"StructuredError":{"description":"Generic structured error message","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["title","detail"],"properties":{"title":{"type":"string"},"detail":{"type":"string"},"code":{"type":"string","description":"The type of error that occurred","nullable":true},"errors":{"type":"object","additionalProperties":true,"description":"Dictionary of field names and error messages","nullable":true},"extra":{"oneOf":[{"type":"object","additionalProperties":true},{"type":"string"}],"nullable":true}}},"examples":{"simple_error":{"value":{"detail":"There was an error validating the request","title":"Validation error"}},"flat_field_errors":{"value":{"code":"validation_error","detail":"Validation error","title":"Validation error","errors":{"field1":"field is required"}}},"nested_field_errors":{"value":{"code":"validation_error","detail":"Validation error","title":"Validation error","errors":{"field1":"field is required","field2":{"field3":"field is invalid"}}}},"no_field_errors":{"value":{"code":"validation_error","detail":"Validation error","title":"Validation error"}}}}}},"StructuredMessage":{"description":"Generic structured message","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["message"],"properties":{"message":{"type":"string"}}},"example":[{"message":"The operation was successful"}]}}},"StructuredSuccess":{"description":"Generic structured success message","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["success"],"properties":{"success":{"type":"string"}}},"example":[{"success":"The operation was successful"}]}}},"PatientPortalOrderingEligibilityResponse":{"description":"Response to a patient initiated testing eligibility request","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["is_eligible","campaign","pricing","products"],"properties":{"is_eligible":{"type":"boolean","description":"Whether the patient is eligible to order testing"},"campaign":{"allOf":[{"$ref":"#/components/schemas/PatientPortalCampaign"}],"description":"Patient testing campaign","nullable":true},"pricing":{"$ref":"#/components/schemas/PatientPortalPricing","description":"Pricing and discount details for the eligible products"},"products":{"type":"array","items":{"$ref":"#/components/schemas/PatientPortalOrderingProduct"},"description":"Products that are eligible for testing"}}},"example":[{"is_eligible":true,"campaign":{"campaign_code":"TEST_CAMPAIGN","name":"Test Campaign","description":"Campaign for testing","member":{"id":"1234ABCD","address":{"street_address":"123 Main St","city":"Anytown","region":"CA","postal_code":"90210","country":"US"}}},"pricing":{"payor_type":"INSTITUTIONAL","original_price_cents":10000,"price_cents":9000,"discount_cents":1000,"discount":"10%","promo_code":"TEST_PROMO"},"products":[{"product_id":"PR22020","name":"Atlas Select, Curated Screen\u2122, 84 Genes","product_family_name":"Atlas Select","product_test_name":"Curated Screen\u2122, 84 Genes","product_test_type":"Curated Screen\u2122","product_test_subclass":"84 Genes","description":"Single-gene risk screening panel covering 84 genes using BGE sequencing","requires_family_history":true}]}]}}},"PatientPortalOrderingPaymentIntentResponse":{"description":"Response to a Payment Intent request for patient initiated testing","content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["is_eligible","campaign","pricing","products","payment_intent"],"properties":{"is_eligible":{"type":"boolean","description":"Whether the patient is eligible to order testing"},"campaign":{"allOf":[{"$ref":"#/components/schemas/PatientPortalCampaign"}],"description":"Patient testing campaign","nullable":true},"pricing":{"$ref":"#/components/schemas/PatientPortalPricing","description":"Pricing and discount details for the eligible products"},"products":{"type":"array","items":{"$ref":"#/components/schemas/PatientPortalOrderingProduct"},"description":"Products that are eligible for testing"},"payment_intent":{"$ref":"#/components/schemas/PatientPortalPaymentIntent","description":"Payment intent identifiers that will be used for billing"}}},"example":[{"is_eligible":true,"campaign":{"campaign_code":"TEST_CAMPAIGN","name":"Test Campaign","description":"Campaign for testing","member":{"id":"1234ABCD","address":{"street_address":"123 Main St","city":"Anytown","region":"CA","postal_code":"90210","country":"US"}}},"pricing":{"payor_type":"INSTITUTIONAL","original_price_cents":10000,"price_cents":9000,"discount_cents":1000,"discount":"10%","promo_code":"TEST_PROMO"},"products":[{"product_id":"PR22020","name":"Atlas Select, Curated Screen\u2122, 84 Genes","product_family_name":"Atlas Select","product_test_name":"Curated Screen\u2122, 84 Genes","product_test_type":"Curated Screen\u2122","product_test_subclass":"84 Genes","description":"Single-gene risk screening panel covering 84 genes using BGE sequencing","requires_family_history":true}],"payment_intent":{"id":"pi_1234abcd","client_secret":"pi_1234abcd_secret_abc"}}]}}},"PatientPortalPartnershipDetailsResponse":{"description":"Details of a MyOme patient testing partnership","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatientPortalPartnership"},"example":[{"name":"Test Partnership","campaign_code":"TEST_PARTNERSHIP","logo_url":"https://example.myome.com/partnership-logo.png","products":[{"product_id":"PR22020","name":"Atlas Select, Curated Screen\u2122, 84 Genes","product_family_name":"Atlas Select","product_test_name":"Curated Screen\u2122, 84 Genes","product_test_type":"Curated Screen\u2122","product_test_subclass":"84 Genes","description":"Single-gene risk screening panel covering 84 genes using BGE sequencing","report_type":"MONOGENIC","sort_priority":1}]}]}}},"ProviderPortalUserProfileResponse":{"description":"User profile for the authenticated provider in the providers portal","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProviderPortalUserProfile"},"examples":{"clinician":{"value":{"provider_id":"CN123456","npi":"0123456789","hubspot_id_token":"abcde.12345","first_name":"John","last_name":"Doe","credentials":"M.D.","email":"john.doe@example.myome.com","phone":"628-555-1234","address":{"street_address":"123 Example Ave","city":"San Francisco","region":"CA","postal_code":"94025","country":"US"},"communication_preferences":{"results_email":true},"campaigns":[{"campaign_code":"TEST_CAMPAIGN","name":"Test Campaign","description":"Campaign for testing"}],"clinics":[{"clinic_id":"CL12345","name":"Acme Health","roles":["CLINICIAN"]}]}},"admin":{"value":{"provider_id":"CN123456","npi":"9876543210","hubspot_id_token":"abcde.12345","first_name":"Jane","last_name":"Doe","credentials":"M.D.","email":"jane.doe@example.myome.com","phone":"628-555-1234","address":{"street_address":"123 Example Ave","city":"San Francisco","region":"CA","postal_code":"94025","country":"US"},"communication_preferences":{"results_email":false},"campaigns":[],"clinics":[{"clinic_id":"CL12345","name":"Acme Health","roles":["ADMIN","CLINICIAN"]}]}}}}}}},"securitySchemes":{"jwt":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JSON Web Token (JWT) obtained from Keycloak.\n","x-bearerInfoFunc":"myome.api.support.auth.validate_kc_token"}},"schemas":{"BiologicalSex":{"description":"Sex assigned at birth","type":"string","enum":["FEMALE","MALE","OTHER"]},"BiologicalRelationshipExtended":{"description":"Relationship to an individual (e.g., family pedigree)","type":"string","enum":["PARENT","CHILD","SIBLING","FIRST_COUSIN","GRANDPARENT","GRANDCHILD","AUNT_UNCLE","NIECE_NEPHEW","HALF_SIBLING","OTHER"],"enumNames":["Parent","Child","Sibling","1st Cousin","Grandparent","Grandchild","Aunt/Uncle","Niece/Nephew","Half-Sibling","Other (up to 4th degree)"]},"BiologicalRelationship":{"description":"Relationship to an individual (e.g., family pedigree)","type":"string","enum":["PARENT","SIBLING"]},"BiologicalRelationshipWithReverse":{"description":"Relationship to an individual including reverse relationships","type":"string","enum":["PARENT","CHILD","SIBLING"]},"ClinicianReviewStatus":{"type":"string","enum":["PENDING","IN_REVIEW","COMPLETED","INELIGIBLE"]},"ExternalOrderStatus":{"type":"string","enum":["SUBMITTED","APPROVED","DENIED","AWAITING_SAMPLE","ANALYZING","REFERRAL_LAB_LD_REVIEW","CLINICIAN_REVIEW","COMPLETED","CANCELED","FAILED"]},"PostTestCounselingType":{"description":"","type":"string","enum":["NO_COUNSELING","ANY_RESULT","POSITIVE_RESULT","VUS_OR_POSITIVE_RESULT"],"enumNames":["No counseling","For any result","For a result with a finding","Unused"]},"PreferredReportDeliveryMethod":{"title":"Preferred Report Delivery Method","type":"string","enum":["FAX","EMAIL"]},"FaxVerificationStatus":{"type":"string","enum":["PARTNER_VERIFICATION"],"description":"Fax number verification status (partner-verified only in this API)."},"ExternalRequisitionStatus":{"type":"string","enum":["QUEUED","WAITING_FOR_SAMPLE","PROCESSING","SUCCEEDED","FAILED"]},"FamilyHistoryResponse":{"type":"string","description":"Response to a family history question","enum":["YES","NO","UNSURE"]},"FamilyHistoryItem":{"type":"object","description":"Family history question and response","required":["question_text","response"],"properties":{"question_text":{"type":"string","description":"Question about the patient's family history"},"response":{"$ref":"#/components/schemas/FamilyHistoryResponse","description":"Response to the question"}}},"FamilyHistory":{"type":"object","description":"Family History Questionnaire Answers\nFormat: {QNR_FHX_<_ID_>: {question_text: \"question?\", response:<YES|NO|UNSURE>}}\n"},"LabReferral":{"description":"true if the order is being placed by a referring lab","type":"boolean","enum":[true]},"OnboardingProvider":{"type":"object","additionalProperties":false,"required":["name"],"properties":{"name":{"$ref":"#/components/schemas/Name"},"role":{"allOf":[{"$ref":"#/components/schemas/ProviderRole"}],"nullable":true},"npi":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"fax":{"type":"string","nullable":true},"communication_preference_receives_welcome_email":{"type":"boolean","default":true},"communication_preference_receives_results_email":{"type":"boolean","default":true}}},"OrderStage":{"description":"Internal stage of an Order\n","type":"string","enum":["QUEUED","WAITING_FOR_DATA","ANALYZING","REPORTING","COMPLETED"]},"PhysicianOfRecord":{"description":"true if the order requires physcian of record services","type":"boolean","enum":[true]},"ProviderRole":{"type":"string","enum":["ORDERING_PROVIDER","GENETIC_COUNSELOR","CLINICAL_STAFF_MEMBER","CLINICAL_RESEARCHER","LAB_MANAGER","OTHER"]},"InsuranceStatus":{"type":"string","enum":["INSURED","NOT_INSURED"]},"OrganizationProviderRole":{"type":"string","enum":["ADMIN","DELEGATE","CLINICIAN"]},"PaymentStatus":{"type":"string","enum":["PENDING","CANCELED","SUCCEEDED","FREE"]},"PayorType":{"description":"Party responsible for payment of services","type":"string","enum":["INSTITUTIONAL","INSURANCE","SELF"]},"ReportType":{"type":"string","enum":["BASELINE_RISK","MONOGENIC","NDD_CNA","RARE_DISEASE","PGX","PRS","FAMILY_VARIANT_TESTING","DATA_ONLY","CLINICAL_RISK_ONLY","CANCELED"]},"RequisitionStage":{"description":"Internal stage of a Requisition\n","type":"string","enum":["PENDING_APPROVAL","DENIED","SUBMITTED","PROCESSING","WAITING_FOR_REFERRING_LAB_FINALIZATION","COMPLETED"]},"ToplineFinding":{"properties":{"finding":{"title":"Finding","anyOf":[{"$ref":"#/components/schemas/MonogenicToplineFinding"},{"$ref":"#/components/schemas/PRSToplineFinding"},{"$ref":"#/components/schemas/PGxImpactToplineFinding"},{"$ref":"#/components/schemas/RareDiseaseToplineFinding"}],"type":"string"},"text":{"title":"Text","type":"string"}},"required":["finding","text"]},"RequisitionToplineFinding":{"type":"string","enum":["POSITIVE","NEGATIVE","UNCERTAIN","HIGH_RISK","INTERMEDIATE_RISK","ELEVATED_RISK","BORDERLINE_RISK","AVERAGE_RISK","LOW_RISK","INCREASED_RISK","NOT_INCREASED_RISK","NOT_ANALYZED","MINIMAL_IMPACT","MAJOR_IMPACT","ALTERED_DOSE","CONTRAINDICATED"]},"RerequisitionType":{"type":"string","enum":["NEW_ORDER","REANALYSIS","METHYLATION_REFLEX"]},"SampleType":{"type":"string","title":"Sample Type","enum":["SALIVA","BLOOD","BUCCAL_SWAB","DNA","DATA","WATER","POSITIVE_CONTROL"]},"Status":{"description":"Generic status for objects.  Certain statuses may apply only to specific\nentities or specific  stages.\n","type":"string","enum":["OPEN","FAILED","SUCCESS","HOLD","CANCELED","INCOMPLETE","CONSUMED"]},"SortOrder":{"description":"Order in which results are sorted","type":"string","enum":["ascending","descending"],"default":"ascending"},"CampaignCode":{"type":"string","description":"Unique code identifying the testing campaign","minLength":1,"maxLength":64,"example":"TEST_CAMPAIGN"},"EmailAddress":{"type":"string","title":"Email Address","format":"email"},"NPI":{"type":"string","title":"NPI","pattern":"^\\d{9,10}$","examples":["012345678","0123456789"]},"PromoCode":{"type":"string","description":"Promotion code to use for campaign pricing","minLength":1,"maxLength":32},"StripePaymentIntentId":{"type":"string","description":"Promotion code to use for campaign pricing","pattern":"^pi_[a-zA-Z0-9]{8,32}$"},"UTCTimestamp":{"description":"UTC timestamp in ISO-8601 format. e.g., `2018-11-13T20:20:39+00:00`","type":"string","format":"date-time","pattern":"^[12]\\d{3}-[01]\\d-[0123]\\dT\\d{2}:\\d{2}:\\d{2}\\.?\\d*[+-Z](\\d{2}:\\d{2})?$","examples":["2018-11-13T20:20:39+00:00","2018-11-13T20:20:39.0123Z"]},"YMDDate":{"type":"string","pattern":"[12]\\d{3}-[01]\\d-[0123]\\d","example":"1999-12-31"},"NonNegativeInteger":{"type":"integer","minimum":0},"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},"Clinician":{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"Clinician","type":"object","required":["name","npi"],"properties":{"clinician_id":{"$ref":"#/components/schemas/ClinicianId"},"name":{"$ref":"#/components/schemas/Name"},"contact_info":{"type":"array","items":{"$ref":"#/components/schemas/ContactInfoOptional"},"maxItems":1},"clinic_name":{"type":"string"},"npi":{"$ref":"#/components/schemas/NPI"},"clinics":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["name","clinic_id"],"properties":{"name":{"type":"string"},"clinic_id":{"$ref":"#/components/schemas/ClinicId"},"roles":{"type":"array","items":{"$ref":"#/components/schemas/OrganizationProviderRole"}},"can_order":{"type":"boolean","description":"Provider can place a new order at this organization"}}}},"communication_preferences":{"type":"object"},"campaigns":{"type":"array","items":{"$ref":"#/components/schemas/Campaign"}},"license_status":{"$ref":"#/components/schemas/ProviderLicenseStatus"},"is_active":{"type":"boolean","description":"Whether the clinician is active (not archived and in_use)."}},"additionalProperties":false},"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},"Institution":{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"Institution","type":"object","required":["name"],"properties":{"name":{"type":"string","examples":["External Lab"]},"auth_sub":{"$ref":"#/components/schemas/UUID"},"contact_info":{"type":"array","items":{"type":"object","properties":{"phone":{"$ref":"#/components/schemas/PhoneNumber"}}},"maxItems":1},"clia_numbers":{"type":"array","items":{"$ref":"#/components/schemas/CLIANumber"}}},"additionalProperties":false},"Order":{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"Order","type":"object","properties":{"order_id":{"$ref":"#/components/schemas/OrderId"},"requisition_id":{"$ref":"#/components/schemas/RequisitionId"},"stage":{"$ref":"#/components/schemas/OrderStage"},"status":{"$ref":"#/components/schemas/Status"},"product_id":{"$ref":"#/components/schemas/ProductId"},"dataset_ids":{"type":"array","items":{"$ref":"#/components/schemas/DataSetId"}}}},"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"}}},"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"}]}}},"ClinicId":{"type":"string","pattern":"^CL-?([a-z]{3,5}-?)?\\d+$","examples":["CL-0123456","CL-dev-123456","CL0123456","CLdev123456"]},"ClinicianId":{"title":"Clinician ID","type":"string","pattern":"^CN-?([a-z]{3,5}-?)?\\d+$","examples":["CN-0123456","CN-dev-0123456","CN0123456","CNdev0123456"]},"ConsentUri":{"type":"string","pattern":"^myome:consent:[A-Z_0-9]+(-\\d+\\.\\d+\\.\\d+)?(-dev\\.\\d+)?$","examples":["myome:consent:GENERAL-0.1.4","myome:consent:PR2008-0.0.1","myome:consent:DNAVISIT","myome:consent:PRODUCT_NOTIFICATIONS-0.0.1","myome:consent:PR5004-0.0.1-dev.0","myome:consent:HIE_ACCESS__TREATMENT","myome:consent:CONTACT__RESEARCH_OPPORTUNITIES","myome:consent:CONTACT__TRANSACTIONAL_SMS","myome:consent:CONTACT__MARKETING"]},"DraftRequisitionId":{"type":"string","pattern":"^DR([a-z]{3,5})?\\d+$","examples":["DR0123456","DRdev0123456","DR0123456","DRdev0123456"]},"IndividualId":{"type":"string","pattern":"^IN-?([a-z]{3,5}-?)?\\d+$","examples":["IN-dev-123456","IN-123456","INdev123456","IN123456"]},"OrderId":{"type":"string","pattern":"^OR-?([a-z]{3,5}-?)?\\d+$","examples":["OR-0123456","OR-dev-0123456","OR0123456","ORdev0123456"]},"OrganizationId":{"type":"string","pattern":"^ORG?([a-z]{3,5}?)?\\d+$","examples":["ORGdev123456","ORG0123456"]},"ProductId":{"type":"string","description":"A reference to an ordered product.","pattern":"^PR-?\\d+$","examples":["PR-0123456","PR0123456"]},"RequisitionId":{"type":"string","pattern":"^RQ-?([a-z]{3,5}-?)?\\d+$","examples":["RQ-0123456","RQ-dev-0123456","RQ0123456","RQdev0123456"]},"SampleId":{"type":"string","pattern":"^SM-?([a-z]{3,5}-?)?[_\\d]+$","examples":["SM-0123456","SM-dev-0123456","SM0123456","SMdev0123456","SM123_1","SMdev123_1_2_3"]},"PatientPortalPartnershipProduct":{"type":"object","description":"Details of a product a partnership offers for testing","required":["product_id","name","description","report_type","sort_priority"],"additionalProperties":false,"properties":{"product_id":{"allOf":[{"$ref":"#/components/schemas/ProductId"}],"description":"Unique ID identifying the product"},"name":{"type":"string","description":"Name of the product"},"product_family_name":{"type":"string","description":"Product family portion of the structured product name","nullable":true},"product_test_name":{"type":"string","description":"Complete test-name portion of the structured product name","nullable":true},"product_test_type":{"type":"string","description":"Test type within the product family","nullable":true},"product_test_subclass":{"type":"string","description":"Optional qualifier within the product test type","nullable":true},"description":{"type":"string","description":"Short description of the product"},"report_type":{"allOf":[{"$ref":"#/components/schemas/ReportType"}],"description":"Type of report generated for the product"},"sort_priority":{"allOf":[{"$ref":"#/components/schemas/NonNegativeInteger"}],"description":"Priority when sorted with other products"}},"example":[{"product_id":"PR22020","name":"Atlas Select, Curated Screen\u2122, 84 Genes","product_family_name":"Atlas Select","product_test_name":"Curated Screen\u2122, 84 Genes","product_test_type":"Curated Screen\u2122","product_test_subclass":"84 Genes","description":"Single-gene risk screening panel covering 84 genes using BGE sequencing","report_type":"MONOGENIC","sort_priority":1}]},"PatientPortalProductDetails":{"type":"object","description":"Details of a product in the patient portal","required":["product_id","name","description","report_type","requires_family_history","sort_priority"],"additionalProperties":false,"properties":{"product_id":{"allOf":[{"$ref":"#/components/schemas/ProductId"}],"description":"Unique ID identifying the product"},"name":{"type":"string","description":"Name of the product"},"product_family_name":{"type":"string","description":"Product family portion of the structured product name","nullable":true},"product_test_name":{"type":"string","description":"Complete test-name portion of the structured product name","nullable":true},"product_test_type":{"type":"string","description":"Test type within the product family","nullable":true},"product_test_subclass":{"type":"string","description":"Optional qualifier within the product test type","nullable":true},"description":{"type":"string","description":"Short description of the product"},"report_type":{"allOf":[{"$ref":"#/components/schemas/ReportType"}],"description":"Type of report generated for the product"},"requires_family_history":{"type":"boolean","description":"Whether family history is required for the product"},"sort_priority":{"allOf":[{"$ref":"#/components/schemas/NonNegativeInteger"}],"description":"Priority when sorted with other products"}},"example":[{"product_id":"PR22020","name":"Atlas Select, Curated Screen\u2122, 84 Genes","product_family_name":"Atlas Select","product_test_name":"Curated Screen\u2122, 84 Genes","product_test_type":"Curated Screen\u2122","product_test_subclass":"84 Genes","description":"Single-gene risk screening panel covering 84 genes using BGE sequencing","report_type":"MONOGENIC","requires_family_history":true,"sort_priority":1}]},"PatientPortalOrderingProduct":{"type":"object","description":"Details of a product a patient is eligible to order","required":["product_id","name","description","requires_family_history"],"additionalProperties":false,"properties":{"product_id":{"allOf":[{"$ref":"#/components/schemas/ProductId"}],"description":"Unique ID identifying the product"},"name":{"type":"string","description":"Name of the product"},"product_family_name":{"type":"string","description":"Product family portion of the structured product name","nullable":true},"product_test_name":{"type":"string","description":"Complete test-name portion of the structured product name","nullable":true},"product_test_type":{"type":"string","description":"Test type within the product family","nullable":true},"product_test_subclass":{"type":"string","description":"Optional qualifier within the product test type","nullable":true},"description":{"type":"string","description":"Short description of the product"},"requires_family_history":{"type":"boolean","description":"Whether family history is required for the product"}},"example":[{"product_id":"PR22020","name":"Atlas Select, Curated Screen\u2122, 84 Genes","product_family_name":"Atlas Select","product_test_name":"Curated Screen\u2122, 84 Genes","product_test_type":"Curated Screen\u2122","product_test_subclass":"84 Genes","description":"Single-gene risk screening panel covering 84 genes using BGE sequencing","requires_family_history":true}]},"PatientPortalProductIds":{"type":"array","description":"Product codes specifying the desired tests or analyses.","items":{"$ref":"#/components/schemas/ProductId"},"minItems":1,"uniqueItems":true},"PatientProfile":{"allOf":[{"$ref":"#/components/schemas/SubjectOptionalAddress"},{"type":"object","properties":{"campaign":{"allOf":[{"$ref":"#/components/schemas/CampaignIndividual"}],"nullable":true},"fvt_referral_uuid":{"type":"string","format":"uuid","nullable":true},"family_profiles":{"type":"array","description":"Profiles whose results the caller may view (self plus minor wards). Guardians use these identifiers with the `individual` query parameter on requisition, order, and results endpoints.","items":{"type":"object","required":["identifier","first_name","last_name","is_self"],"properties":{"identifier":{"$ref":"#/components/schemas/IndividualId"},"first_name":{"type":"string"},"last_name":{"type":"string"},"is_self":{"type":"boolean"}}}}}}]},"PatientPortalPartnership":{"type":"object","description":"Details of the patient testing partnership","required":["name","campaign_code","logo_url","products"],"additionalProperties":false,"properties":{"name":{"type":"string","description":"Name of the partnership"},"campaign_code":{"allOf":[{"$ref":"#/components/schemas/CampaignCode"}],"description":"Unique code identifying the partnership campaign"},"logo_url":{"type":"string","description":"URL for the partnership's logo"},"products":{"type":"array","items":{"$ref":"#/components/schemas/PatientPortalPartnershipProduct"},"description":"Products that are eligible for testing"}}},"PatientPortalCampaignMember":{"type":"object","description":"Details about a member of a Campaign","required":["id","address"],"properties":{"id":{"type":"string","description":"Unique id of the member within the campaign","nullable":true},"address":{"allOf":[{"$ref":"#/components/schemas/Address"}],"description":"Address of the member provided by the campaign","nullable":true}}},"PatientPortalCampaign":{"type":"object","description":"Patient testing campaign","required":["campaign_code","name","description"],"properties":{"campaign_code":{"allOf":[{"$ref":"#/components/schemas/CampaignCode"}],"description":"Unique code identifying the campaign"},"name":{"type":"string","description":"Name of the campaign"},"description":{"type":"string","description":"Short description of the campaign"},"member":{"allOf":[{"$ref":"#/components/schemas/PatientPortalCampaignMember"}],"description":"Details about the campaign member","nullable":true}}},"PatientPortalPricing":{"type":"object","description":"Pricing and discount details for the eligible products","required":["payor_type","original_price_cents","price_cents","discount_cents","discount","promo_code"],"properties":{"payor_type":{"allOf":[{"$ref":"#/components/schemas/PayorType"}],"description":"Party responsible for payment of services"},"original_price_cents":{"allOf":[{"$ref":"#/components/schemas/NonNegativeInteger"}],"description":"Original price for testing, in cents"},"price_cents":{"allOf":[{"$ref":"#/components/schemas/NonNegativeInteger"}],"description":"Discounted price for testing, in cents"},"discount_cents":{"allOf":[{"$ref":"#/components/schemas/NonNegativeInteger"}],"description":"Discounted amount applied, in cents"},"discount":{"type":"string","description":"Discount being applied to the testing order","nullable":true},"promo_code":{"allOf":[{"$ref":"#/components/schemas/PromoCode"}],"description":"Discount code being applied to the testing order","nullable":true}}},"PatientPortalPaymentIntent":{"type":"object","description":"Payment intent identifiers that will be used for billing","required":["id","client_secret"],"properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StripePaymentIntentId"}],"description":"Unique ID of the payment intent"},"client_secret":{"type":"string","description":"Client verification secret of the payment intent"}}},"PatientPortalConsentsGranted":{"type":"array","description":"Consents asserted by the patient.","items":{"$ref":"#/components/schemas/ConsentUri"},"minItems":1,"uniqueItems":true},"PatientPortalFamilyHistory":{"type":"object","description":"Family history of the patient","additionalProperties":{"$ref":"#/components/schemas/FamilyHistoryItem"}},"PatientPortalOrderingSubjectForm":{"type":"object","description":"Demographic information of the patient being tested","required":["first_name","last_name","dob","sex","email","phone"],"properties":{"first_name":{"type":"string","description":"First name of the patient"},"last_name":{"type":"string","description":"Last name of the patient"},"dob":{"allOf":[{"$ref":"#/components/schemas/YMDDate"}],"description":"Date of birth of the patient"},"sex":{"allOf":[{"$ref":"#/components/schemas/BiologicalSex"}],"description":"Biological sex assigned to the patient at birth"},"email":{"allOf":[{"$ref":"#/components/schemas/EmailAddress"}],"description":"Primary email address of the patient. Not required for minors.","nullable":true},"phone":{"type":"string","description":"Primary phone number of the patient. Not required for minors.","nullable":true}}},"PatientPortalOrderingGuardianForm":{"type":"object","description":"Demographic information of the patient's guardian. Required when the subject is a minor.","additionalProperties":false,"required":["first_name","last_name","dob","email","phone","relationship"],"properties":{"first_name":{"type":"string","description":"Legal first name of the guardian.","minLength":1},"last_name":{"type":"string","description":"Legal last name of the guardian.","minLength":1},"dob":{"allOf":[{"$ref":"#/components/schemas/YMDDate"}],"description":"Date of birth of the guardian"},"email":{"allOf":[{"$ref":"#/components/schemas/EmailAddress"}],"description":"Primary email address of the guardian"},"phone":{"type":"string","description":"Primary phone number of the guardian","minLength":1},"relationship":{"type":"string","description":"Relationship of the guardian to the dependent.","minLength":1}}},"PatientPortalOrderingEligibilityForm":{"type":"object","additionalProperties":false,"required":["subject"],"properties":{"subject":{"$ref":"#/components/schemas/PatientPortalOrderingSubjectForm","description":"Demographic information of the patient being tested"},"campaign_code":{"allOf":[{"$ref":"#/components/schemas/CampaignCode"}],"description":"Unique code identifying the testing campaign","nullable":true},"promo_code":{"allOf":[{"$ref":"#/components/schemas/PromoCode"}],"description":"Promotion code to use for campaign pricing","nullable":true},"guardian":{"allOf":[{"$ref":"#/components/schemas/PatientPortalOrderingGuardianForm"}],"nullable":true,"description":"Guardian details. Required when the subject is a minor."}},"allOf":[{"anyOf":[{"properties":{"subject":{"required":["email","phone"],"properties":{"email":{"allOf":[{"$ref":"#/components/schemas/EmailAddress"}],"description":"Primary email address of the patient. Not required for minors."},"phone":{"type":"string","description":"Primary phone number of the patient. Not required for minors."}}}}},{"required":["guardian"],"properties":{"guardian":{"allOf":[{"$ref":"#/components/schemas/PatientPortalOrderingGuardianForm"}],"description":"Guardian details. Required when the subject is a minor."}}}]}]},"PatientPortalOrderingPaymentForm":{"type":"object","additionalProperties":false,"required":["subject","payment_intent_id"],"properties":{"subject":{"$ref":"#/components/schemas/PatientPortalOrderingSubjectForm","description":"Demographic information of the patient being tested"},"campaign_code":{"allOf":[{"$ref":"#/components/schemas/CampaignCode"}],"description":"Unique code identifying the testing campaign","nullable":true},"promo_code":{"allOf":[{"$ref":"#/components/schemas/PromoCode"}],"description":"Promotion code to use for campaign pricing","nullable":true},"guardian":{"allOf":[{"$ref":"#/components/schemas/PatientPortalOrderingGuardianForm"}],"nullable":true},"payment_intent_id":{"allOf":[{"$ref":"#/components/schemas/StripePaymentIntentId"}],"description":"Unique ID of an existing payment intent to use for billing","nullable":true}},"allOf":[{"anyOf":[{"properties":{"subject":{"required":["email","phone"],"properties":{"email":{"allOf":[{"$ref":"#/components/schemas/EmailAddress"}],"description":"Primary email address of the patient. Not required for minors."},"phone":{"type":"string","description":"Primary phone number of the patient. Not required for minors."}}}}},{"required":["guardian"],"properties":{"guardian":{"allOf":[{"$ref":"#/components/schemas/PatientPortalOrderingGuardianForm"}],"description":"Guardian details. Required when the subject is a minor."}}}]}]},"PatientPortalOrderingSubmitForm":{"type":"object","additionalProperties":false,"required":["subject","consents_granted","family_history","product_ids","shipping_address"],"properties":{"subject":{"$ref":"#/components/schemas/PatientPortalOrderingSubjectForm","description":"Demographic information of the patient being tested"},"campaign_code":{"allOf":[{"$ref":"#/components/schemas/CampaignCode"}],"description":"Unique code identifying the testing campaign","nullable":true},"promo_code":{"allOf":[{"$ref":"#/components/schemas/PromoCode"}],"description":"Promotion code to use for campaign pricing","nullable":true},"guardian":{"allOf":[{"$ref":"#/components/schemas/PatientPortalOrderingGuardianForm"}],"nullable":true,"description":"Guardian details. Required when the subject is a minor."},"payment_intent_id":{"allOf":[{"$ref":"#/components/schemas/StripePaymentIntentId"}],"description":"Unique ID of an existing payment intent to use for billing","nullable":true},"consents_granted":{"$ref":"#/components/schemas/PatientPortalConsentsGranted"},"family_history":{"$ref":"#/components/schemas/PatientPortalFamilyHistory","description":"Family history of the patient"},"product_ids":{"$ref":"#/components/schemas/PatientPortalProductIds"},"shipping_address":{"$ref":"#/components/schemas/Address","description":"Shipping address for sending testing kits"}},"allOf":[{"anyOf":[{"properties":{"subject":{"required":["email","phone"],"properties":{"email":{"allOf":[{"$ref":"#/components/schemas/EmailAddress"}],"description":"Primary email address of the patient. Not required for minors."},"phone":{"type":"string","description":"Primary phone number of the patient. Not required for minors."}}}}},{"required":["guardian"],"properties":{"guardian":{"allOf":[{"$ref":"#/components/schemas/PatientPortalOrderingGuardianForm"}],"description":"Guardian details. Required when the subject is a minor."}}}]}]},"PatientPortalOrderingSubmitResponse":{"description":"Response to submitting an order for patient-initiated testing","type":"object","additionalProperties":false,"required":["requisition_id"],"properties":{"requisition_id":{"allOf":[{"$ref":"#/components/schemas/RequisitionId"}],"description":"The ID of the newly created requisition"}},"example":{"requisition_id":"RQ123456"}},"PatientPortalRerequisitionEligibleDetails":{"description":"Eligible products and pricing for a new patient-initiated order","type":"object","additionalProperties":false,"required":["price_cents","products"],"properties":{"price_cents":{"type":"integer","minimum":0,"description":"Price of the new order in cents"},"products":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/PatientPortalProductDetails"}}},"example":{"price_cents":0,"products":[{"product_id":"PR22020","name":"Atlas Select, Curated Screen\u2122, 84 Genes","product_family_name":"Atlas Select","product_test_name":"Curated Screen\u2122, 84 Genes","product_test_type":"Curated Screen\u2122","product_test_subclass":"84 Genes","description":"Single-gene risk screening panel covering 84 genes using BGE sequencing","report_type":"MONOGENIC","requires_family_history":true,"sort_priority":1}]}},"PatientPortalRerequisitionEligibilityResponse":{"description":"Eligibility details for a new patient-initiated order. `new_order` is required when eligible and null when ineligible.","oneOf":[{"type":"object","additionalProperties":false,"required":["is_eligible","new_order"],"properties":{"is_eligible":{"type":"boolean","enum":[false]},"new_order":{"nullable":true,"enum":[null]}}},{"type":"object","additionalProperties":false,"required":["is_eligible","new_order"],"properties":{"is_eligible":{"type":"boolean","enum":[true]},"new_order":{"$ref":"#/components/schemas/PatientPortalRerequisitionEligibleDetails"}}}]},"PatientPortalRerequisitionSubmitForm":{"description":"Form data for submitting a rerequisition order","type":"object","additionalProperties":false,"required":["consents_granted","family_history","payment_intent_id","product_ids"],"properties":{"product_ids":{"$ref":"#/components/schemas/PatientPortalProductIds"},"consents_granted":{"$ref":"#/components/schemas/PatientPortalConsentsGranted"},"family_history":{"allOf":[{"$ref":"#/components/schemas/PatientPortalFamilyHistory"}],"description":"Family history of the patient","nullable":true},"payment_intent_id":{"allOf":[{"$ref":"#/components/schemas/StripePaymentIntentId"}],"description":"Unique ID of the payment intent to use for billing","nullable":true},"individual":{"allOf":[{"$ref":"#/components/schemas/IndividualId"}],"description":"Unique ID of the dependent being tested","nullable":true}}},"PatientPortalFVTReferralEligibility":{"type":"object","description":"Required HCP attestations for an FVT proband referral.","additionalProperties":false,"required":["is_us_resident","has_detected_variant"],"properties":{"is_us_resident":{"type":"boolean","description":"Whether the patient lives in the United States."},"has_detected_variant":{"type":"boolean","description":"Whether a clinical genetic testing report identified a CASR gene variant."}},"example":{"is_us_resident":true,"has_detected_variant":true}},"PatientPortalFVTReferralClinicalHistory":{"type":"object","description":"Optional clinical-history answers for an FVT HCP referral. Omitted keys or null mean the HCP skipped the question.","additionalProperties":false,"properties":{"low_blood_calcium":{"type":"boolean","nullable":true,"description":"History of low blood calcium."},"elevated_urine_calcium":{"type":"boolean","nullable":true,"description":"History of elevated urine calcium."},"adh1_symptoms":{"type":"boolean","nullable":true,"description":"Signs or symptoms consistent with ADH1."},"adh1_diagnosis":{"type":"boolean","nullable":true,"description":"Clinical diagnosis of ADH1."}},"example":{"low_blood_calcium":true,"elevated_urine_calcium":false,"adh1_symptoms":null,"adh1_diagnosis":null}},"PatientPortalFVTReferralFamilyMemberInvitationGuardian":{"type":"object","description":"Guardian of the minor family member being invited to participate in family variant testing.","additionalProperties":false,"required":["email","first_name","last_name","relationship"],"properties":{"email":{"allOf":[{"$ref":"#/components/schemas/EmailAddress"}],"description":"Email address of the guardian."},"first_name":{"type":"string","description":"Legal first name of the guardian.","minLength":1},"last_name":{"type":"string","description":"Legal last name of the guardian.","minLength":1},"relationship":{"type":"string","description":"Relationship of the guardian to the dependent.","minLength":1}},"example":{"email":"guardian@example.myome.com","first_name":"Peter","last_name":"Smith","relationship":"Guardian relationship"}},"PatientPortalFVTReferralFamilyMemberInvitation":{"type":"object","description":"Family member being invited to participate in family variant testing.","additionalProperties":false,"required":["email","first_name","last_name","dob","sex","relationship"],"properties":{"email":{"allOf":[{"$ref":"#/components/schemas/EmailAddress"}],"description":"Email address of the family member. Not required for minors.","nullable":true},"first_name":{"type":"string","description":"Legal first name of the family member.","minLength":1},"last_name":{"type":"string","description":"Legal last name of the family member.","minLength":1},"dob":{"allOf":[{"$ref":"#/components/schemas/YMDDate"}],"description":"Date of birth of the family member."},"sex":{"allOf":[{"$ref":"#/components/schemas/BiologicalSex"}],"description":"Biological sex assigned to the family member at birth."},"relationship":{"allOf":[{"$ref":"#/components/schemas/BiologicalRelationshipExtended"}],"description":"Relationship of the family member to the referring individual."},"guardian":{"allOf":[{"$ref":"#/components/schemas/PatientPortalFVTReferralFamilyMemberInvitationGuardian"}],"nullable":true,"description":"Information for the guardian of the family member. Required when the family member is a minor."}},"allOf":[{"anyOf":[{"required":["email"],"properties":{"email":{"allOf":[{"$ref":"#/components/schemas/EmailAddress"}],"description":"Email address of the family member. Not required for minors."}}},{"required":["guardian"],"properties":{"guardian":{"allOf":[{"$ref":"#/components/schemas/PatientPortalFVTReferralFamilyMemberInvitationGuardian"}],"description":"Information for the guardian of the family member. Required when the family member is a minor."}}}]}]},"PatientPortalFVTReferralFamilyMemberGuardianDetails":{"type":"object","description":"Guardian of the minor family member being invited to participate in family variant testing.","additionalProperties":false,"required":["uuid","email","first_name","last_name","relationship"],"properties":{"uuid":{"type":"string","format":"uuid","description":"Unique ID of the guardian."},"email":{"allOf":[{"$ref":"#/components/schemas/EmailAddress"}],"description":"Email address of the guardian."},"first_name":{"type":"string","description":"Legal first name of the guardian.","minLength":1},"last_name":{"type":"string","description":"Legal last name of the guardian.","minLength":1},"relationship":{"type":"string","description":"Relationship of the guardian to the family member.","minLength":1}},"example":{"uuid":"123e4567-e89b-12d3-a456-426614174000","email":"guardian@example.myome.com","first_name":"Peter","last_name":"Smith","relationship":"Guardian relationship"}},"PatientPortalFVTReferralFamilyMemberDetails":{"type":"object","description":"Details of a family member invited to participate in family variant testing. Age is only validated downstream, after schema validation.","additionalProperties":false,"required":["uuid","email","first_name","last_name","dob","sex","relationship","invited_at","guardian"],"properties":{"uuid":{"type":"string","format":"uuid","description":"Unique ID of the family member."},"email":{"allOf":[{"$ref":"#/components/schemas/EmailAddress"}],"description":"Email address of the family member. Null for minors, who are contacted through their guardian.","nullable":true},"first_name":{"type":"string","description":"First name of the family member"},"last_name":{"type":"string","description":"Last name of the family member"},"dob":{"allOf":[{"$ref":"#/components/schemas/YMDDate"}],"description":"Date of birth of the family member"},"sex":{"allOf":[{"$ref":"#/components/schemas/BiologicalSex"}],"description":"Biological sex assigned to the family member at birth."},"relationship":{"allOf":[{"$ref":"#/components/schemas/BiologicalRelationshipExtended"}],"description":"Relationship of the family member to the referring individual."},"invited_at":{"allOf":[{"$ref":"#/components/schemas/UTCTimestamp"}],"description":"Timestamp when the family member was invited."},"guardian":{"allOf":[{"$ref":"#/components/schemas/PatientPortalFVTReferralFamilyMemberGuardianDetails"}],"description":"Guardian of the family member. Null for adults, who have no guardian.","nullable":true}},"example":{"uuid":"123e4567-e89b-12d3-a456-426614174000","email":"jane.doe@example.myome.com","first_name":"Jane","last_name":"Doe","dob":"2005-11-23","sex":"FEMALE","relationship":"CHILD","invited_at":"2026-07-20T12:00:00Z","guardian":null}},"PatientPortalFVTReferrer":{"type":"object","description":"Person who referred the individual for family variant testing.","additionalProperties":false,"required":["first_name","last_name"],"properties":{"first_name":{"type":"string","description":"First name of the referrer","nullable":true},"last_name":{"type":"string","description":"Last name of the referrer","nullable":true}}},"PatientPortalFVTReferralDetails":{"type":"object","description":"Details of a family variant testing referral","additionalProperties":false,"required":["uuid","submitted_at","is_proband","family_members","referred_by"],"properties":{"uuid":{"type":"string","format":"uuid","description":"Unique ID identifying the referring individual."},"submitted_at":{"allOf":[{"$ref":"#/components/schemas/UTCTimestamp"}],"description":"Timestamp when the referral was submitted."},"is_proband":{"type":"boolean","description":"Whether the individual is the proband of the family."},"family_members":{"type":"array","items":{"$ref":"#/components/schemas/PatientPortalFVTReferralFamilyMemberDetails"},"description":"Family members this individual has invited to participate in family variant testing."},"referred_by":{"allOf":[{"$ref":"#/components/schemas/PatientPortalFVTReferrer"}],"description":"Person who referred the individual for family variant testing.","nullable":true}},"example":{"uuid":"8ab824d6-5e3c-480a-9dc5-2c3589ffed0b","submitted_at":"2026-05-20T12:00:00Z","is_proband":false,"family_members":[{"uuid":"f41cdefa-40ce-4615-b056-c7261e558177","email":"jane.doe@example.myome.com","first_name":"Jane","last_name":"Doe","dob":"2005-11-23","sex":"FEMALE","relationship":"SIBLING","invited_at":"2026-07-13T12:00:00Z","guardian":null}],"referred_by":{"first_name":"Peter","last_name":"Smith"}}},"ProviderMemberCampaign":{"type":"object","description":"Partial details of a campaign associated with a provider","required":["campaign_code","name","description"],"properties":{"campaign_code":{"$ref":"#/components/schemas/CampaignCode","description":"Unique code identifying the campaign"},"name":{"type":"string","description":"Name of the campaign"},"description":{"type":"string","description":"Short description of the campaign"}}},"ProviderMemberClinic":{"type":"object","description":"Partial details of a clinic associated with a provider","required":["clinic_id","name","roles"],"properties":{"clinic_id":{"$ref":"#/components/schemas/ClinicId","description":"Unique ID identifying the clinic"},"name":{"type":"string","description":"Name of the clinic"},"roles":{"type":"array","items":{"$ref":"#/components/schemas/OrganizationProviderRole"},"description":"Roles of the provider in the clinic"}}},"ProviderCommunicationPreferences":{"type":"object","description":"Communication preferences for the provider","required":["results_email"],"properties":{"results_email":{"type":"boolean","description":"Whether the provider wants to receive results by email"}}},"ProviderPortalUserProfile":{"description":"User profile for the authenticated provider in the providers portal","type":"object","required":["provider_id","npi","first_name","last_name","credentials","email","phone","address","communication_preferences","campaigns","clinics"],"properties":{"provider_id":{"$ref":"#/components/schemas/ClinicianId","description":"Unique ID identifying the provider"},"npi":{"$ref":"#/components/schemas/NPI","description":"National Provider Identifier (NPI) of the provider"},"hubspot_id_token":{"type":"string","description":"Hubspot identification token","nullable":true},"first_name":{"type":"string","description":"First name of the provider"},"last_name":{"type":"string","description":"Last name of the provider"},"credentials":{"type":"string","description":"Credentials of the provider","nullable":true},"email":{"$ref":"#/components/schemas/EmailAddress","description":"Primary email address of the provider"},"phone":{"type":"string","description":"Primary phone number of the provider"},"address":{"description":"Physical address of the provider","nullable":true,"allOf":[{"$ref":"#/components/schemas/Address"}]},"communication_preferences":{"$ref":"#/components/schemas/ProviderCommunicationPreferences","description":"Communication preferences for the provider"},"campaigns":{"type":"array","description":"Campaigns the provider is associated with","items":{"$ref":"#/components/schemas/ProviderMemberCampaign"}},"clinics":{"type":"array","description":"Clinics the provider is associated with","items":{"$ref":"#/components/schemas/ProviderMemberClinic"}}}},"ProviderPortalIndividualRerequisitionEligibility":{"type":"object","description":"Rerequisition eligibility details for an individual","required":["original_requisition_id","new_order_products","reanalysis_products"],"properties":{"original_requisition_id":{"description":"The original requisition ID to use for rerequisitions","$ref":"#/components/schemas/RequisitionId"},"new_order_products":{"description":"Products eligible to rerequisition as a new order","type":"array","items":{"$ref":"#/components/schemas/Product"}},"reanalysis_products":{"description":"Products eligible to rerequisition as for reanalysis","type":"array","items":{"$ref":"#/components/schemas/Product"}},"methylation_reflex_products":{"description":"Products eligible for methylation reflex ordering","type":"array","items":{"$ref":"#/components/schemas/Product"}},"campaign":{"description":"Campaign that is associated with the original requisition","nullable":true,"allOf":[{"$ref":"#/components/schemas/Campaign"}]},"campaign_products":{"description":"Campaign products eligible to rerequisition as a new order","nullable":true,"type":"array","items":{"$ref":"#/components/schemas/Product"}}}},"Address":{"type":"object","additionalProperties":false,"properties":{"street_address":{"type":"string","title":"Street Address","description":"Number and street"},"street_address_2":{"type":["string","null"],"title":"Street Address Line 2"},"city":{"type":"string","title":"City"},"region":{"type":"string","title":"Region","description":"State, province, or other country-specific region"},"postal_code":{"type":"string","title":"Postal Code","description":"Country-specific code for geographic districts"},"country":{"type":["string","null"],"title":"Country","description":"Country name or abbreviation"}},"required":["street_address","city","region","postal_code"],"examples":[{"street_address":"930 Brittan Ave","city":"San Carlos","region":"CA","postal_code":"94070","country":"US"}]},"AddressOptional":{"type":"object","additionalProperties":false,"properties":{"street_address":{"type":["string","null"],"title":"Street Address","description":"Number and street"},"street_address_2":{"type":["string","null"],"title":"Street Address Line 2"},"city":{"type":["string","null"],"title":"City"},"region":{"type":["string","null"],"title":"Region","description":"State, province, or other country-specific region"},"postal_code":{"type":["string","null"],"title":"Postal Code","description":"Country-specific code for geographic districts"},"country":{"type":["string","null"],"title":"Country","description":"Country name or abbreviation"}},"examples":[{"street_address":"930 Brittan Ave","city":"San Carlos","region":"CA","postal_code":"94070","country":"US"}]},"CampaignIndividual":{"type":"object","required":["campaign_code","name","is_active"],"properties":{"campaign_code":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"logo_url":{"type":"string","description":"URL for the partnership's logo","nullable":true},"is_active":{"type":"boolean"},"external_member_id":{"type":"string","nullable":true}}},"Clinicians":{"description":"Clinicians associated with this test.\n\nThere must be at least one clinician.  The first clinician is the primary ordering\nclinician and will be the point of contact for any inquiries.\n","type":"array","minLength":1,"items":{"$ref":"#/components/schemas/Clinician"}},"Consent":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/ConsentType"},"protocol_id":{"type":"string"}}},"ContactInfo":{"type":"object","additionalProperties":false,"properties":{"address":{"title":"Address","$ref":"#/components/schemas/Address"},"email":{"$ref":"#/components/schemas/EmailAddress"},"phone":{"type":"string","title":"Phone Number"},"fax":{"type":["string","null"],"title":"Fax Number"}}},"File":{"type":"object","required":["uri","mimetype"],"properties":{"uri":{"type":"string"},"mimetype":{"type":"string"},"description":{"type":"string"},"sha512":{"type":"string","pattern":"^[0-9a-fA-F]{128}$"},"crc64nvme":{"type":"string","pattern":"^[A-Za-z0-9+/_-]{11}=$"},"sha256":{"type":"string","pattern":"^[0-9a-fA-F]{64}$"}},"examples":[{"uri":"s3://somebucket/path/to/report.json","description":"Report in JSON format","mimetype":"application/json","sha512":"1b3c34b32bba4ece72a7b9a1ee53359fe7238be5986984463b5da41baf3b53bce66c87d7f5557021c553a1bbeac175eac2b4923329b993fba11a93502c256912"},{"uri":"s3://somebucket/path/to/report.pdf","description":"Report in PDF format","mimetype":"application/pdf","sha512":"cf83e1357eefb8bdf1542850d66d8007d620e4050b5715dc83f4a921d36ce9ce47d0d13c5d85f2b0ff8318d2877eec2f63b931bd47417a81a538327af927da3e"},{"uri":"s3://somebucket/path/to/SM123.R1.fastq.gz","description":"R1 FastQ file","mimetype":"application/x.seq-na-fastq;type=paired_end;direction=R1","sha512":"3ef109fe55e194a0f37b5936405dcf2b96ce7eeb8891d59650c708d26f256d018fd8f98c6efb7da8f85029a3708e34f86a54e700ba3b36fb0967aa869ed37915"}]},"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."}]},"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"}]}},"RequisitionBilling":{"oneOf":[{"$ref":"#/components/schemas/BillingSelf"},{"$ref":"#/components/schemas/BillingInsurance"},{"$ref":"#/components/schemas/BillingInstitutional"}]},"RequisitionConsentGrant":{"type":"object","additionalProperties":false,"required":["consent_uri","name","granted_on"],"properties":{"consent_uri":{"$ref":"#/components/schemas/ConsentUri"},"name":{"type":"string"},"granted_on":{"$ref":"#/components/schemas/YMDDate"},"valid_until":{"$ref":"#/components/schemas/YMDDate"}}},"RequisitionOrderObservation":{"type":"object","additionalProperties":false,"required":["observation_type","value"],"properties":{"observation_type":{"type":"string"},"value":{"oneOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"array","items":{}},{"type":"object","additionalProperties":true}],"nullable":true}}},"RequisitionGuardian":{"type":"object","additionalProperties":false,"properties":{"name":{"$ref":"#/components/schemas/Name"},"relationship_to_patient":{"type":"string"}}},"RequisitionSampleRequest":{"type":"object","additionalProperties":false,"properties":{"type":{"$ref":"#/components/schemas/SampleType"},"send_kit":{"type":"boolean"},"send_kit_address":{"$ref":"#/components/schemas/ContactInfo"}}},"RequisitionFamilyMember":{"type":"object","additionalProperties":false,"properties":{"requisition_id":{"$ref":"#/components/schemas/RequisitionId"},"relationship_to_proband":{"$ref":"#/components/schemas/BiologicalRelationship"},"subject":{"allOf":[{"$ref":"#/components/schemas/SubjectOptionalAddress"},{"type":"object","properties":{"ancestry":{"type":"array","items":{"type":"string"},"nullable":true}}}]},"remote_mrn":{"type":"string","nullable":true},"sample_request":{"$ref":"#/components/schemas/RequisitionSampleRequest"},"secondary_findings_opt_out":{"type":"boolean","nullable":true},"affected_status":{"type":"string","enum":["AFFECTED","NOT_AFFECTED"],"nullable":true},"clinical_phenotype":{"type":"string","nullable":true},"order_observations":{"type":"array","items":{"$ref":"#/components/schemas/RequisitionOrderObservation"}}}},"Product":{"type":"object","required":["product_id"],"properties":{"description":{"type":"string","description":"Description of analysis product","nullable":true},"name":{"type":"string","description":"Short analysis product name","nullable":true},"product_family_name":{"type":"string","description":"Product family portion of the structured product name","nullable":true},"product_test_name":{"type":"string","description":"Complete test-name portion of the structured product name","nullable":true},"product_test_type":{"type":"string","description":"Test type within the product family","nullable":true},"product_test_subclass":{"type":"string","description":"Optional qualifier within the product test type","nullable":true},"product_id":{"$ref":"#/components/schemas/ProductId"}}},"ProductDataPR41003":{"type":"object","title":"Inputs for IPRS Breast Cancer","description":"Additional data needed for iPRS Breast Cancer","additionalProperties":false,"properties":{"diagnosed_with_breast_cancer":{"$ref":"#/components/schemas/diagnosed_with_breast_cancer"},"weight":{"$ref":"#/components/schemas/weight"},"height":{"$ref":"#/components/schemas/height"},"ashkenazi_jewish":{"$ref":"#/components/schemas/ashkenazi_jewish"},"tyrer_cuzick_inputs":{"$ref":"#/components/schemas/tyrer_cuzick_inputs"}}},"ProductDataPR42009":{"$ref":"#/components/schemas/ProductDataPR41003"},"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"}}},"RequisitionOrderDetails":{"type":"object","properties":{"order_id":{"allOf":[{"$ref":"#/components/schemas/OrderId"}],"nullable":true},"product_id":{"allOf":[{"$ref":"#/components/schemas/ProductId"}],"nullable":true},"product_name":{"type":"string","nullable":true},"product_family_name":{"type":"string","nullable":true},"product_test_name":{"type":"string","nullable":true},"product_test_type":{"type":"string","nullable":true},"product_test_subclass":{"type":"string","nullable":true},"report_type":{"allOf":[{"$ref":"#/components/schemas/ReportType"}],"nullable":true},"created_at":{"allOf":[{"$ref":"#/components/schemas/YMDDate"}],"nullable":true},"reported_at":{"allOf":[{"$ref":"#/components/schemas/YMDDate"}],"nullable":true},"status":{"allOf":[{"$ref":"#/components/schemas/ExternalOrderStatus"}],"nullable":true},"results":{"type":"array","items":{"$ref":"#/components/schemas/ToplineFinding"},"nullable":true}}},"FVTRequisitionDetails":{"type":"object","additionalProperties":false,"properties":{"source_requisition":{"type":"string","description":"The identifier of the source requisition for FVT orders.\n","nullable":true},"source_relationship":{"type":"string","description":"The relationship of the source requisition to the current requisition.\n","nullable":true},"variants":{"type":"array","items":{"type":"object","properties":{"enum":{"type":"string","description":"The enum value of the variant.\n","nullable":true},"title":{"type":"string","description":"The display value of the variant.\n","nullable":true}}},"nullable":true}}},"CaseRequisition":{"type":"object","properties":{"requisition_id":{"allOf":[{"$ref":"#/components/schemas/RequisitionId"}],"nullable":true},"name":{"allOf":[{"$ref":"#/components/schemas/Name"}],"nullable":true},"individual_id":{"allOf":[{"$ref":"#/components/schemas/IndividualId"}],"nullable":true},"sample_received_at":{"allOf":[{"$ref":"#/components/schemas/YMDDate"}],"nullable":true},"relationship":{"allOf":[{"$ref":"#/components/schemas/BiologicalRelationshipWithReverse"}],"nullable":true},"is_primary_requisition":{"type":"boolean","nullable":true},"orders":{"type":"array","items":{"$ref":"#/components/schemas/RequisitionOrderDetails"},"nullable":true}}},"Clinic":{"type":"object","required":["clinic_id","name","department"],"properties":{"clinic_id":{"$ref":"#/components/schemas/ClinicId"},"name":{"type":"string"},"department":{"type":"string"}}},"ClinicDetails":{"type":"object","additionalProperties":false,"required":["clinic_id","name","is_fax_enabled","fax_number_verified"],"properties":{"clinic_id":{"$ref":"#/components/schemas/ClinicId"},"name":{"type":"string"},"phone":{"type":"string","nullable":true},"fax":{"type":"string","nullable":true},"is_fax_enabled":{"type":"boolean"},"fax_number_verified":{"type":"boolean"},"address":{"allOf":[{"$ref":"#/components/schemas/AddressOptional"}],"nullable":true}}},"DraftRequisition":{"type":"object","additionalProperties":false,"required":["identifier","name","created_at","updated_at","created_by","ordering_provider","ordering_clinic","formdata","status"],"properties":{"identifier":{"$ref":"#/components/schemas/DraftRequisitionId"},"name":{"type":"string"},"formdata":{"type":"object","additionalProperties":true},"updated_at":{"$ref":"#/components/schemas/UTCTimestamp"},"created_at":{"$ref":"#/components/schemas/UTCTimestamp"},"created_by":{"$ref":"#/components/schemas/Clinician"},"ordering_provider":{"$ref":"#/components/schemas/Clinician"},"ordering_clinic":{"$ref":"#/components/schemas/Clinic"},"rerequisition_from":{"$ref":"#/components/schemas/RequisitionId"},"rerequisition_type":{"$ref":"#/components/schemas/RerequisitionType"},"created_requisition":{"allOf":[{"$ref":"#/components/schemas/RequisitionId"}],"nullable":true},"created_requisition_patient_identifier":{"allOf":[{"$ref":"#/components/schemas/IndividualId"}],"nullable":true},"created_requisition_at":{"allOf":[{"$ref":"#/components/schemas/UTCTimestamp"}],"nullable":true},"created_requisition_by":{"allOf":[{"$ref":"#/components/schemas/Clinician"}],"nullable":true},"deleted_at":{"allOf":[{"$ref":"#/components/schemas/UTCTimestamp"}],"nullable":true},"deleted_by":{"allOf":[{"$ref":"#/components/schemas/Clinician"}],"nullable":true},"status":{"type":"string","enum":["ACTIVE","COMPLETED","DELETED"]}}},"ClinicalSummaryLetter":{"type":"object","description":"\"Clinical summary letter provided by physician of record. Only relevant if physician of record services were requested.\"\n","properties":{"completed_on":{"allOf":[{"$ref":"#/components/schemas/YMDDate"}],"nullable":true},"description":{"type":"string","nullable":true},"mimetype":{"type":"string","nullable":true},"uri":{"type":"string","nullable":true}}},"RequisitionListItem":{"type":"object","additionalProperties":false,"required":["requisition_id"],"properties":{"requisition_id":{"$ref":"#/components/schemas/RequisitionId"},"name":{"allOf":[{"$ref":"#/components/schemas/Name"}],"nullable":true},"individual_id":{"allOf":[{"$ref":"#/components/schemas/IndividualId"}],"nullable":true},"submitted_at":{"allOf":[{"$ref":"#/components/schemas/UTCTimestamp"}],"nullable":true},"updated_at":{"allOf":[{"$ref":"#/components/schemas/UTCTimestamp"}],"nullable":true},"order_date":{"allOf":[{"$ref":"#/components/schemas/YMDDate"}],"nullable":true},"sample_received_at":{"allOf":[{"$ref":"#/components/schemas/YMDDate"}],"nullable":true},"clinicians":{"type":"array","items":{"$ref":"#/components/schemas/Clinician"},"nullable":true},"external_mrn":{"type":"string","nullable":true},"first_reported_at":{"allOf":[{"$ref":"#/components/schemas/YMDDate"}],"description":"Date the first report was released to provider","nullable":true},"clinical_summary_letter_ready_at":{"allOf":[{"$ref":"#/components/schemas/YMDDate"}],"description":"Date the first clinical summary letter was completed","nullable":true},"orders":{"type":"array","items":{"$ref":"#/components/schemas/RequisitionOrderDetails"},"nullable":true},"clinical_summary_letter":{"allOf":[{"$ref":"#/components/schemas/ClinicalSummaryLetter"}],"nullable":true},"fvt":{"allOf":[{"$ref":"#/components/schemas/FVTRequisitionDetails"}],"nullable":true},"case_requisitions":{"type":"array","description":"A list of any connected requisitions for duo and trio products\n","items":{"$ref":"#/components/schemas/CaseRequisition"},"nullable":true},"external_status":{"allOf":[{"$ref":"#/components/schemas/ExternalOrderStatus"}],"nullable":true},"clinician_review_status":{"allOf":[{"$ref":"#/components/schemas/ClinicianReviewStatus"}],"nullable":true},"rerequisition_type":{"allOf":[{"$ref":"#/components/schemas/RerequisitionType"}],"nullable":true}}},"RequisitionListResultItem":{"type":"object","additionalProperties":false,"required":["individual_id","requisition_id","name","order_date","submitted_at","updated_at","orders"],"properties":{"requisition_id":{"$ref":"#/components/schemas/RequisitionId"},"individual_id":{"$ref":"#/components/schemas/IndividualId"},"external_mrn":{"type":"string","nullable":true},"name":{"$ref":"#/components/schemas/Name"},"clinician_review_status":{"allOf":[{"$ref":"#/components/schemas/ClinicianReviewStatus"}],"nullable":true},"external_status":{"allOf":[{"$ref":"#/components/schemas/ExternalOrderStatus"}],"nullable":true},"order_date":{"$ref":"#/components/schemas/YMDDate"},"sample_received_at":{"allOf":[{"$ref":"#/components/schemas/YMDDate"}],"nullable":true},"submitted_at":{"$ref":"#/components/schemas/UTCTimestamp"},"updated_at":{"$ref":"#/components/schemas/UTCTimestamp"},"first_reported_at":{"allOf":[{"$ref":"#/components/schemas/YMDDate"}],"description":"Date the first report was released to provider","nullable":true},"clinical_summary_letter_ready_at":{"allOf":[{"$ref":"#/components/schemas/YMDDate"}],"description":"Date the first clinical summary letter was completed","nullable":true},"clinical_summary_letter":{"allOf":[{"$ref":"#/components/schemas/ClinicalSummaryLetter"}],"nullable":true},"ordering_provider":{"allOf":[{"$ref":"#/components/schemas/Clinician"}],"nullable":true},"rerequisition_type":{"allOf":[{"$ref":"#/components/schemas/RerequisitionType"}],"nullable":true},"clinicians":{"type":"array","items":{"$ref":"#/components/schemas/Clinician"},"nullable":true},"orders":{"type":"array","items":{"$ref":"#/components/schemas/RequisitionOrderDetails"}}}},"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"}}},"ProductDataPR42014":{"$ref":"#/components/schemas/ProductDataPR41016"},"ProductDataPR41027":{"type":"object","title":"Inputs for IPRS T2D","additionalProperties":false,"required":["smoking","glucose","triglyceride","cholesterol","blood_pressure","diabetes_family_history","body_mass_index","waist_circumference"],"properties":{"diabetes":{"$ref":"#/components/schemas/diabetes"},"smoking":{"$ref":"#/components/schemas/smoking"},"cholesterol":{"$ref":"#/components/schemas/cholesterol"},"glucose":{"$ref":"#/components/schemas/glucose"},"triglyceride":{"$ref":"#/components/schemas/triglyceride"},"blood_pressure":{"$ref":"#/components/schemas/blood_pressure"},"diabetes_family_history":{"$ref":"#/components/schemas/diabetes_family_history"},"body_mass_index":{"$ref":"#/components/schemas/body_mass_index"},"waist_circumference":{"$ref":"#/components/schemas/waist_circumference"}}},"ProductDataPR42023":{"$ref":"#/components/schemas/ProductDataPR41027"},"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"}}},"ProductDataPR42038":{"$ref":"#/components/schemas/ProductDataPR41034"},"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","items":{"type":"string"},"title":"Clinical Phenotypes","nullable":true}}},"ProductDataCNA":{"type":"object","additionalProperties":false,"title":"Inputs for Copy Number Analysis","required":["ndd_icd10_codes"],"properties":{"ndd_icd10_codes":{"type":"array","items":{"type":"string"},"title":"ICD10 Codes","description":"For Example: Q75.3 Macrocephaly"},"clinical_phenotypes__other":{"type":"array","items":{"type":"string"},"title":"Clinical Phenotypes","nullable":true}}},"ExternalSample":{"type":"object","properties":{"sample_id":{"type":"string"},"sample_type":{"$ref":"#/components/schemas/SampleType"},"collection_date":{"$ref":"#/components/schemas/YMDDate"},"accessioned_date":{"$ref":"#/components/schemas/YMDDate"}},"required":["sample_id","sample_type","collection_date","accessioned_date"]},"ProductDataPR11014":{"type":"object","additionalProperties":false,"title":"Inputs for Rare Disease Family Member","required":["affected_status","secondary_findings_opt_out"],"properties":{"affected_status":{"title":"Affliction Status","description":"Affected similarly to the proband","type":"string","enum":["AFFECTED","NOT_AFFECTED"],"default":"NOT_AFFECTED"},"secondary_findings_opt_out":{"description":"true for opt-out, false for opt-in","title":"Secondary Findings","type":"boolean","default":false}}},"MonogenicToplineFinding":{"type":"string","enum":["POSITIVE","NEGATIVE"]},"PRSToplineFinding":{"type":"string","enum":["AVERAGE_RISK","ELEVATED_RISK","HIGH_RISK","LOW_RISK","INTERMEDIATE_RISK","BORDERLINE_RISK","NOT_ANALYZED","INCREASED_RISK","NOT_INCREASED_RISK"]},"PGxImpactToplineFinding":{"type":"string","enum":["MINIMAL_IMPACT","ALTERED_DOSE","MAJOR_IMPACT","CONTRAINDICATED"]},"RareDiseaseToplineFinding":{"type":"string","enum":["POSITIVE","NEGATIVE","UNCERTAIN"]},"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"}}},"ProviderLicenseStatus":{"type":"string","enum":["UNVERIFIED","VERIFIED","REVOKED","DENIED"]},"DNAVisitServiceType":{"description":"Pre- and post-test service types offered by DNAVisit","type":"string","enum":["PRE_TEST_REVIEW_ONLY","PRE_TEST_COUNSELING","POST_TEST_REVIEW_ONLY","POST_TEST_COUNSELING"]},"Date":{"type":"string","format":"date"},"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"]},"PhoneNumber":{"type":"string","pattern":"^\\+?\\d{1,4}?[-\\s]?\\(?\\d{1,3}?\\)?[-\\s]?\\d{1,4}[-\\s]?\\d{1,9}?$","examples":["+919367788755","8989829304","+16308520397","786-307-3615","+1-555-555-5555"]},"CLIANumber":{"type":"string","pattern":"^\\d{2}D[A-Za-z0-9]{7}$","examples":["12D3ad2R7q","34D31532S5"]},"DataSetId":{"type":"string","pattern":"^DS-?([a-z]{3,5}-?)?\\d+$","examples":["DS-0123456","DS-dev-0123456","DS0123456","DSdev0123456"]},"Demographics":{"type":"object","title":"Demographics","properties":{"dob":{"title":"Date of Birth","description":"mm/dd/yyyy","$ref":"#/components/schemas/Date"},"sex":{"title":"Sex","$ref":"#/components/schemas/BiologicalSex"},"gender":{"$ref":"#/components/schemas/Gender"}}},"Gender":{"description":"Cultural/social gender; unconstrained string\nSources:\n  * https://www.csusm.edu/ipa/surveys/inclusive-language-guidelines.html","type":"string","enum":["CISGENDER_MAN","CISGENDER_WOMAN","NO_RESPONSE","NON_BINARY","TRANSGENDER_MAN","TRANSGENDER_WOMAN"]},"ConsentType":{"description":"Types of consent","type":"string","enum":["CONTACT","IRB","RESEARCH","TESTING"]},"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"]},"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"]},"Insurance":{"title":"Insurance information","type":"object","required":["policyholder_name","company","member_id","relationship_to_policyholder"],"properties":{"policyholder_name":{"title":"Policy Holder Name","required":["first","last"],"$ref":"#/components/schemas/Name"},"policyholder_dob":{"title":"Policyholder Date of Birth","description":"mm/dd/yyyy","$ref":"#/components/schemas/Date"},"policyholder_sex":{"title":"Policyholder Sex","$ref":"#/components/schemas/BiologicalSex"},"policyholder_address":{"title":"Policyholder Address","$ref":"#/components/schemas/Address"},"company":{"title":"Name of Insurance Company","type":"string"},"phone":{"title":"Insurance Phone Number","type":"string"},"member_id":{"title":"Member ID","type":"string"},"group_number":{"title":"Group Number","type":"string"},"prior_auth_number":{"title":"Prior Authorization Number","type":"string"},"relationship_to_policyholder":{"title":"Patient Relationship to Policyholder","description":"","$ref":"#/components/schemas/Relationship"},"relationship_to_policyholder_other":{"title":"Patient Relationship to Policyholder Other: ","type":"string"},"epsdt_coverage":{"title":"EPSDT Coverage","description":"If the patient is under 21 years old and has a Medicaid plan, please provide the following information for Early and Periodic Screening, Diagnosis, and Treatment (EPSDT) coverage.","type":"object","properties":{"medicaid_plan":{"title":"Medicaid Plan","type":"string"},"medicaid_number":{"title":"Medicaid Number","type":"string"},"attestations":{"title":"I attest that test results will impact medical management, including treatment or care decisions as follows:","type":"array","items":{"type":"string","enum":["My patient may be eligible for specific drug therapies or clinical trials","My patient may be referred for additional medical consultations and/or support services for additional treatments and surveillance","My patient's medication may change if genetic findings indicate risk for adverse reactions or poor drug metabolism"]},"uniqueItems":true}}}}},"Relationship":{"description":"Relationship to an individual (e.g., insurance policyholder)","type":"string","enum":["SELF","SPOUSE","CHILD","DEPENDENT_HANDICAPPED","DEPENDENT_SPONSORED","DEPENDENT_OF_MINOR_DEPENDENT","EMPLOYEE","FOSTER_CHILD","GRANDCHILD","GRANDPARENT","NEPHEW_OR_NIECE","STEPCHILD","UNKNOWN","WARD_OF_COURT","OTHER"]},"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"]},"diagnosed_with_breast_cancer":{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"Has the Patient Been Diagnosed With Breast Cancer?","type":"boolean"},"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},"height":{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"Height (m)","description":"Enter to two decimal points (e.g. 1.65)","type":"number","minimum":0,"maximum":5,"example":1.65},"ashkenazi_jewish":{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"Ashkenazi Jewish Heritage","description":"Does the patient have an Ashkenazi Jewish Heritage?","type":"string","$ref":"#/components/schemas/YesNoUnknown"},"YesNoUnknown":{"type":"string","default":"UNKNOWN","enum":["YES","NO","UNKNOWN"]},"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"}}}},"age_at_menarche":{"title":"Age At Menarche","description":"Age at first menstrual period. Leave blank if unknown.","type":"integer","minimum":0,"maximum":99},"number_of_live_births":{"title":"Number Of Live Births","description":"Leave blank if unknown.","type":"integer","minimum":0,"maximum":50},"age_at_first_birth":{"title":"Age At First Birth","description":"Leave blank if unknown.","type":"integer","minimum":0,"maximum":99},"menopausal_status":{"$ref":"#/components/schemas/MenopausalStatus"},"MenopausalStatus":{"title":"Menopausal Status","type":"string","default":"UNKNOWN","enum":["PREMENOPAUSAL","PERIMENOPAUSAL","POSTMENOPAUSAL","UNKNOWN"]},"age_at_menopause":{"title":"Age At Menopause","description":"Leave blank if unknown.","type":"integer","minimum":0,"maximum":99},"history_of_hyperplasia":{"title":"History Of Hyperplasia","$ref":"#/components/schemas/YesNoUnknown"},"history_of_atypical_hyperplasia":{"title":"History Of Atypical Hyperplasia","$ref":"#/components/schemas/YesNoUnknown"},"history_of_lcis":{"title":"History Of LCIS","description":"Lobular carcinoma in situ (LCIS)","$ref":"#/components/schemas/YesNoUnknown"},"history_of_ovarian_cancer":{"title":"History Of Ovarian Cancer","$ref":"#/components/schemas/YesNoUnknown"},"age_at_diagnosis_of_ovarian_cancer":{"title":"Age At Diagnosis Of Ovarian Cancer","type":"integer","minimum":0,"maximum":99},"hormone_replacement_therapy_use":{"title":"Hormone Replacement Therapy (HRT) Use","type":"string","anyOf":[{"title":"Never","type":"string","enum":["NEVER"]},{"title":"Previous user (more than 5 years ago)","type":"string","enum":["GT_5_YEARS_AGO"]},{"title":"Previous user (less than 5 years ago)","type":"string","enum":["LT_5_YEARS_AGO"]},{"title":"Current user (or stopped using less than 12 months ago)","type":"string","enum":["CURRENT"]}]},"type_of_hormone_replacement_therapy_taken":{"title":"Type Of Hormone Replacement Therapy (HRT) Taken","type":"string","enum":["OESTROGEN","COMBINED","UNKNOWN"]},"length_of_time_taking_hormone_replacement_therapy":{"title":"Length Of Time Taking Hormone Replacement Therapy (HRT)","description":"Round to the nearest decimal point (e.g. 4.5 years)","type":"number","minimum":0},"length_of_future_time_intended_to_take_hormone_replacement_therapy":{"title":"Length Of Future Time Intended To Continue Taking Hormone Replacement Therapy (HRT)","description":"Round to the nearest decimal point (e.g. 4.5 years)","type":"number","minimum":0},"length_of_time_since_last_taking_hormone_replacement_therapy":{"title":"Length Of Time Since Last Taking Hormone Replacement Therapy (HRT)","description":"Round to the nearest decimal point (e.g. 4.5 years)","type":"number","minimum":0},"genetic_testing":{"title":"Genetic Testing Of The Woman","$ref":"#/components/schemas/BreastCancerGeneticTesting"},"BreastCancerGeneticTesting":{"title":"Breast Cancer Genetic Testing","type":"string","anyOf":[{"title":"Never","type":"string","enum":["NEVER"]},{"title":"Test result negative","type":"string","enum":["NEGATIVE"]},{"title":"Positive in BRCA1","type":"string","enum":["BRCA1"]},{"title":"Positive in BRCA2","type":"string","enum":["BRCA2"]},{"title":"Unknown","type":"string","enum":["UNKNOWN"]}]},"genetic_testing_of_father":{"title":"Genetic Testing Of The Woman's Father","$ref":"#/components/schemas/BreastCancerGeneticTesting"},"father_had_breast_cancer":{"title":"Has The Father Had Breast Cancer?","$ref":"#/components/schemas/YesNoUnknown"},"brother_had_breast_cancer":{"title":"Has A Brother Had Breast Cancer?","$ref":"#/components/schemas/YesNoUnknown"},"breast_density_measure":{"title":"Breast Density Measure","type":"string","anyOf":[{"title":"Volpara\u00ae Volumetric Density (%)","type":"string","enum":["VOLPARA"]},{"title":"VAS Percentage Density","type":"string","enum":["VAS"]},{"title":"BI-RADS\u00ae ATLAS Density","type":"string","enum":["BIRADS"]},{"title":"Not Available","type":"string","enum":["NOT_AVAILABLE"]}]},"breast_density_value_decimal":{"title":"Breast Density Value (0.00 to 100.00)","description":"Value for Volpara\u00ae and VAS","type":"number","minimum":0.0,"maximum":100.0},"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"]},"polygenic_snp_score":{"title":"Polygenic SNP Score","description":"Log relative risk, decimal","type":"number"},"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/had_ovarian_cancer"},"age_at_ovarian_cancer":{"$ref":"#/components/schemas/age_at_ovarian_cancer"},"genetic_testing":{"$ref":"#/components/schemas/BreastCancerGeneticTesting"}}},"name":{"title":"Name","type":"string"},"had_breast_cancer":{"title":"Did They Have Breast Cancer?","$ref":"#/components/schemas/YesNoUnknown"},"breast_cancer_bilateral":{"title":"Was Breast Cancer Bilateral?","$ref":"#/components/schemas/YesNoUnknown"},"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},"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},"had_ovarian_cancer":{"title":"Did They Have Ovarian Cancer?","$ref":"#/components/schemas/YesNoUnknown"},"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},"diagnosed_with_coronary_artery_disease":{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"Has the Patient Been Diagnosed With Coronary Artery Disease?","type":"boolean"},"smoking":{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"Smoking","type":"object","required":["smoking_status"],"properties":{"smoking_status":{"$ref":"#/components/schemas/SmokingStatus"}},"additionalProperties":false,"definitions":{"SmokingStatus":{"title":"Current Smoking Status","type":"string","oneOf":[{"type":"string","title":"Current Smoker","enum":["CURRENT"]},{"type":"string","title":"Former Smoker","enum":["FORMER"]},{"type":"string","title":"Non-Smoker","enum":["NEVER"]}]}}},"SmokingStatus":{"title":"Current Smoking Status","type":"string","oneOf":[{"type":"string","title":"Current Smoker","enum":["CURRENT"]},{"type":"string","title":"Former Smoker","enum":["FORMER"]},{"type":"string","title":"Non-Smoker","enum":["NEVER"]}]},"diabetes":{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"Diabetes","type":"object","required":["diagnosed_with_type_2_diabetes"],"properties":{"diagnosed_with_type_2_diabetes":{"$ref":"#/components/schemas/DiagnosedWithType2Diabetes"}},"additionalProperties":false,"definitions":{"DiagnosedWithType2Diabetes":{"title":"Has the Patient Been Diagnosed With Type 2 Diabetes?","type":"boolean"}}},"DiagnosedWithType2Diabetes":{"title":"Has the Patient Been Diagnosed With Type 2 Diabetes?","type":"boolean"},"cholesterol":{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"Cholesterol","type":"object","required":["total_cholesterol","hdl_cholesterol"],"properties":{"total_cholesterol":{"$ref":"#/components/schemas/TotalCholesterol"},"hdl_cholesterol":{"$ref":"#/components/schemas/HDLCholesterol"}},"additionalProperties":false,"definitions":{"TotalCholesterol":{"title":"Total Cholesterol Level (mg/dL)","description":"must be between 130 - 320","type":"number","minimum":130,"maximum":320},"HDLCholesterol":{"title":"HDL Cholesterol Level (mg/dL)","description":"must be between 20 - 100","type":"number","minimum":20,"maximum":100}}},"TotalCholesterol":{"title":"Total Cholesterol Level (mg/dL)","description":"must be between 130 - 320","type":"number","minimum":130,"maximum":320},"HDLCholesterol":{"title":"HDL Cholesterol Level (mg/dL)","description":"must be between 20 - 100","type":"number","minimum":20,"maximum":100},"blood_pressure":{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"Blood Pressure","type":"object","required":["systolic_blood_pressure","diastolic_blood_pressure","antihypertension_medication_use"],"properties":{"systolic_blood_pressure":{"$ref":"#/components/schemas/SystolicBloodPressure"},"diastolic_blood_pressure":{"$ref":"#/components/schemas/DiastolicBloodPressure"},"antihypertension_medication_use":{"$ref":"#/components/schemas/AntiHyperTensionMedicationUse"}},"additionalProperties":false,"definitions":{"SystolicBloodPressure":{"title":"Systolic Blood Pressure (mm HG)","description":"must be between 90 - 200","type":"number","minimum":90,"maximum":200},"DiastolicBloodPressure":{"title":"Diastolic Blood Pressure (mm HG)","description":"must be between 60 - 130","type":"number","minimum":60,"maximum":130},"AntiHyperTensionMedicationUse":{"title":"Is The Patient Undergoing Treatment For Hypertension?","type":"boolean"}}},"SystolicBloodPressure":{"title":"Systolic Blood Pressure (mm HG)","description":"must be between 90 - 200","type":"number","minimum":90,"maximum":200},"DiastolicBloodPressure":{"title":"Diastolic Blood Pressure (mm HG)","description":"must be between 60 - 130","type":"number","minimum":60,"maximum":130},"AntiHyperTensionMedicationUse":{"title":"Is The Patient Undergoing Treatment For Hypertension?","type":"boolean"},"glucose":{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"Glucose","type":"object","required":["fasting_glucose_level"],"properties":{"fasting_glucose_level":{"$ref":"#/components/schemas/FastingGlucoseLevel"}},"additionalProperties":false,"definitions":{"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}}},"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},"triglyceride":{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"Triglyceride","type":"object","required":["triglyceride_level"],"properties":{"triglyceride_level":{"$ref":"#/components/schemas/TriglycerideLevel"}},"additionalProperties":false,"definitions":{"TriglycerideLevel":{"title":"Triglyceride Level (mg/dL)","description":"must be between 40 - 500","type":"number","minimum":40,"maximum":500,"example":150.5}}},"TriglycerideLevel":{"title":"Triglyceride Level (mg/dL)","description":"must be between 40 - 500","type":"number","minimum":40,"maximum":500,"example":150.5},"diabetes_family_history":{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"DiabetesFamilyHistory","type":"object","required":["first_degree_family_with_type_2_diabetes"],"properties":{"first_degree_family_with_type_2_diabetes":{"$ref":"#/components/schemas/FirstDegreeFamilyWithType2Diabetes"}},"additionalProperties":false,"definitions":{"FirstDegreeFamilyWithType2Diabetes":{"title":"Has a First Degree Family Member Been Diagnosed with Type 2 Diabetes?","type":"boolean"}}},"FirstDegreeFamilyWithType2Diabetes":{"title":"Has a First Degree Family Member Been Diagnosed with Type 2 Diabetes?","type":"boolean"},"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}}},"BodyMassIndex":{"title":"Body Mass Index (kg/m^2)","description":"must be between 15 - 50","type":"number","minimum":15,"maximum":50,"example":22.5},"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}}},"WaistCircumference":{"title":"Waist Circumference (cm)","description":"must be between 50 - 200","type":"number","minimum":50,"maximum":200,"example":90},"diagnosed_with_prostate_cancer":{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"Has the Patient Been Diagnosed With Prostate Cancer?","type":"boolean"},"prostate_cancer_family_history":{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"ProstateCancerFamilyHistory","type":"object","required":["first_or_second_degree_family_with_prostate_cancer"],"properties":{"first_or_second_degree_family_with_prostate_cancer":{"$ref":"#/components/schemas/FirstOrSecondDegreeFamilyWithProstateCancer"}},"additionalProperties":false,"definitions":{"FirstOrSecondDegreeFamilyWithProstateCancer":{"title":"Has a First or Second Degree Family Member Been Diagnosed with Prostate Cancer?","type":"string","$ref":"#/components/schemas/YesNoUnknown"}}},"FirstOrSecondDegreeFamilyWithProstateCancer":{"title":"Has a First or Second Degree Family Member Been Diagnosed with Prostate Cancer?","type":"string","$ref":"#/components/schemas/YesNoUnknown"}}},"paths":{"/provider/forms/requisition":{},"/clinician/{clinician_id}":{"parameters":[{"name":"clinician_id","in":"path","description":"MyOme clinician id.","required":true,"schema":{"type":"string","$ref":"#/components/schemas/ClinicianId"},"example":"CN123456"}]},"/clinician":{},"/consent":{"get":{"operationId":"myome.api.endpoints.consent.consent_get","security":[],"summary":"List consent types","description":"Returns available consent types (general and, when requested via query, product-specific). Used to know which consent URIs to send when granting consent.","tags":["Resources"],"responses":{"200":{"$ref":"#/components/responses/ConsentListResponse"},"401":{"$ref":"#/components/responses/StructuredError"}},"parameters":[{"name":"consents","in":"query","required":true,"example":["DNAVISIT","PR-2019"],"schema":{"type":"array","items":{"type":"string","pattern":"[A-Z_0-9]+(-\\d+\\.\\d+\\.\\d+)?$"}}}]}},"/cures-release":{},"/draft-requisition/{draft_requisition_id}":{"parameters":[{"name":"draft_requisition_id","in":"path","description":"MyOme draft requisition id returned from submission","required":true,"schema":{"type":"string","$ref":"#/components/schemas/DraftRequisitionId"},"example":"DR123456"}]},"/draft-requisition":{},"/financial-assistance":{},"/genetic-counseling":{},"/institutional/campaign/{campaign_code}/clinic/{clinic_id}":{"parameters":[{"name":"campaign_code","in":"path","description":"MyOme campaign code","required":true,"schema":{"type":"string"},"example":["CATALYST"]},{"name":"clinic_id","in":"path","description":"MyOme clinic id","required":true,"schema":{"type":"string"},"example":["CL123456"]}]},"/institutional/campaign/{campaign_code}/individual":{"parameters":[{"name":"campaign_code","in":"path","description":"MyOme campaign code","required":true,"schema":{"type":"string"},"example":["LONGEVITY"]}],"post":{"operationId":"myome.api.endpoints.institutional.campaign.individual.individual_post","security":[{"jwt":[]}],"summary":"Add individual to campaign (institutional)","requestBody":{"$ref":"#/components/requestBodies/InstitutionalCampaignIndividualPost"},"tags":["Institutional Interface"],"responses":{"2XX":{"$ref":"#/components/responses/StructuredSuccess"},"4XX":{"$ref":"#/components/responses/StructuredError"}}}},"/institutional/campaign/{campaign_code}/nightly-manifest":{"parameters":[{"name":"campaign_code","in":"path","description":"Unique campaign code","required":true,"schema":{"type":"string"},"example":["CATALYST"]}]},"/institutional/campaign/{campaign_code}/provider":{"parameters":[{"name":"campaign_code","in":"path","description":"Unique campaign code","required":true,"schema":{"type":"string"},"example":["CATALYST","UNIVERSITY_STUDY"]}]},"/institutional/campaign/{campaign_code}/requisition":{"parameters":[{"name":"campaign_code","in":"path","description":"Unique campaign code","required":true,"schema":{"type":"string"},"example":["CATALYST","UNIVERSITY_STUDY"]}]},"/institutional/onboarding":{},"/institutional/order/{order_id}":{"parameters":[{"name":"order_id","in":"path","description":"MyOme order id","required":true,"example":"OR123456","schema":{"$ref":"#/components/schemas/OrderId"}},{"name":"status","in":"query","description":"Shim order status","required":false,"example":"ANALYZING","schema":{"type":"string"}},{"name":"test_case","in":"query","description":"Shim test case","required":false,"example":["monogenic-positive","1"],"schema":{"type":"string"}}]},"/institutional/partner-requisition":{},"/institutional/requisition/{rq_identifier}/change-ordering-provider":{},"/institutional/requisition/{rq_identifier}/change-product":{},"/institutional/requisition":{},"/institutional/requisition/{rq_identifier}/redraw":{},"/provider/onboarding":{},"/order/{order_id}":{"parameters":[{"name":"order_id","in":"path","description":"MyOme order id","required":true,"example":"OR123456","schema":{"$ref":"#/components/schemas/OrderId"}}],"get":{"parameters":[{"name":"expand","in":"query","description":"Include the report results if available","required":false,"example":true,"schema":{"type":"boolean"}}],"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.\nOrders are created via POST `/requisition`; this endpoint is for status and results lookup.\n","responses":{"200":{"$ref":"#/components/responses/OrderGetResponse"},"401":{"$ref":"#/components/responses/StructuredError"}}}},"/provider/organization/{organization_id}/provider/{clinician_id}/delegate/{delegate_provider_id}":{"parameters":[{"name":"organization_id","in":"path","description":"MyOme clinic or organization id.","required":true,"schema":{"type":"string","oneOf":[{"$ref":"#/components/schemas/ClinicId"},{"$ref":"#/components/schemas/OrganizationId"}]},"example":["CL123456","ORG123456"]},{"name":"clinician_id","in":"path","description":"MyOme clinician id. May be obtained from the `/profile/` endpoint w/a valid auth token.","required":true,"schema":{"type":"string","$ref":"#/components/schemas/ClinicianId"},"example":"CN123456"},{"name":"delegate_provider_id","in":"path","description":"MyOme provider id.","required":true,"schema":{"type":"string","$ref":"#/components/schemas/ClinicianId"},"example":"CN123456"}]},"/provider/organization/{organization_id}/provider/{clinician_id}/delegate":{"parameters":[{"name":"organization_id","in":"path","description":"MyOme clinic or organization id.","required":true,"schema":{"type":"string","oneOf":[{"$ref":"#/components/schemas/ClinicId"},{"$ref":"#/components/schemas/OrganizationId"}]},"example":["CL123456","ORG123456"]},{"name":"clinician_id","in":"path","description":"MyOme clinician id. May be obtained from the `/profile/` endpoint w/a valid auth token.","required":true,"schema":{"type":"string","$ref":"#/components/schemas/ClinicianId"},"example":"CN123456"}]},"/provider/organization/{organization_id}/provider":{"parameters":[{"name":"organization_id","in":"path","description":"MyOme clinic or organization id.","required":true,"schema":{"type":"string","oneOf":[{"$ref":"#/components/schemas/ClinicId"},{"$ref":"#/components/schemas/OrganizationId"}]},"example":["CL123456","ORG123456"]}]},"/provider/organization/{organization_id}/provider/{provider_id}":{"parameters":[{"name":"organization_id","in":"path","description":"MyOme clinic or organization id.","required":true,"schema":{"type":"string","oneOf":[{"$ref":"#/components/schemas/ClinicId"},{"$ref":"#/components/schemas/OrganizationId"}]},"example":["CL123456","ORG123456"]},{"name":"provider_id","in":"path","description":"MyOme provider id","required":true,"schema":{"type":"string","$ref":"#/components/schemas/ClinicianId"},"example":"CN123456"}]},"/patient/{individual_id}":{"parameters":[{"name":"individual_id","in":"path","description":"MyOme individual id. May be obtained from the `/profile/` endpoint w/a valid auth token.","required":true,"schema":{"type":"string","$ref":"#/components/schemas/IndividualId"},"example":"IN123456"}]},"/patient/{individual_id}/consent":{"parameters":[{"name":"individual_id","in":"path","description":"MyOme individual id. May be obtained from the `/profile/` endpoint w/a valid auth token.","required":true,"schema":{"type":"string","$ref":"#/components/schemas/IndividualId"},"example":"IN123456"}]},"/patient/{individual_id}/genetic-counseling":{},"/patient-portal/order/{order_id}":{"parameters":[{"name":"order_id","in":"path","description":"MyOme order id","required":true,"example":"OR123456","schema":{"$ref":"#/components/schemas/OrderId"}}]},"/patient-portal/share-history":{},"/patient-portal/profile":{},"/patient-portal/requisition":{},"/payment/{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"}]},"/product":{"get":{"operationId":"myome.api.endpoints.product.product_get","security":[{"jwt":[]}],"tags":["Resources"],"summary":"List orderable products","description":"Returns the list of products that can be ordered (for use when creating requisitions).\n","responses":{"200":{"$ref":"#/components/responses/ProductListResponse"},"401":{"$ref":"#/components/responses/StructuredError"}}}},"/profile":{},"/provider/clinic/{clinic_id}":{"parameters":[{"name":"clinic_id","in":"path","description":"MyOme clinic id (e.g. CL\u2026).","required":true,"schema":{"$ref":"#/components/schemas/ClinicId"},"example":"CL123456"}]},"/provider/clinic/{clinic_id}/fax/verify/confirm":{"parameters":[{"name":"clinic_id","in":"path","description":"MyOme clinic id (e.g. CL\u2026).","required":true,"schema":{"$ref":"#/components/schemas/ClinicId"},"example":"CL123456"}]},"/provider/clinic/{clinic_id}/fax/verify/request":{"parameters":[{"name":"clinic_id","in":"path","description":"MyOme clinic id (e.g. CL\u2026).","required":true,"schema":{"$ref":"#/components/schemas/ClinicId"},"example":"CL123456"}]},"/provider/forms/get-requisition-form":{},"/provider/individual/{individual_id}":{"parameters":[{"name":"individual_id","in":"path","description":"MyOme individual id.","required":true,"schema":{"type":"string","$ref":"#/components/schemas/IndividualId"},"example":["IN123456","INdev123456"]}]},"/provider/individual/{individual_id}/medication-response/guidelines":{"parameters":[{"name":"individual_id","in":"path","description":"MyOme individual id.","required":true,"schema":{"type":"string","$ref":"#/components/schemas/IndividualId"},"example":["IN123456","INdev123456"]}]},"/provider/individual/{individual_id}/requisition":{"parameters":[{"name":"individual_id","in":"path","description":"MyOme individual id.","required":true,"schema":{"type":"string","$ref":"#/components/schemas/IndividualId"},"example":["IN123456","INdev123456"]}]},"/provider/requisition/{requisition_id}/collated-report":{"parameters":[{"name":"requisition_id","in":"path","description":"MyOme requisition id.","required":true,"schema":{"type":"string","$ref":"#/components/schemas/RequisitionId"},"example":["RQ123456","RQdev123456"]}]},"/provider/requisition/{requisition_id}/downgrade":{"parameters":[{"name":"requisition_id","in":"path","description":"Supporting Requisition id.","required":true,"schema":{"type":"string","$ref":"#/components/schemas/RequisitionId"},"example":"RQ123456"}]},"/provider/requisition":{},"/provider/requisition/metrics":{},"/provider/requisition/{requisition_id}/notification-settings":{"parameters":[{"name":"requisition_id","in":"path","required":true,"schema":{"$ref":"#/components/schemas/RequisitionId"}}]},"/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\n`/order/{order_id}` instead.\n","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","order_date","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/OrderDate"},{"$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\n`requisition/{requisition_id}` and related order endpoints.\n","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"]}},"/requisition/{requisition_id}/rerequisition/":{"parameters":[{"name":"requisition_id","in":"path","description":"MyOme requisition id associated w/a previously completed order","required":true,"schema":{"type":"string","$ref":"#/components/schemas/RequisitionId"},"example":"RQ123456"}],"get":{"operationId":"myome.api.endpoints.rerequisition.rerequisition_get","security":[{"jwt":[]}],"tags":["Requisitions and Orders"],"summary":"List products eligible for re-requisition","description":"Returns products that can be ordered as a re-requisition from the given completed requisition.\n","responses":{"200":{"$ref":"#/components/responses/ReRequisitionResponse"},"401":{"$ref":"#/components/responses/StructuredError"}}}},"/patient-portal/auth/signin/token":{},"/patient-portal/fvt/referral":{},"/patient-portal/fvt/referral/{uuid}":{"parameters":[{"name":"uuid","in":"path","required":true,"description":"Unique ID identifying the referring individual.","schema":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"}}]},"/patient-portal/fvt/referral/{uuid}/family-member":{"parameters":[{"name":"uuid","in":"path","required":true,"description":"Unique ID identifying the referring individual.","schema":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"}}]},"/patient-portal/ordering/eligibility":{},"/patient-portal/ordering/payment-intent":{},"/patient-portal/ordering/submit":{},"/patient-portal/partnerships/{slug}":{"parameters":[{"name":"slug","in":"path","required":true,"description":"URL slug identifying the partnership","schema":{"type":"string","example":"test-partnership"}}]},"/patient-portal/rerequisition/eligibility":{},"/patient-portal/rerequisition/submit":{},"/patient-portal/results/download":{},"/provider-portal/user-profile":{}}}