Data Dictionary API
Base Url
https://hidex-portal-uat.azurewebsites.net/
This endpoint allows the user to get the look up values for various drop down fields in Avatar. It returns a list of Id/Description pairings
Syntax: GET [Base Url]/Dictionary/{Id}
| Id | Resource | Name | Type |
|---|---|---|---|
| ANC-TypeofAdmission | Patient | Type of Admission | SingleSelect |
| ANC-ClientAddressState | Patient | Client Address - State | SingleSelect |
| ANC-ClientAddressCounty | Patient | Client Address - County | SingleSelect |
| ANC-MaritalStatus | Patient | Marital Status | SingleSelect |
| ANC-SexualOrientation | Patient | Sexual Orientation | SingleSelect |
| ANC-Education | Patient | Education | SingleSelect |
| ANC-EmploymentStatus | Patient | Employment Status | SingleSelect |
| ANC-GenderIdentity | Patient | Gender Identity | SingleSelect |
| Gender | Patient | Sex | SingleSelect |
| ANC-EthnicOrigin | Patient | Ethnic Origin | SingleSelect |
| ANC-Race | Patient | Race | SingleSelect |
| D-Smoker | Observation | Smoker | SingleSelect |
| CFE-GuarantorID | Coverage | Guarantor ID | SingleSelect |
| CFE-ClientsRelationshipToSubscriber | Coverage | Client's RelationshipToSubscriber | SingleSelect |
| CFE-SubscriberAddressState | Coverage | Subscriber Address - State | SingleSelect |
| CFE-SubscriberAddressCounty | Coverage | Subscriber Address - County | SingleSelect |
| CFE-SubscriberSex | Coverage | Subscriber Sex | SingleSelect |
| PDICD-TypeofDiagnosis | Condition-Diagnosis | Type of Diagnosis | SingleSelect |
| PDICD-Ranking | Condition-Diagnosis | Ranking | SingleSelect |
| PDICD-Status | Condition-Diagnosis | Status | SingleSelect |
| QRCOMSA-LevelOfCareAdmitted | QuestionnaireResponse-CalOMSAdmission | Level of Care Admitted | SingleSelect |
| QRCOMSA-PlaceofBirthState | QuestionnaireResponse-CalOMSAdmission | Place of Birth - State | SingleSelect |
| QRCOMSA-PlaceofBirthCounty | QuestionnaireResponse-CalOMSAdmission | Place of Birth - County | SingleSelect |
| QRCOMSA-DriversLicenseState | QuestionnaireResponse-CalOMSAdmission | Driver's License State | SingleSelect |
| QRCOMSA-Ethnicity | QuestionnaireResponse-CalOMSAdmission | Ethnicity | SingleSelect |
| QRCOMSA-Veteran | QuestionnaireResponse-CalOMSAdmission | Veteran | SingleSelect |
| QRCOMSA-Disability | QuestionnaireResponse-CalOMSAdmission | Disability | MultiSelect |
| QRCOMSA-Consent | QuestionnaireResponse-CalOMSAdmission | Consent | SingleSelect |
| QRCOMSA-AdmissionTransactionType | QuestionnaireResponse-CalOMSAdmission | Admission Transaction Type | SingleSelect |
| QRCOMSA-SourceofReferral | QuestionnaireResponse-CalOMSAdmission | Source of Referral | SingleSelect |
| QRCOMSA-CalWORKsRecipient | QuestionnaireResponse-CalOMSAdmission | CalWORKs Recipient | SingleSelect |
| QRCOMSA-SubstanceAbuseTreatmentUnderCalWORKs | QuestionnaireResponse-CalOMSAdmission | Substance Abuse Treatment Under CalWORKs | SingleSelect |
| QRCOMSA-CountyPayingforServices | QuestionnaireResponse-CalOMSAdmission | County Paying for Services | SingleSelect |
| QRCOMSA-PrimaryDrugCode | QuestionnaireResponse-CalOMSAdmission | Primary Drug (Code) | SingleSelect |
| QRCOMSA-PrimaryDrugRouteofAdministration | QuestionnaireResponse-CalOMSAdmission | Primary Drug Route of Administration | SingleSelect |
| QRCOMSA-SecondaryDrugCode | QuestionnaireResponse-CalOMSAdmission | Secondary Drug (Code) | SingleSelect |
| QRCOMSA-SecondaryDrugRouteofAdministration | QuestionnaireResponse-CalOMSAdmission | Secondary Drug Route of Administration | SingleSelect |
| QRCOMSA-NeedleUseintheLast12Months | QuestionnaireResponse-CalOMSAdmission | Needle Use in the Last 12 Months | SingleSelect |
| QRCOMSA-EnrolledinSchool | QuestionnaireResponse-CalOMSAdmission | Enrolled in School | SingleSelect |
| QRCOMSA-HighestSchoolGradeCompleted | QuestionnaireResponse-CalOMSAdmission | Highest School Grade Completed | SingleSelect |
| QRCOMSA-EmploymentStatus | QuestionnaireResponse-CalOMSAdmission | Employment Status | SingleSelect |
| QRCOMSA-EnrolledinJobTraining | QuestionnaireResponse-CalOMSAdmission | Enrolled in Job Training | SingleSelect |
| QRCOMSA-CriminalJusticeStatus | QuestionnaireResponse-CalOMSAdmission | Criminal Justice Status | SingleSelect |
| QRCOMSA-ParoleeServicesNetworkPSN | QuestionnaireResponse-CalOMSAdmission | Parolee Services Network (PSN) | SingleSelect |
| QRCOMSA-FOTPParolee | QuestionnaireResponse-CalOMSAdmission | FOTP Parolee | SingleSelect |
| QRCOMSA-FOTPPriorityStatus | QuestionnaireResponse-CalOMSAdmission | FOTP Priority Status | SingleSelect |
| QRCOMSA-MediCalBeneficiary | QuestionnaireResponse-CalOMSAdmission | Medi-Cal Beneficiary | SingleSelect |
| QRCOMSA-Areyoucurrentlypregnant | QuestionnaireResponse-CalOMSAdmission | Are you currently pregnant? | SingleSelect |
| QRCOMSA-Whichofthefollowingmedicationisprescribed | QuestionnaireResponse-CalOMSAdmission | Which of the following medication is prescribed as part of treatment? | SingleSelect |
| QRCOMSA-CommunicableDiseasesTuberculosis | QuestionnaireResponse-CalOMSAdmission | Communicable Diseases: Tuberculosis | SingleSelect |
| QRCOMSA-CommunicableDiseasesHepatitisC | QuestionnaireResponse-CalOMSAdmission | Communicable Diseases: Hepatitis C | SingleSelect |
| QRCOMSA-CommunicableDiseasesSexuallyTransmittedDiseases | QuestionnaireResponse-CalOMSAdmission | Communicable Diseases: Sexually Transmitted Diseases | SingleSelect |
| QRCOMSA-HIVTested | QuestionnaireResponse-CalOMSAdmission | HIV Tested | SingleSelect |
| QRCOMSA-HIVTestResults | QuestionnaireResponse-CalOMSAdmission | HIV Test Results | SingleSelect |
| QRCOMSA-Haveyoueverbeendiagnosedwithamentalillness | QuestionnaireResponse-CalOMSAdmission | Have you ever been diagnosed with a mental illness? | SingleSelect |
| QRCOMSA-MentalHealthMedicationLast30Days | QuestionnaireResponse-CalOMSAdmission | Mental Health Medication Last 30 Days | SingleSelect |
| QRCOMSA-CurrentLivingArrangements | QuestionnaireResponse-CalOMSAdmission | Current Living Arrangements | SingleSelect |
| QRCOMSD-DischargeStatus | QuestionnaireResponse-CalOMSDischarge | Discharge Status | SingleSelect |
| QRCOMSD-Consent | QuestionnaireResponse-CalOMSDischarge | Consent | SingleSelect |
| QRCOMSD-Disability | QuestionnaireResponse-CalOMSDischarge | Disability | MultiSelect |
| QRCOMSD-PrimaryDrugCode | QuestionnaireResponse-CalOMSDischarge | Primary Drug (Code) | SingleSelect |
| QRCOMSD-PrimaryDrugRouteofAdministration | QuestionnaireResponse-CalOMSDischarge | Primary Drug Route of Administration | SingleSelect |
| QRCOMSD-SecondaryDrugCode | QuestionnaireResponse-CalOMSDischarge | Secondary Drug (Code) | SingleSelect |
| QRCOMSD-SecondaryDrugRouteofAdministration | QuestionnaireResponse-CalOMSDischarge | Secondary Drug Route of Administration | SingleSelect |
| QRCOMSD-EmploymentStatus | QuestionnaireResponse-CalOMSDischarge | Employment Status | SingleSelect |
| QRCOMSD-EnrolledinSchool | QuestionnaireResponse-CalOMSDischarge | Enrolled in School | SingleSelect |
| QRCOMSD-EnrolledinJobTraining | QuestionnaireResponse-CalOMSDischarge | Enrolled in Job Training | SingleSelect |
| QRCOMSD-PregnantAtAnyTimeDuringTreatment | QuestionnaireResponse-CalOMSDischarge | Pregnant At Any Time During Treatment | SingleSelect |
| QRCOMSD-HIVTested | QuestionnaireResponse-CalOMSDischarge | HIV Tested | SingleSelect |
| QRCOMSD-HIVTestResults | QuestionnaireResponse-CalOMSDischarge | HIV Test Results | SingleSelect |
| QRCOMSD-MentalIllness | QuestionnaireResponse-CalOMSDischarge | Mental Illness | SingleSelect |
| QRCOMSD-MentalHealthMedicationLast30Days | QuestionnaireResponse-CalOMSDischarge | Mental Health Medication Last 30 Days | SingleSelect |
| QRCOMSD-CurrentLivingArrangements | QuestionnaireResponse-CalOMSDischarge | Current Living Arrangements | SingleSelect |