valuesets 0.3.1__py3-none-any.whl

valuesets/enums/health/__init__.py

@@ -0,0 +1,12 @@
+"""Health-related enums."""
+
+# Import from base health module and vaccination module
+from ..health_base import VitalStatusEnum
+from .vaccination import VaccinationStatusEnum, VaccinationPeriodicityEnum, VaccineCategoryEnum
+
+__all__ = [
+    "VitalStatusEnum",
+    "VaccinationStatusEnum",
+    "VaccinationPeriodicityEnum",
+    "VaccineCategoryEnum"
+]

valuesets/enums/health/vaccination.py

@@ -0,0 +1,98 @@
+"""
+valuesets-vaccination
+
+Vaccination-related value sets
+
+Generated from: health/vaccination.yaml
+"""
+
+from __future__ import annotations
+
+from typing import Dict, Any, Optional
+from valuesets.generators.rich_enum import RichEnum
+
+class VaccinationStatusEnum(RichEnum):
+    """
+    The vaccination status of an individual
+    """
+    # Enum members
+    VACCINATED = "VACCINATED"
+    NOT_VACCINATED = "NOT_VACCINATED"
+    FULLY_VACCINATED = "FULLY_VACCINATED"
+    PARTIALLY_VACCINATED = "PARTIALLY_VACCINATED"
+    BOOSTER = "BOOSTER"
+    UNVACCINATED = "UNVACCINATED"
+    UNKNOWN = "UNKNOWN"
+
+# Set metadata after class creation
+VaccinationStatusEnum._metadata = {
+    "VACCINATED": {'description': 'A status indicating that an individual has received a vaccination', 'meaning': 'NCIT:C28385'},
+    "NOT_VACCINATED": {'description': 'A status indicating that an individual has not received any of the required vaccinations', 'meaning': 'NCIT:C183125'},
+    "FULLY_VACCINATED": {'description': 'A status indicating that an individual has received all the required vaccinations', 'meaning': 'NCIT:C183123'},
+    "PARTIALLY_VACCINATED": {'description': 'A status indicating that an individual has received some of the required vaccinations', 'meaning': 'NCIT:C183124'},
+    "BOOSTER": {'description': 'A status indicating that an individual has received a booster vaccination', 'meaning': 'NCIT:C28320'},
+    "UNVACCINATED": {'description': 'An organismal quality that indicates an organism is unvaccinated with any vaccine', 'meaning': 'VO:0001377'},
+    "UNKNOWN": {'description': 'The vaccination status is not known', 'meaning': 'NCIT:C17998'},
+}
+
+class VaccinationPeriodicityEnum(RichEnum):
+    """
+    The periodicity or frequency of vaccination
+    """
+    # Enum members
+    SINGLE_DOSE = "SINGLE_DOSE"
+    ANNUAL = "ANNUAL"
+    SEASONAL = "SEASONAL"
+    BOOSTER = "BOOSTER"
+    PRIMARY_SERIES = "PRIMARY_SERIES"
+    PERIODIC = "PERIODIC"
+    ONE_TIME = "ONE_TIME"
+    AS_NEEDED = "AS_NEEDED"
+
+# Set metadata after class creation
+VaccinationPeriodicityEnum._metadata = {
+    "SINGLE_DOSE": {'description': 'A vaccination regimen requiring only one dose'},
+    "ANNUAL": {'description': 'Vaccination occurring once per year', 'meaning': 'NCIT:C54647'},
+    "SEASONAL": {'description': 'Vaccination occurring seasonally (e.g., for influenza)'},
+    "BOOSTER": {'description': 'A second or later vaccine dose to maintain immune response', 'meaning': 'NCIT:C28320'},
+    "PRIMARY_SERIES": {'description': 'The initial series of vaccine doses'},
+    "PERIODIC": {'description': 'Vaccination occurring at regular intervals'},
+    "ONE_TIME": {'description': 'A vaccination given only once in a lifetime'},
+    "AS_NEEDED": {'description': 'Vaccination given as needed based on exposure risk or other factors'},
+}
+
+class VaccineCategoryEnum(RichEnum):
+    """
+    The broad category or type of vaccine
+    """
+    # Enum members
+    LIVE_ATTENUATED_VACCINE = "LIVE_ATTENUATED_VACCINE"
+    INACTIVATED_VACCINE = "INACTIVATED_VACCINE"
+    CONJUGATE_VACCINE = "CONJUGATE_VACCINE"
+    MRNA_VACCINE = "MRNA_VACCINE"
+    DNA_VACCINE = "DNA_VACCINE"
+    PEPTIDE_VACCINE = "PEPTIDE_VACCINE"
+    VIRAL_VECTOR = "VIRAL_VECTOR"
+    SUBUNIT = "SUBUNIT"
+    TOXOID = "TOXOID"
+    RECOMBINANT = "RECOMBINANT"
+
+# Set metadata after class creation
+VaccineCategoryEnum._metadata = {
+    "LIVE_ATTENUATED_VACCINE": {'description': 'A vaccine made from microbes that have been weakened in the laboratory', 'meaning': 'VO:0000367'},
+    "INACTIVATED_VACCINE": {'description': 'A preparation of killed microorganisms intended to prevent infectious disease', 'meaning': 'NCIT:C29694'},
+    "CONJUGATE_VACCINE": {'description': 'A vaccine created by covalently attaching an antigen to a carrier protein', 'meaning': 'NCIT:C1455'},
+    "MRNA_VACCINE": {'description': 'A vaccine based on mRNA that encodes the antigen of interest', 'meaning': 'NCIT:C172787'},
+    "DNA_VACCINE": {'description': 'A vaccine using DNA to produce protein that promotes immune responses', 'meaning': 'NCIT:C39619'},
+    "PEPTIDE_VACCINE": {'description': 'A vaccine based on synthetic peptides', 'meaning': 'NCIT:C1752'},
+    "VIRAL_VECTOR": {'description': 'A vaccine using a modified virus as a delivery system'},
+    "SUBUNIT": {'description': 'A vaccine containing purified pieces of the pathogen'},
+    "TOXOID": {'description': 'A vaccine made from a toxin that has been made harmless'},
+    "RECOMBINANT": {'description': 'A vaccine produced using recombinant DNA technology'},
+}
+
+__all__ = [
+    "VaccinationStatusEnum",
+    "VaccinationPeriodicityEnum",
+    "VaccineCategoryEnum",
+]

