From fb2b49d917c7b685edf8a23d194690ed339b7b5c Mon Sep 17 00:00:00 2001
From: Cabir C <64752006+Cabir40@users.noreply.github.com>
Date: Fri, 3 Mar 2023 13:39:08 +0300
Subject: [PATCH] update release notes (#13597)
---
.../licensed_release_notes.md | 61 ++++++-------------
.../release_notes_4_3_1.md | 61 ++++++-------------
2 files changed, 40 insertions(+), 82 deletions(-)
diff --git a/docs/en/spark_nlp_healthcare_versions/licensed_release_notes.md b/docs/en/spark_nlp_healthcare_versions/licensed_release_notes.md
index 5bbd6d5b787051..cb58ee695d609a 100644
--- a/docs/en/spark_nlp_healthcare_versions/licensed_release_notes.md
+++ b/docs/en/spark_nlp_healthcare_versions/licensed_release_notes.md
@@ -58,10 +58,9 @@ sample_texts = ["Hello,I'm 20 year old girl. I'm diagnosed with hyperthyroid 1 m
*Result*:
-```bash
-+--------------------+-----+----+----------------------+
+
|chunk |begin|end |ner_label |
-+--------------------+-----+----+----------------------+
+|--------------------|-----|----|----------------------|
|20 year old |10 |20 |Age |
|girl |22 |25 |Gender |
|hyperthyroid |47 |58 |Disease |
@@ -79,8 +78,7 @@ sample_texts = ["Hello,I'm 20 year old girl. I'm diagnosed with hyperthyroid 1 m
|1000 mcg |702 |709 |Dosage_Strength |
|b12 |711 |713 |Drug |
|daily |715 |719 |Frequency |
-+--------------------+-----+----+----------------------+
-```
+
@@ -116,10 +114,8 @@ sample_texts = ["He does drink occasional alcohol approximately 5 to 6 alcoholic
*Result*:
-```bash
-+----------------+-----+---+-------------------+
|chunk |begin|end|ner_label |
-+----------------+-----+---+-------------------+
+|----------------|-----|---|-------------------|
|drink |8 |12 |Alcohol |
|occasional |14 |23 |Substance_Frequency|
|alcohol |25 |31 |Alcohol |
@@ -131,8 +127,6 @@ sample_texts = ["He does drink occasional alcohol approximately 5 to 6 alcoholic
|cigarettes |34 |43 |Smoking |
|daily |45 |49 |Substance_Frequency|
|past 28 years |70 |82 |Substance_Duration |
-+----------------+-----+---+-------------------+
-```
- ner_sdoh_access_to_healthcare_wip
@@ -149,15 +143,12 @@ sample_texts = ["She has a pension and private health insurance, she reports fee
*Result*:
-```bash
-+-----------------------------+-----+---+----------------------+
|chunk |begin|end|ner_label |
-+-----------------------------+-----+---+----------------------+
+|-----------------------------|-----|---|----------------------|
|private health insurance |22 |45 |Insurance_Status |
|access to adequate healthcare|65 |93 |Access_To_Care |
|XYZ Medical Center |36 |53 |Healthcare_Institution|
-+-----------------------------+-----+---+----------------------+
-```
+
- ner_sdoh_community_condition_wip
@@ -172,17 +163,14 @@ sample_texts = ["He is currently experiencing financial stress due to job insecu
*Result*:
-```bash
-+-------------------------------+-----+---+---------------------------+
|chunk |begin|end|ner_label |
-+-------------------------------+-----+---+---------------------------+
+|-------------------------------|-----|---|---------------------------|
|small apartment |87 |101|Housing |
|green spaces |154 |165|Community_Living_Conditions|
|outdoor recreational activities|171 |201|Community_Living_Conditions|
|healthy food |37 |48 |Food_Insecurity |
|transportation |41 |54 |Transportation |
-+-------------------------------+-----+---+---------------------------+
-```
+
- ner_sdoh_health_behaviours_problems_wip
@@ -198,10 +186,9 @@ sample_texts = ["She has not been getting regular exercise and not followed diet
*Result*:
-```bash
-+--------------------+-----+---+---------------+
+
|chunk |begin|end|ner_label |
-+--------------------+-----+---+---------------+
+|--------------------|-----|---|---------------|
|regular exercise |25 |40 |Exercise |
|diet |59 |62 |Diet |
|chronic sciatic pain|99 |118|Other_Disease |
@@ -211,9 +198,7 @@ sample_texts = ["She has not been getting regular exercise and not followed diet
|elevated cholesterol|122 |141|Hyperlipidemia |
|high BP |56 |62 |Hypertension |
|disability |106 |115|Disability |
-+--------------------+-----+---+---------------+
-```
@@ -266,12 +251,12 @@ text= ["0009-4992", "57894-150"]
*Result:*
-```bash
+
| | ndc_code | drug_brand_name |
|---:|:-----------|:------------------|
| 0 | 0009-4992 | ZYVOX |
| 1 | 57894-150 | ZYTIGA |
-```
+
+ `rxnorm_nih_mapper` model maps entities with their corresponding RxNorm codes according to the National Institute of Health (NIH) database. It returns Rxnorm codes along with their NIH Rxnorm Term Types within a parenthesis.
@@ -288,15 +273,12 @@ chunkerMapper = ChunkMapperModel\
*Result*:
-```bash
-+-------------------------+-------------+-----------+
|ner_chunk |mappings |relation |
-+-------------------------+-------------+-----------+
+|-------------------------|-------------|-----------|
|Adapin 10 MG Oral Capsule|1911002 (SY) |rxnorm_code|
|acetohexamide |12250421 (IN)|rxnorm_code|
|Parlodel |829 (BN) |rxnorm_code|
-+-------------------------+-------------+-----------+
-```
+
@@ -325,17 +307,14 @@ Phone: (302) 786-5227"""
*Result*:
-```bash
-+--------------------------------+--------------------------------+------------------------------+
| sentence| masking| obfuscation|
-+-------------------------------:+-------------------------------:+-----------------------------:+
+|--------------------------------|--------------------------------|------------------------------|
| Record date: 2003-01-13| Record date: \
| Record date: 2003-03-07|
|Name : Hendrickson, Ora, Age: 25|Name : \, Age: \|Name : Manya Horsfall, Age: 20|
| MR: #7194334| MR: \| MR: #4868080|
| ID: 1231511863| ID: \| ID: 2174658035|
| Phone: (302) 786-5227| Phone:\| Phone: (467) 302-9509|
-+--------------------------------+--------------------------------+------------------------------+
-```
+
@@ -377,23 +356,22 @@ sample_text = "Mr. ABC is a 25 years old with a nonproductive cough that started
*Result for without `WhiteList`*:
-```bash
| index | ner_chunk | entity |
|-------|-------------------------|----------|
| 0 | John Smith | PATIENT |
| 1 | 25 | AGE |
| 2 | May 2006 | DATE |
| 3 | Beverley Count Hospital | HOSPITAL |
-```
+
*Result for with `WhiteList(["AGE","DATE"])`*:
-```bash
| index | ner_chunk | entity |
|-------|-------------------------|----------|
| 0 | 25 | AGE |
| 1 | May 2006 | DATE |
-```
+
+
@@ -433,6 +411,7 @@ sample_text = "Mr. ABC is a 25 years old with a nonproductive cough that started
For all Spark NLP for Healthcare models, please check: [Models Hub Page](https://nlp.johnsnowlabs.com/models?edition=Healthcare+NLP)
+
diff --git a/docs/en/spark_nlp_healthcare_versions/release_notes_4_3_1.md b/docs/en/spark_nlp_healthcare_versions/release_notes_4_3_1.md
index ee43fea60170fa..97cbb848db0221 100644
--- a/docs/en/spark_nlp_healthcare_versions/release_notes_4_3_1.md
+++ b/docs/en/spark_nlp_healthcare_versions/release_notes_4_3_1.md
@@ -58,10 +58,9 @@ sample_texts = ["Hello,I'm 20 year old girl. I'm diagnosed with hyperthyroid 1 m
*Result*:
-```bash
-+--------------------+-----+----+----------------------+
+
|chunk |begin|end |ner_label |
-+--------------------+-----+----+----------------------+
+|--------------------|-----|----|----------------------|
|20 year old |10 |20 |Age |
|girl |22 |25 |Gender |
|hyperthyroid |47 |58 |Disease |
@@ -79,8 +78,7 @@ sample_texts = ["Hello,I'm 20 year old girl. I'm diagnosed with hyperthyroid 1 m
|1000 mcg |702 |709 |Dosage_Strength |
|b12 |711 |713 |Drug |
|daily |715 |719 |Frequency |
-+--------------------+-----+----+----------------------+
-```
+
@@ -116,10 +114,8 @@ sample_texts = ["He does drink occasional alcohol approximately 5 to 6 alcoholic
*Result*:
-```bash
-+----------------+-----+---+-------------------+
|chunk |begin|end|ner_label |
-+----------------+-----+---+-------------------+
+|----------------|-----|---|-------------------|
|drink |8 |12 |Alcohol |
|occasional |14 |23 |Substance_Frequency|
|alcohol |25 |31 |Alcohol |
@@ -131,8 +127,6 @@ sample_texts = ["He does drink occasional alcohol approximately 5 to 6 alcoholic
|cigarettes |34 |43 |Smoking |
|daily |45 |49 |Substance_Frequency|
|past 28 years |70 |82 |Substance_Duration |
-+----------------+-----+---+-------------------+
-```
- ner_sdoh_access_to_healthcare_wip
@@ -149,15 +143,12 @@ sample_texts = ["She has a pension and private health insurance, she reports fee
*Result*:
-```bash
-+-----------------------------+-----+---+----------------------+
|chunk |begin|end|ner_label |
-+-----------------------------+-----+---+----------------------+
+|-----------------------------|-----|---|----------------------|
|private health insurance |22 |45 |Insurance_Status |
|access to adequate healthcare|65 |93 |Access_To_Care |
|XYZ Medical Center |36 |53 |Healthcare_Institution|
-+-----------------------------+-----+---+----------------------+
-```
+
- ner_sdoh_community_condition_wip
@@ -172,17 +163,14 @@ sample_texts = ["He is currently experiencing financial stress due to job insecu
*Result*:
-```bash
-+-------------------------------+-----+---+---------------------------+
|chunk |begin|end|ner_label |
-+-------------------------------+-----+---+---------------------------+
+|-------------------------------|-----|---|---------------------------|
|small apartment |87 |101|Housing |
|green spaces |154 |165|Community_Living_Conditions|
|outdoor recreational activities|171 |201|Community_Living_Conditions|
|healthy food |37 |48 |Food_Insecurity |
|transportation |41 |54 |Transportation |
-+-------------------------------+-----+---+---------------------------+
-```
+
- ner_sdoh_health_behaviours_problems_wip
@@ -198,10 +186,9 @@ sample_texts = ["She has not been getting regular exercise and not followed diet
*Result*:
-```bash
-+--------------------+-----+---+---------------+
+
|chunk |begin|end|ner_label |
-+--------------------+-----+---+---------------+
+|--------------------|-----|---|---------------|
|regular exercise |25 |40 |Exercise |
|diet |59 |62 |Diet |
|chronic sciatic pain|99 |118|Other_Disease |
@@ -211,9 +198,7 @@ sample_texts = ["She has not been getting regular exercise and not followed diet
|elevated cholesterol|122 |141|Hyperlipidemia |
|high BP |56 |62 |Hypertension |
|disability |106 |115|Disability |
-+--------------------+-----+---+---------------+
-```
@@ -266,12 +251,12 @@ text= ["0009-4992", "57894-150"]
*Result:*
-```bash
+
| | ndc_code | drug_brand_name |
|---:|:-----------|:------------------|
| 0 | 0009-4992 | ZYVOX |
| 1 | 57894-150 | ZYTIGA |
-```
+
+ `rxnorm_nih_mapper` model maps entities with their corresponding RxNorm codes according to the National Institute of Health (NIH) database. It returns Rxnorm codes along with their NIH Rxnorm Term Types within a parenthesis.
@@ -288,15 +273,12 @@ chunkerMapper = ChunkMapperModel\
*Result*:
-```bash
-+-------------------------+-------------+-----------+
|ner_chunk |mappings |relation |
-+-------------------------+-------------+-----------+
+|-------------------------|-------------|-----------|
|Adapin 10 MG Oral Capsule|1911002 (SY) |rxnorm_code|
|acetohexamide |12250421 (IN)|rxnorm_code|
|Parlodel |829 (BN) |rxnorm_code|
-+-------------------------+-------------+-----------+
-```
+
@@ -325,17 +307,14 @@ Phone: (302) 786-5227"""
*Result*:
-```bash
-+--------------------------------+--------------------------------+------------------------------+
| sentence| masking| obfuscation|
-+-------------------------------:+-------------------------------:+-----------------------------:+
+|--------------------------------|--------------------------------|------------------------------|
| Record date: 2003-01-13| Record date: \
| Record date: 2003-03-07|
|Name : Hendrickson, Ora, Age: 25|Name : \, Age: \|Name : Manya Horsfall, Age: 20|
| MR: #7194334| MR: \| MR: #4868080|
| ID: 1231511863| ID: \| ID: 2174658035|
| Phone: (302) 786-5227| Phone:\| Phone: (467) 302-9509|
-+--------------------------------+--------------------------------+------------------------------+
-```
+
@@ -377,23 +356,22 @@ sample_text = "Mr. ABC is a 25 years old with a nonproductive cough that started
*Result for without `WhiteList`*:
-```bash
| index | ner_chunk | entity |
|-------|-------------------------|----------|
| 0 | John Smith | PATIENT |
| 1 | 25 | AGE |
| 2 | May 2006 | DATE |
| 3 | Beverley Count Hospital | HOSPITAL |
-```
+
*Result for with `WhiteList(["AGE","DATE"])`*:
-```bash
| index | ner_chunk | entity |
|-------|-------------------------|----------|
| 0 | 25 | AGE |
| 1 | May 2006 | DATE |
-```
+
+
@@ -434,6 +412,7 @@ sample_text = "Mr. ABC is a 25 years old with a nonproductive cough that started
For all Spark NLP for Healthcare models, please check: [Models Hub Page](https://nlp.johnsnowlabs.com/models?edition=Healthcare+NLP)
+
## Versions