Api reference

components.hp_dataset.public.api

get_organization_by_identifier module-attribute

get_organization_by_identifier = (
    get_organization_by_identifier
)

get_organization_by_internal_id module-attribute

get_organization_by_internal_id = (
    get_organization_by_internal_id
)

get_practitioner_by_identifier module-attribute

get_practitioner_by_identifier = (
    get_practitioner_by_identifier
)

get_practitioner_by_internal_id module-attribute

get_practitioner_by_internal_id = (
    get_practitioner_by_internal_id
)

components.hp_dataset.public.entities

Organization dataclass

Organization(
    id,
    country,
    displayable_name,
    identifiers,
    properties,
    roles=None,
)

Bases: DataClassJsonMixin

Represents an Organization — a legal entity — in the HP Dataset

country instance-attribute

country

displayable_name instance-attribute

displayable_name

id instance-attribute

id

identifiers instance-attribute

identifiers

properties instance-attribute

properties

roles class-attribute instance-attribute

roles = None

Practitioner dataclass

Practitioner(
    id,
    country,
    displayable_name,
    identifiers,
    properties,
    roles=None,
)

Bases: DataClassJsonMixin

Represents a Practitioner — an actual human being in the health system — in the HP Dataset

country instance-attribute

country

displayable_name instance-attribute

displayable_name

id instance-attribute

id

identifiers instance-attribute

identifiers

properties instance-attribute

properties

roles class-attribute instance-attribute

roles = None

PractitionerRole dataclass

PractitionerRole(
    id, organization, practitioner, identifiers, properties
)

Bases: DataClassJsonMixin

Represents a PractitionerRole — a link between a Practitioner and an Organization — in the HP Dataset

id instance-attribute

id

identifiers instance-attribute

identifiers

organization instance-attribute

organization

practitioner instance-attribute

practitioner

properties instance-attribute

properties

Property dataclass

Property(
    id,
    value,
    definition_name,
    definition_value_type,
    source_names,
)

Bases: DataClassJsonMixin

Represents a Property — a value any Practitioner, PractitionerRole or Organization can hold — in the HP Dataset

definition_name instance-attribute

definition_name

definition_value_type instance-attribute

definition_value_type

id instance-attribute

id

source_names instance-attribute

source_names

value instance-attribute

value

components.hp_dataset.public.enums

Country

Bases: AlanBaseEnum

Lists all supported countries by the dataset

BELGIUM class-attribute instance-attribute

BELGIUM = 'be'

CANADA class-attribute instance-attribute

CANADA = 'ca'

FRANCE class-attribute instance-attribute

FRANCE = 'fr'

SPAIN class-attribute instance-attribute

SPAIN = 'es'

DefinitionValueType

Bases: AlanBaseEnum

Lists all possible types of values we can have for a property.

The value_type is understood as an index or generic type, complementing the schema itself that validates the actual content and format of the value.

See https://www.notion.so/alaninsurance/Define-possible-value-types-to-accommodate-various-cases-2141426e8be7805c9ac9c16635abb1ee ⧉

ADDRESS class-attribute instance-attribute

ADDRESS = 'address'

ARRAY class-attribute instance-attribute

ARRAY = 'array'

BOOLEAN class-attribute instance-attribute

BOOLEAN = 'boolean'

CONTACT class-attribute instance-attribute

CONTACT = 'contact'

COSTS class-attribute instance-attribute

COSTS = 'costs'

DATE class-attribute instance-attribute

DATE = 'date'

DATETIME class-attribute instance-attribute

DATETIME = 'datetime'

ENUM class-attribute instance-attribute

ENUM = 'enum'

GEOLOCATION class-attribute instance-attribute

GEOLOCATION = 'geolocation'

HOURS class-attribute instance-attribute

HOURS = 'hours'

IDENTIFIER class-attribute instance-attribute

IDENTIFIER = 'identifier'

SCORE class-attribute instance-attribute

SCORE = 'score'

TEXT class-attribute instance-attribute

TEXT = 'text'

URL class-attribute instance-attribute

URL = 'url'

UUID class-attribute instance-attribute

UUID = 'uuid'

EntityType

Bases: AlanBaseEnum

Lists all possible entities that a property can be linked to

ORGANIZATION class-attribute instance-attribute

ORGANIZATION = 'organization'

PRACTITIONER class-attribute instance-attribute

PRACTITIONER = 'practitioner'

PRACTITIONER_ROLE class-attribute instance-attribute

PRACTITIONER_ROLE = 'practitioner_role'