valuesets/enums/health.py

@@ -0,0 +1,36 @@
+"""
+valuesets-health
+
+General health-related value sets
+
+Generated from: health.yaml
+"""
+
+from __future__ import annotations
+
+from typing import Dict, Any, Optional
+from valuesets.generators.rich_enum import RichEnum
+
+class VitalStatusEnum(RichEnum):
+    """
+    The vital status of a person or organism
+    """
+    # Enum members
+    ALIVE = "ALIVE"
+    DECEASED = "DECEASED"
+    UNKNOWN = "UNKNOWN"
+    PRESUMED_ALIVE = "PRESUMED_ALIVE"
+    PRESUMED_DECEASED = "PRESUMED_DECEASED"
+
+# Set metadata after class creation
+VitalStatusEnum._metadata = {
+    "ALIVE": {'description': 'The person is living', 'meaning': 'NCIT:C37987'},
+    "DECEASED": {'description': 'The person has died', 'meaning': 'NCIT:C28554'},
+    "UNKNOWN": {'description': 'The vital status is not known', 'meaning': 'NCIT:C17998'},
+    "PRESUMED_ALIVE": {'description': 'The person is presumed to be alive based on available information'},
+    "PRESUMED_DECEASED": {'description': 'The person is presumed to be deceased based on available information'},
+}
+
+__all__ = [
+    "VitalStatusEnum",
+]

valuesets/enums/health_base.py

