medkit.text.ner.adicap_norm_attribute
=====================================

.. py:module:: medkit.text.ner.adicap_norm_attribute


Classes
-------

.. autoapisummary::

   medkit.text.ner.adicap_norm_attribute.ADICAPNormAttribute


Module Contents
---------------

.. py:class:: ADICAPNormAttribute(code: str, sampling_mode: str | None = None, technic: str | None = None, organ: str | None = None, pathology: str | None = None, pathology_type: str | None = None, behaviour_type: str | None = None, metadata: dict[str, Any] | None = None, uid: str | None = None)

   Bases: :py:obj:`medkit.core.text.EntityNormAttribute`


   
   Attribute describing tissue sample using the ADICAP coding.

   ADICAP: Association pour le Développement de l'Informatique en Cytologie et Anatomo-Pathologie

   :see: https://smt.esante.gouv.fr/wp-json/ans/terminologies/document?terminologyId=terminologie-adicap&fileName=cgts_sem_adicap_fiche-detaillee.pdf

   This class is replicating EDS-NLP's `Adicap` class, making it a medkit
   `Attribute`.

   The `code` field fully describes the tissue sample. Additional information
   is derived from `code` in human readable fields (`sampling_code`,
   `technic`, `organ`, `pathology`, `pathology_type`, `behaviour_type`)













   :Attributes:

       **uid:**
           Identifier of the attribute

       **label:**
           The attribute label, always set to :attr:`EntityNormAttribute.LABEL
           <.core.text.EntityNormAttribute.LABEL>`

       **value:**
           ADICAP code prefix with "adicap:" (ex: "adicap:BHGS0040")

       **code:**
           ADICAP code as a string (ex: "BHGS0040")

       **kb_id:**
           Same as `code`

       **sampling_mode:**
           Sampling mode (ex: "BIOPSIE CHIRURGICALE")

       **technic:**
           Sampling technic (ex: "HISTOLOGIE ET CYTOLOGIE PAR INCLUSION")

       **organ:**
           Organ and regions (ex: "SEIN (ÉGALEMENT UTILISÉ CHEZ L'HOMME)")

       **pathology:**
           General pathology (ex: "PATHOLOGIE GÉNÉRALE NON TUMORALE")

       **pathology_type:**
           Pathology type (ex: "ETAT SUBNORMAL - LESION MINEURE")

       **behaviour_type:**
           Behaviour type (ex: "CARACTERES GENERAUX")

       **metadata:**
           Metadata of the attribute


   ..
       !! processed by numpydoc !!

   .. py:attribute:: sampling_mode
      :type:  str | None


   .. py:attribute:: technic
      :type:  str | None


   .. py:attribute:: organ
      :type:  str | None


   .. py:attribute:: pathology
      :type:  str | None


   .. py:attribute:: pathology_type
      :type:  str | None


   .. py:attribute:: behaviour_type
      :type:  str | None


   .. py:property:: code
      :type: str



   .. py:method:: to_dict() -> dict[str, Any]


   .. py:method:: from_dict(adicap_dict: dict[str, Any]) -> typing_extensions.Self
      :classmethod:


      
      Create an Attribute from a dict.


      :Parameters:

          **attribute_dict: dict of str to Any**
              A dictionary from a serialized Attribute as generated by to_dict()














      ..
          !! processed by numpydoc !!