--- title: "Get Clinical Qualification Submission By Id" method: GET path: "/clinical-qualification/{id}" tags: ["public-api"] --- # Get Clinical Qualification Submission By Id `GET /clinical-qualification/{id}` ## Path parameters - `id` string, required ## Response `200` Successfully returned an clinical qualification. - GetClinicalQualificationResponse — Represents the response structure for a GET /prior-authorization/:id request. This class extends the generic ApiResponse, specifically tailored to handle responses related to clinical qualifications. It primarily includes the data attribute, which holds detailed information about the benefit verification process and its results. - `status` union - 'success' - 'error' - `error` ApiError - `title` string, required - `description` string, required - `code` string, required - `data` GetClinicalQualificationResponseData - `id` string, required — The ID of this clinical qualification - `object` 'clinical_qualification' — The type of object. This will always be 'clinical_qualification', from this endpoint, but this can be helpful for differentiating between different types of objects when parsing webhook responses. - `diagnoses` Diagnosis[], required — Clinical diagnoses for the patient in ICD-10 format. i.e. 'E66.9' - `code` string, required — ICD-10 code for the diagnosis. i.e. 'E66.9' - `evidence` ResponseEvidenceItem[] — A collection of evidence items supporting the authorization request. Any other supporting evidence that doesn't fit into one of the explicitly declared fields above can be added here. - `asset` AssetResponse - `url` string, required — The URL where the asset can be accessed. - `file_type` 'application/pdf' | 'application/msword' | 'text/plain' | 'application/vnd.ms-excel', required — An enumeration. - `content` object — Detailed content of the evidence, which varies based on the type of evidence. - `date_created` string, date-time, required — The date and time (if available) when the evidence was created. This is important for ensuring we have an accurate timeline of the patient's history. - `document_date` string, date — The clinical/source document date to display to reviewers, when known. This excludes ingestion/upload/export timestamps. - `title` string, required — Title of the evidence. This will be shown to users in the platform UI so it's recommended to give it a name that would be meaningful to them, such as 'Intake Form' - `patient` Patient, required — Represents patient information. - `address` Address, required — Represents a postal address. - `street` string, required — Street address of residence. - `street_line_2` string — Additional street address information. - `city` string, required — City of residence. - `state_province` string, required — State or province of residence. - `zip_postal_code` string, required — ZIP or postal code part of the address. - `country` string — Country of residence. - `date_of_birth` string, date, required — The patient's date of birth - `email` string, email — The patient's email address - `first_name` string, required — The patient's first name - `last_name` string, required — The patient's last name - `gender` 'male' | 'female' | 'other' | 'not_specified', required — An enumeration. - `internal_id` string, required — Your internal ID for this patient. This is used for linking all of the requests for a given patient. - `mrn` string — Medical record number - `phone` string — The patient's phone number - `insurance` InsuranceDocumentInfo[], required — Array of insurance documents. - `scanned_content` ScannedContent, required - `client_name` string — The client/employer name. - `group_number` string — The group number on the card. - `member_name` string — The member name on the card. - `member_number` string — The member number on the card. - `payer_name` string — The payer name on the card. This field is not normalized, so the same plan may have different names depending on the way it appears on the card. i.e. 'United Healthcare', 'United', 'United Health' could all appear - `plan_name` string — The plan name on the card. This field is not normalized, so the same plan may have different names depending on the way it appears on the card - `rx_bin` string — The Rx BIN number on the card. - `rx_group` string — The Rx group number on the card. - `rx_pcn` string — The Rx PCN number on the card. - `error` string — Error message if we were unable to extract information from the card. - `discrete_content` PartialInsuranceInfo, required - `client_name` string — The client/employer name. - `group_number` string — The group number on the card. - `member_name` string — The member name on the card. - `member_number` string — The member number on the card. - `payer_name` string — The payer name on the card. This field is not normalized, so the same plan may have different names depending on the way it appears on the card. i.e. 'United Healthcare', 'United', 'United Health' could all appear - `plan_name` string — The plan name on the card. This field is not normalized, so the same plan may have different names depending on the way it appears on the card - `rx_bin` string — The Rx BIN number on the card. - `rx_group` string — The Rx group number on the card. - `rx_pcn` string — The Rx PCN number on the card. - `url` string — If applicable, the Base64 encoded insurance card image you send in the request is stored on our servers. A signed URL to the image is returned here. This URL has a short expiry time, so you should download the image immediately after receiving it if you want to view the asset. - `drugs` Drug[], required — Information regarding the potential prescriptions this clinical qualification check should be run for - `days_supply` integer, required — The number of days the prescription will be expected to last. - `quantity` integer, required — The quantity of the medication. - `directions` string, required — Instructions on how the medication should be taken. - `drug_name` string, required — The name of the medication. - `strength` string, required — The strength of the medication. - `dose_form` 'aerosol' | 'bar' | 'bead' | 'breadstick' | 'bulk' | 'capsule' | 'catheter' | 'cement' | 'cigarette' | 'cloth' | 'concentrate' | 'cone' | 'cream' | 'crystal' | 'culture' | 'dentifrice' | 'deposit' | 'device' | 'diaphragm' | 'disc' | 'douche' | 'dressing' | 'drops' | 'elixir' | 'emulsion' | 'enema' | 'extract' | 'film' | 'food' | 'foam' | 'gel' | 'generator' | 'globule' | 'graft' | 'gum' | 'implant' | 'infusion' | 'inhalant' | 'inhalation' | 'inhaler' | 'injectable' | 'injection' | 'insert' | 'irrigant' | 'irrigation' | 'jelly' | 'kit' | 'lens' | 'liner' | 'liniment' | 'lipstick' | 'liquid' | 'lollipop' | 'lotion' | 'lozenge' | 'miscellaneous' | 'mouthwash' | 'mucilage' | 'oil' | 'ointment' | 'packing' | 'paste' | 'pastille' | 'patch' | 'pellet' | 'pill' | 'plaster' | 'poultice' | 'powder' | 'resin' | 'ring' | 'rinse' | 'rod' | 'salve' | 'shampoo' | 'soap' | 'sol' | 'solution' | 'sponge' | 'spray' | 'stick' | 'strip' | 'suppository' | 'suspension' | 'suture' | 'swab' | 'syrup' | 'tablet' | 'tampon' | 'tape' | 'tea' | 'test' | 'tincture' | 'troche' | 'vaginal_suppository' | 'vaginal_tablet' | 'wafer' | 'wash' | 'wax', required — An enumeration. - `route_of_administration` 'auricular (otic)' | 'otic' | 'buccal' | 'conjunctival' | 'cutaneous' | 'dental' | 'electro-osmosis' | 'endocervical' | 'endosinusial' | 'endotracheal' | 'enteral' | 'epidural' | 'extra-amniotic' | 'extracorporeal' | 'hemodialysis' | 'infiltration' | 'interstitial' | 'intra-abdominal' | 'intra-amniotic' | 'intra-arterial' | 'intra-articular' | 'intrabiliary' | 'intrabronchial' | 'intrabursal' | 'intracameral' | 'intracanalicular' | 'intracardiac' | 'intracartilaginous' | 'intracaudal' | 'intracavernous' | 'intracavitary' | 'intracerebral' | 'intracisternal' | 'intracorneal' | 'intracoronal, dental' | 'intracoronary' | 'intracorporus cavernosum' | 'intracranial' | 'intradermal' | 'intradiscal' | 'intraductal' | 'intraduodenal' | 'intradural' | 'intraepicardial' | 'intraepidermal' | 'intraesophageal' | 'intragastric' | 'intragingival' | 'intrahepatic' | 'intraileal' | 'intralesional' | 'intralingual' | 'intraluminal' | 'intralymphatic' | 'intramammary' | 'intramedullary' | 'intrameningeal' | 'intramuscular' | 'intranodal' | 'intraocular' | 'intraomentum' | 'intraovarian' | 'intrapericardial' | 'intraperitoneal' | 'intrapleural' | 'intraprostatic' | 'intrapulmonary' | 'intraruminal' | 'intrasinal' | 'intraspinal' | 'intrasynovial' | 'intratendinous' | 'intratesticular' | 'intrathecal' | 'intrathoracic' | 'intratubular' | 'intratumor' | 'intratympanic' | 'intrauterine' | 'intravascular' | 'intravenous' | 'intraventricular' | 'intravesical' | 'intravitreal' | 'iontophoresis' | 'irrigation' | 'laryngeal' | 'nasal' | 'nasogastric' | 'not applicable' | 'occlusive dressing technique' | 'ophthalmic' | 'oral' | 'oropharyngeal' | 'parenteral' | 'percutaneous' | 'periarticular' | 'peridural' | 'perineural' | 'periodontal' | 'rectal' | 'respiratory (inhalation)' | 'inhalation' | 'retrobulbar' | 'soft tissue' | 'subarachnoid' | 'subconjunctival' | 'subcutaneous' | 'subgingival' | 'sublingual' | 'submucosal' | 'subretinal' | 'suprachoroidal' | 'topical' | 'transdermal' | 'transendocardial' | 'transmucosal' | 'transplacental' | 'transtracheal' | 'transtympanic' | 'ureteral' | 'urethral' | 'vaginal', required — See: https://www.fda.gov/industry/structured-product-labeling-resources/route-administration - `extra` object — An optional dictionary containing additional information related to the drug or future prescription. - `expected_length_of_therapy` string — The expected length of therapy for the prescribed drug. Defaults to 'Until No Longer Needed' if not provided. - `provider` Provider, required — Represents a healthcare provider. - `address` OptionalAddress, required — Represents a postal address with optional fields. Used for cases where address information may not be complete at creation time. - `street` string — Street address of residence. - `street_line_2` string — Additional street address information. - `city` string — City of residence. - `state_province` string — State or province of residence. - `zip_postal_code` string — ZIP or postal code part of the address. - `country` string — Country of residence. - `email` string, email — The provider's email address. - `fax` string — The provider's fax number. - `first_name` string, required — The provider's first name. - `internal_id` string — Your internal ID for this provider. This is used for linking all of the requests for a given provider. - `last_name` string, required — The provider's last name. - `npi` string, required — The provider's NPI. - `phone` string — The provider's phone number. - `pharmacy` Pharmacy — Represents a pharmacy. Attributes: name (str): The name of the pharmacy. address (Address): The pharmacy's postal address. - `name` string, required — The name of the pharmacy. - `address` Address — Represents a postal address. - `street` string, required — Street address of residence. - `street_line_2` string — Additional street address information. - `city` string, required — City of residence. - `state_province` string, required — State or province of residence. - `zip_postal_code` string, required — ZIP or postal code part of the address. - `country` string — Country of residence. - `questionnaires` Questionnaire[] — list of questionnaires. This is the best place to send structured Q&A format data, such as intake forms, etc. - `questions` Question[], required — A list of questions included in the questionnaire. - `answer` string, required — The answer to the question. - `choices` string[] — Optional list of choices for the question. If provided, the answer must be one of the choices. It's important to include this list of choices for any multiple choice question. This allows our AI to know what a user has effectively said 'no' to by picking another option. I.e. for a question 'Do you have any of the following conditions: Diabetes, Heart Disease, Cancer, None of the above' if the user answers 'None of the above' we can infer that they don't have any of those conditions. Without the choices list we would have no way of knowing that. - `question` string, required — The question to be answered. - `date_created` string, date-time, required — The date and time when the questionnaire was answered. This is important for ensuring we have an accurate timeline of the patient's history. - `visit_notes` VisitNote[] — list of visit notes. - `title` string — The title of the visit note. This is optional and can be used to give the note a meaningful name, such as 'Initial Consultation'. - `content` string, required — The content of the visit note. - `date_created` string, date-time, required — The date and time (if available) when the visit note was created. This is important for ensuring we have an accurate timeline of the patient's history. - `results` ClinicalQualificationResult[], required — The results of the clinical qualification for each of the drugs. - `drug` Drug, required — Represents a medication prescribed by a healthcare provider. Prefer CodedDrug when NDCs are available. - `days_supply` integer, required — The number of days the prescription will be expected to last. - `quantity` integer, required — The quantity of the medication. - `directions` string, required — Instructions on how the medication should be taken. - `drug_name` string, required — The name of the medication. - `strength` string, required — The strength of the medication. - `dose_form` 'aerosol' | 'bar' | 'bead' | 'breadstick' | 'bulk' | 'capsule' | 'catheter' | 'cement' | 'cigarette' | 'cloth' | 'concentrate' | 'cone' | 'cream' | 'crystal' | 'culture' | 'dentifrice' | 'deposit' | 'device' | 'diaphragm' | 'disc' | 'douche' | 'dressing' | 'drops' | 'elixir' | 'emulsion' | 'enema' | 'extract' | 'film' | 'food' | 'foam' | 'gel' | 'generator' | 'globule' | 'graft' | 'gum' | 'implant' | 'infusion' | 'inhalant' | 'inhalation' | 'inhaler' | 'injectable' | 'injection' | 'insert' | 'irrigant' | 'irrigation' | 'jelly' | 'kit' | 'lens' | 'liner' | 'liniment' | 'lipstick' | 'liquid' | 'lollipop' | 'lotion' | 'lozenge' | 'miscellaneous' | 'mouthwash' | 'mucilage' | 'oil' | 'ointment' | 'packing' | 'paste' | 'pastille' | 'patch' | 'pellet' | 'pill' | 'plaster' | 'poultice' | 'powder' | 'resin' | 'ring' | 'rinse' | 'rod' | 'salve' | 'shampoo' | 'soap' | 'sol' | 'solution' | 'sponge' | 'spray' | 'stick' | 'strip' | 'suppository' | 'suspension' | 'suture' | 'swab' | 'syrup' | 'tablet' | 'tampon' | 'tape' | 'tea' | 'test' | 'tincture' | 'troche' | 'vaginal_suppository' | 'vaginal_tablet' | 'wafer' | 'wash' | 'wax', required — An enumeration. - `route_of_administration` 'auricular (otic)' | 'otic' | 'buccal' | 'conjunctival' | 'cutaneous' | 'dental' | 'electro-osmosis' | 'endocervical' | 'endosinusial' | 'endotracheal' | 'enteral' | 'epidural' | 'extra-amniotic' | 'extracorporeal' | 'hemodialysis' | 'infiltration' | 'interstitial' | 'intra-abdominal' | 'intra-amniotic' | 'intra-arterial' | 'intra-articular' | 'intrabiliary' | 'intrabronchial' | 'intrabursal' | 'intracameral' | 'intracanalicular' | 'intracardiac' | 'intracartilaginous' | 'intracaudal' | 'intracavernous' | 'intracavitary' | 'intracerebral' | 'intracisternal' | 'intracorneal' | 'intracoronal, dental' | 'intracoronary' | 'intracorporus cavernosum' | 'intracranial' | 'intradermal' | 'intradiscal' | 'intraductal' | 'intraduodenal' | 'intradural' | 'intraepicardial' | 'intraepidermal' | 'intraesophageal' | 'intragastric' | 'intragingival' | 'intrahepatic' | 'intraileal' | 'intralesional' | 'intralingual' | 'intraluminal' | 'intralymphatic' | 'intramammary' | 'intramedullary' | 'intrameningeal' | 'intramuscular' | 'intranodal' | 'intraocular' | 'intraomentum' | 'intraovarian' | 'intrapericardial' | 'intraperitoneal' | 'intrapleural' | 'intraprostatic' | 'intrapulmonary' | 'intraruminal' | 'intrasinal' | 'intraspinal' | 'intrasynovial' | 'intratendinous' | 'intratesticular' | 'intrathecal' | 'intrathoracic' | 'intratubular' | 'intratumor' | 'intratympanic' | 'intrauterine' | 'intravascular' | 'intravenous' | 'intraventricular' | 'intravesical' | 'intravitreal' | 'iontophoresis' | 'irrigation' | 'laryngeal' | 'nasal' | 'nasogastric' | 'not applicable' | 'occlusive dressing technique' | 'ophthalmic' | 'oral' | 'oropharyngeal' | 'parenteral' | 'percutaneous' | 'periarticular' | 'peridural' | 'perineural' | 'periodontal' | 'rectal' | 'respiratory (inhalation)' | 'inhalation' | 'retrobulbar' | 'soft tissue' | 'subarachnoid' | 'subconjunctival' | 'subcutaneous' | 'subgingival' | 'sublingual' | 'submucosal' | 'subretinal' | 'suprachoroidal' | 'topical' | 'transdermal' | 'transendocardial' | 'transmucosal' | 'transplacental' | 'transtracheal' | 'transtympanic' | 'ureteral' | 'urethral' | 'vaginal', required — See: https://www.fda.gov/industry/structured-product-labeling-resources/route-administration - `extra` object — An optional dictionary containing additional information related to the drug or future prescription. - `expected_length_of_therapy` string — The expected length of therapy for the prescribed drug. Defaults to 'Until No Longer Needed' if not provided. - `status` 'pending' | 'qualified' | 'unqualified' | 'unknown', required — The status of a clinical qualification check. - `unqualified_reasons` UnqualifiedReason[] — If the status is ineligible, the reason(s) why. More structured fields will be added to this model in the future. - `description` string, required — Reason for ineligibility. This is a free text field that could include any text. ## Other responses - `422` — Validation Error --- [API](https://skmtc.net/develophealth/apis/develop-health-public-api.md) · [All operations](https://skmtc.net/develophealth/apis/develop-health-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/develophealth/develop-health-public-api/revisions/1684e1dda9be/schema)