@@ -0,0 +1,36 @@
+"""
+valuesets-health
+
+General health-related value sets
+
+Generated from: health.yaml
+"""
+
+from __future__ import annotations
+
+from typing import Dict, Any, Optional
+from valuesets.generators.rich_enum import RichEnum
+
+class VitalStatusEnum(RichEnum):
+    """
+    The vital status of a person or organism
+    """
+    # Enum members
+    ALIVE = "ALIVE"
+    DECEASED = "DECEASED"
+    UNKNOWN = "UNKNOWN"
+    PRESUMED_ALIVE = "PRESUMED_ALIVE"
+    PRESUMED_DECEASED = "PRESUMED_DECEASED"
+
+# Set metadata after class creation
+VitalStatusEnum._metadata = {
+    "ALIVE": {'description': 'The person is living', 'meaning': 'NCIT:C37987'},
+    "DECEASED": {'description': 'The person has died', 'meaning': 'NCIT:C28554'},
+    "UNKNOWN": {'description': 'The vital status is not known', 'meaning': 'NCIT:C17998'},
+    "PRESUMED_ALIVE": {'description': 'The person is presumed to be alive based on available information'},
+    "PRESUMED_DECEASED": {'description': 'The person is presumed to be deceased based on available information'},
+}
+
+__all__ = [
+    "VitalStatusEnum",
+]

valuesets/enums/healthcare.py

@@ -0,0 +1,45 @@
+"""
+valuesets-healthcare
+
+Common Data Model Elements
+
+Generated from: healthcare.yaml
+"""
+
+from __future__ import annotations
+
+from typing import Dict, Any, Optional
+from valuesets.generators.rich_enum import RichEnum
+
+class HealthcareEncounterClassification(RichEnum):
+    # Enum members
+    INPATIENT_VISIT = "Inpatient Visit"
+    EMERGENCY_ROOM_VISIT = "Emergency Room Visit"
+    EMERGENCY_ROOM_AND_INPATIENT_VISIT = "Emergency Room and Inpatient Visit"
+    NON_HOSPITAL_INSTITUTION_VISIT = "Non-hospital institution Visit"
+    OUTPATIENT_VISIT = "Outpatient Visit"
+    HOME_VISIT = "Home Visit"
+    TELEHEALTH_VISIT = "Telehealth Visit"
+    PHARMACY_VISIT = "Pharmacy Visit"
+    LABORATORY_VISIT = "Laboratory Visit"
+    AMBULANCE_VISIT = "Ambulance Visit"
+    CASE_MANAGEMENT_VISIT = "Case Management Visit"
+
+# Set metadata after class creation
+HealthcareEncounterClassification._metadata = {
+    "INPATIENT_VISIT": {'description': 'Person visiting hospital, at a Care Site, in bed, for duration of more than one day, with physicians and other Providers permanently available to deliver service around the clock'},
+    "EMERGENCY_ROOM_VISIT": {'description': 'Person visiting dedicated healthcare institution for treating emergencies, at a Care Site, within one day, with physicians and Providers permanently available to deliver service around the clock'},
+    "EMERGENCY_ROOM_AND_INPATIENT_VISIT": {'description': 'Person visiting ER followed by a subsequent Inpatient Visit, where Emergency department is part of hospital, and transition from the ER to other hospital departments is undefined'},
+    "NON_HOSPITAL_INSTITUTION_VISIT": {'description': 'Person visiting dedicated institution for reasons of poor health, at a Care Site, long-term or permanently, with no physician but possibly other Providers permanently available to deliver service around the clock'},
+    "OUTPATIENT_VISIT": {'description': 'Person visiting dedicated ambulatory healthcare institution, at a Care Site, within one day, without bed, with physicians or medical Providers delivering service during Visit'},
+    "HOME_VISIT": {'description': 'Provider visiting Person, without a Care Site, within one day, delivering service'},
+    "TELEHEALTH_VISIT": {'description': 'Patient engages with Provider through communication media'},
+    "PHARMACY_VISIT": {'description': 'Person visiting pharmacy for dispensing of Drug, at a Care Site, within one day'},
+    "LABORATORY_VISIT": {'description': 'Patient visiting dedicated institution, at a Care Site, within one day, for the purpose of a Measurement.'},
+    "AMBULANCE_VISIT": {'description': 'Person using transportation service for the purpose of initiating one of the other Visits, without a Care Site, within one day, potentially with Providers accompanying the Visit and delivering service'},
+    "CASE_MANAGEMENT_VISIT": {'description': 'Person interacting with healthcare system, without a Care Site, within a day, with no Providers involved, for administrative purposes'},
+}
+
+__all__ = [
+    "HealthcareEncounterClassification",
+]

valuesets/enums/industry/__init__.py

@@ -0,0 +1 @@
+"""Auto-generated package."""

valuesets/enums/industry/extractive_industry.py

@@ -0,0 +1,94 @@
+"""
+
+Generated from: industry/extractive_industry.yaml
+"""
+
+from __future__ import annotations
+
+from typing import Dict, Any, Optional
+from valuesets.generators.rich_enum import RichEnum
+
+class ExtractiveIndustryFacilityTypeEnum(RichEnum):
+    """
+    Types of extractive industry facilities
+    """
+    # Enum members
+    MINING_FACILITY = "MINING_FACILITY"
+    WELL_FACILITY = "WELL_FACILITY"
+    QUARRY_FACILITY = "QUARRY_FACILITY"
+
+# Set metadata after class creation
+ExtractiveIndustryFacilityTypeEnum._metadata = {
+    "MINING_FACILITY": {'description': 'A facility where mineral resources are extracted'},
+    "WELL_FACILITY": {'description': 'A facility where fluid resources are extracted'},
+    "QUARRY_FACILITY": {'description': 'A facility where stone, sand, or gravel are extracted'},
+}
+
+class ExtractiveIndustryProductTypeEnum(RichEnum):
+    """
+    Types of products extracted from extractive industry facilities
+    """
+    # Enum members
+    MINERAL = "MINERAL"
+    METAL = "METAL"
+    COAL = "COAL"
+    OIL = "OIL"
+    GAS = "GAS"
+    STONE = "STONE"
+    SAND = "SAND"
+    GRAVEL = "GRAVEL"
+
+# Set metadata after class creation
+ExtractiveIndustryProductTypeEnum._metadata = {
+    "MINERAL": {'description': 'A solid inorganic substance'},
+    "METAL": {'description': 'A solid metallic substance'},
+    "COAL": {'description': 'A combustible black or brownish-black sedimentary rock'},
+    "OIL": {'description': 'A liquid petroleum resource'},
+    "GAS": {'description': 'A gaseous petroleum resource'},
+    "STONE": {'description': 'A solid aggregate of minerals'},
+    "SAND": {'description': 'A granular material composed of finely divided rock and mineral particles'},
+    "GRAVEL": {'description': 'A loose aggregation of rock fragments'},
+}
+
+class MiningMethodEnum(RichEnum):
+    """
+    Methods used for extracting minerals from the earth
+    """
+    # Enum members
+    UNDERGROUND = "UNDERGROUND"
+    OPEN_PIT = "OPEN_PIT"
+    PLACER = "PLACER"
+    IN_SITU = "IN_SITU"
+
+# Set metadata after class creation
+MiningMethodEnum._metadata = {
+    "UNDERGROUND": {'description': "Extraction occurs beneath the earth's surface"},
+    "OPEN_PIT": {'description': "Extraction occurs on the earth's surface"},
+    "PLACER": {'description': 'Extraction of valuable minerals from alluvial deposits'},
+    "IN_SITU": {'description': 'Extraction without removing the ore from its original location'},
+}
+
+class WellTypeEnum(RichEnum):
+    """
+    Types of wells used for extracting fluid resources
+    """
+    # Enum members
+    OIL = "OIL"
+    GAS = "GAS"
+    WATER = "WATER"
+    INJECTION = "INJECTION"
+
+# Set metadata after class creation
+WellTypeEnum._metadata = {
+    "OIL": {'description': 'A well that primarily extracts crude oil'},
+    "GAS": {'description': 'A well that primarily extracts natural gas'},
+    "WATER": {'description': 'A well that extracts water for various purposes'},
+    "INJECTION": {'description': 'A well used to inject fluids into underground formations'},
+}
+
+__all__ = [
+    "ExtractiveIndustryFacilityTypeEnum",
+    "ExtractiveIndustryProductTypeEnum",
+    "MiningMethodEnum",
+    "WellTypeEnum",
+]