BSTSNDET.m

BSTSNDET ;GDIT/HS/BEE-Get Concept Detail - Documentation ; 15 Nov 2012  4:26 PM

 ;;2.0;IHS STANDARD TERMINOLOGY;;Dec 01, 2016;Build 62

 Q

 ;

 ;This routine documents the detail return from various BSTS API calls including

 ;$$SEARCH, $$CNCLKP, $$DSCLKP, $$DTSLKP, $$VALTERM

 ;

 ;Output

 ; Function returns - # Records Returned

 ;

 ; VAR(#) - List of Records

 ;

 ; The VAR(#) list of records returns the following sections

 ;

 ;Abnormal Prompt

 ; VAR(#,"ABN")=1 - Prompt for Abnormal/Normal/0 - Do not prompt

 ;

 ;Child Information - Multiple Records Returned (CTR)

 ; VAR(#,"CHD",CTR,"CON")=Concept Id of Child Term (may be blank prior to detail lookup)

 ; VAR(#,"CHD",CTR,"DTS")=DTSId of the Child Term

 ; VAR(#,"CHD",CTR,"TRM")=Child Term Name

 ; VAR(#,"CHD",CTR,"XADT")=Date Added

 ; VAR(#,"CHD",CTR,"XRDT")=Date Retired

 ;

 ;Common Concept?

 ; VAR(#,"CMN")=1 - Yes/0 - No

 ;

 ;Concept ID/DTSID

 ; VAR(#,"CON")=Concept Id

 ; VAR(#,"DTS")=Internal DTS Id

 ;

 ;Is Episodicity Required

 ; VAR(#,"EPI")=1 - Required/0 - Not Required

 ;

 ;Equivalent concept children

 ; VAR(#,"EQC",CTR,"CON")=Concept Id of Equivalent Child

 ; VAR(#,"EQC",CTR,"DTS")=DTSId of Equivalent Child

 ; VAR(#,"EQC",CTR,"XADT")=Date Added

 ; VAR(#,"EQC",CTR,"XRDT")=Date Retired

 ;

 ;Equivalent matching concept

 ; VAR(#,"EQM","LAT")=Laterality of exact match

 ; VAR(#,"EQM","DTS")=DTSId of exact match

 ; VAR(#,"EQM","CON")=Concept Id of exact match

 ; VAR(#,"EQM","XADT")=Date Added

 ; VAR(#,"EQM","XRDT")=Date Retired

 ;

 ;Fully Specified Name

 ; VAR(#,"FSN","DSC")=Description Id of the FSN

 ; VAR(#,"FSN","TRM")=Fully Specified Name

 ; VAR(#,"FSN","XADT")=Date Added

 ; VAR(#,"FSN","XRDT")=Date Retired

 ;

 ;Healing Prompt Selections

 ; VAR(#,"HEAL")="RD/RDN/RDNM/Null for No Prompt

 ;

 ;ICD9 Mapping Information - Multiple Records Returned (CTR)

 ; VAR(#,"IC9",CTR,"COD")=ICD9 Code

 ; VAR(#,"IC9",CTR,"TYP")=Code Type(IC9)

 ; VAR(#,"IC9",CTR,"XADT")=Date Added

 ; VAR(#,"IC9",CTR,"XRDT")=Date Retired

 ;

 ;ICD Mapping Information - Multiple Records Returned (CTR)

 ; VAR(#,"ICD",CTR,"COD")=ICD9/ICD10 Code

 ; VAR(#,"ICD",CTR,"TYP")=Code Type(ICD)

 ; VAR(#,"ICD",CTR,"XADT")=Date Added

 ; VAR(#,"ICD",CTR,"XRDT")=Date Retired

 ;

 ;IsA Information - Multiple Records Returned (CTR)

 ; VAR(#,"ISA",CTR,"CON")=Concept Id of IsA Term (may be blank prior to detail lookup)

 ; VAR(#,"ISA",CTR,"DTS")=DTSId of the IsA Term

 ; VAR(#,"ISA",CTR,"TRM")=IsA Term Name

 ; VAR(#,"ISA",CTR,"XADT")=Date Added

 ; VAR(#,"ISA",CTR,"XRDT")=Date Retired

 ;

 ;Prompt for laterality

 ; VAR(#,"LAT")=1 - Prompt/0 - Do not prompt

 ;

 ;Lookup Problem Column Value (Fully Specified Name or a Synonym/Preferred Term)

 ;(Based on Search Type parameter - F/S)

 ; VAR(#,"PRB","DSC")=Description Id of a Pref Term (Type F) or Synonym/Pref Term (S)

 ; VAR(#,"PRB","TRM")=Preferred term of a Concept (F) or a Synonym (S)

 ;

 ;Preferred Term Information

 ; VAR(#,"PRE","DSC")=Description ID of Preferred Term

 ; VAR(#,"PRE","TRM")=Preferred Term

 ; VAR(#,"PRE","XADT")=Date Added

 ; VAR(#,"PRE","XRDT")=Date Retired

 ;

 ;Default Concept Status

 ; VAR(#,"STS")=Chronic/Personal History/Sub-acute/Admin/Social

 ;

 ;Subset Information - Multiple Records Returned (CTR)

 ; VAR(#,"SUB",CTR,"SUB")=Subset Name

 ; VAR(#,"SUB",CTR,"XADT")=Date Added

 ; VAR(#,"SUB",CTR,"XRDT")=Date Retired

 ;

 ;Synonym Information - Multiple Records Returned (CTR)

 ; VAR(#,"SYN",CTR,"DSC")=Description ID of Synonym

 ; VAR(#,"SYN",CTR,"TRM")=Synonym Term

 ; VAR(#,"SYN",CTR,"XADT")=Date Added

 ; VAR(#,"SYN",CTR,"XRDT")=Date Retired

 ;

 ;Association Information (SNOMED) - Multiple Records Returned (CTR)

 ; VAR(#,"ASM",CTR,"CON")=SNOMED Concept CT Association

 ; VAR(#,"ASM",CTR,"DTS")=DTSId of the SNOMED Concept

 ;

 ;Association Information (RxNorm) - Multiple Records Returned (CTR)

 ; VAR(#,"ARX",CTR,"CON")=RxNorm Code Value Association

 ; VAR(#,"ARX",CTR,"DTS")=DTSId of the RxNorm Concept

 ;

 ;Association Information (UNII) - Multiple Records Returned (CTR)

 ; VAR(#,"ASN",CTR,"CON")=UNII Code Value Association

 ; VAR(#,"ASN",CTR,"DTS")=DTSId of the UNII Concept

 ;

 ;Inverse Association Information (RxNorm) - Multiple Records Returned (CTR)

 ; VAR(#,"IAR",CTR,"CON")=RxNorm Code Value of Inverse Association

 ; VAR(#,"IAR",CTR,"DTS")=DTSId of the RxNorm Concept

 ; VAR(#,"IAR",CTR,"TRM")=Inverse Association Term

 ;

 ;Date Concept Added/Retired

 ; VAR(#,"XADT")=Date Added

 ; VAR(#,"XRDT")=Date Retired

 ;

 ;RxNorm Only - TTY

 ; VAR(#,"TTY",CTR,"TTY")=TTY Code

 ; VAR(#,"TTY",CTR,"XADT")=Date Added

 ; VAR(#,"TTY",CTR,"XRDT")=Date Retired

BSTSNDET  ;GDIT/HS/BEE-Get Concept Detail - Documentation ; 15 Nov 2012  4:26 PM

 +1       ;;2.0;IHS STANDARD TERMINOLOGY;;Dec 01, 2016;Build 62

 +2        QUIT 

 +3       ;

 +4       ;This routine documents the detail return from various BSTS API calls including

 +5       ;$$SEARCH, $$CNCLKP, $$DSCLKP, $$DTSLKP, $$VALTERM

 +6       ;

 +7       ;Output

 +8       ; Function returns - # Records Returned

 +9       ;

 +10      ; VAR(#) - List of Records

 +11      ;

 +12      ; The VAR(#) list of records returns the following sections

 +13      ;

 +14      ;Abnormal Prompt

 +15      ; VAR(#,"ABN")=1 - Prompt for Abnormal/Normal/0 - Do not prompt

 +16      ;

 +17      ;Child Information - Multiple Records Returned (CTR)

 +18      ; VAR(#,"CHD",CTR,"CON")=Concept Id of Child Term (may be blank prior to detail lookup)

 +19      ; VAR(#,"CHD",CTR,"DTS")=DTSId of the Child Term

 +20      ; VAR(#,"CHD",CTR,"TRM")=Child Term Name

 +21      ; VAR(#,"CHD",CTR,"XADT")=Date Added

 +22      ; VAR(#,"CHD",CTR,"XRDT")=Date Retired

 +23      ;

 +24      ;Common Concept?

 +25      ; VAR(#,"CMN")=1 - Yes/0 - No

 +26      ;

 +27      ;Concept ID/DTSID

 +28      ; VAR(#,"CON")=Concept Id

 +29      ; VAR(#,"DTS")=Internal DTS Id

 +30      ;

 +31      ;Is Episodicity Required

 +32      ; VAR(#,"EPI")=1 - Required/0 - Not Required

 +33      ;

 +34      ;Equivalent concept children

 +35      ; VAR(#,"EQC",CTR,"CON")=Concept Id of Equivalent Child

 +36      ; VAR(#,"EQC",CTR,"DTS")=DTSId of Equivalent Child

 +37      ; VAR(#,"EQC",CTR,"XADT")=Date Added

 +38      ; VAR(#,"EQC",CTR,"XRDT")=Date Retired

 +39      ;

 +40      ;Equivalent matching concept

 +41      ; VAR(#,"EQM","LAT")=Laterality of exact match

 +42      ; VAR(#,"EQM","DTS")=DTSId of exact match

 +43      ; VAR(#,"EQM","CON")=Concept Id of exact match

 +44      ; VAR(#,"EQM","XADT")=Date Added

 +45      ; VAR(#,"EQM","XRDT")=Date Retired

 +46      ;

 +47      ;Fully Specified Name

 +48      ; VAR(#,"FSN","DSC")=Description Id of the FSN

 +49      ; VAR(#,"FSN","TRM")=Fully Specified Name

 +50      ; VAR(#,"FSN","XADT")=Date Added

 +51      ; VAR(#,"FSN","XRDT")=Date Retired

 +52      ;

 +53      ;Healing Prompt Selections

 +54      ; VAR(#,"HEAL")="RD/RDN/RDNM/Null for No Prompt

 +55      ;

 +56      ;ICD9 Mapping Information - Multiple Records Returned (CTR)

 +57      ; VAR(#,"IC9",CTR,"COD")=ICD9 Code

 +58      ; VAR(#,"IC9",CTR,"TYP")=Code Type(IC9)

 +59      ; VAR(#,"IC9",CTR,"XADT")=Date Added

 +60      ; VAR(#,"IC9",CTR,"XRDT")=Date Retired

 +61      ;

 +62      ;ICD Mapping Information - Multiple Records Returned (CTR)

 +63      ; VAR(#,"ICD",CTR,"COD")=ICD9/ICD10 Code

 +64      ; VAR(#,"ICD",CTR,"TYP")=Code Type(ICD)

 +65      ; VAR(#,"ICD",CTR,"XADT")=Date Added

 +66      ; VAR(#,"ICD",CTR,"XRDT")=Date Retired

 +67      ;

 +68      ;IsA Information - Multiple Records Returned (CTR)

 +69      ; VAR(#,"ISA",CTR,"CON")=Concept Id of IsA Term (may be blank prior to detail lookup)

 +70      ; VAR(#,"ISA",CTR,"DTS")=DTSId of the IsA Term

 +71      ; VAR(#,"ISA",CTR,"TRM")=IsA Term Name

 +72      ; VAR(#,"ISA",CTR,"XADT")=Date Added

 +73      ; VAR(#,"ISA",CTR,"XRDT")=Date Retired

 +74      ;

 +75      ;Prompt for laterality

 +76      ; VAR(#,"LAT")=1 - Prompt/0 - Do not prompt

 +77      ;

 +78      ;Lookup Problem Column Value (Fully Specified Name or a Synonym/Preferred Term)

 +79      ;(Based on Search Type parameter - F/S)

 +80      ; VAR(#,"PRB","DSC")=Description Id of a Pref Term (Type F) or Synonym/Pref Term (S)

 +81      ; VAR(#,"PRB","TRM")=Preferred term of a Concept (F) or a Synonym (S)

 +82      ;

 +83      ;Preferred Term Information

 +84      ; VAR(#,"PRE","DSC")=Description ID of Preferred Term

 +85      ; VAR(#,"PRE","TRM")=Preferred Term

 +86      ; VAR(#,"PRE","XADT")=Date Added

 +87      ; VAR(#,"PRE","XRDT")=Date Retired

 +88      ;

 +89      ;Default Concept Status

 +90      ; VAR(#,"STS")=Chronic/Personal History/Sub-acute/Admin/Social

 +91      ;

 +92      ;Subset Information - Multiple Records Returned (CTR)

 +93      ; VAR(#,"SUB",CTR,"SUB")=Subset Name

 +94      ; VAR(#,"SUB",CTR,"XADT")=Date Added

 +95      ; VAR(#,"SUB",CTR,"XRDT")=Date Retired

 +96      ;

 +97      ;Synonym Information - Multiple Records Returned (CTR)

 +98      ; VAR(#,"SYN",CTR,"DSC")=Description ID of Synonym

 +99      ; VAR(#,"SYN",CTR,"TRM")=Synonym Term

 +100     ; VAR(#,"SYN",CTR,"XADT")=Date Added

 +101     ; VAR(#,"SYN",CTR,"XRDT")=Date Retired

 +102     ;

 +103     ;Association Information (SNOMED) - Multiple Records Returned (CTR)

 +104     ; VAR(#,"ASM",CTR,"CON")=SNOMED Concept CT Association

 +105     ; VAR(#,"ASM",CTR,"DTS")=DTSId of the SNOMED Concept

 +106     ;

 +107     ;Association Information (RxNorm) - Multiple Records Returned (CTR)

 +108     ; VAR(#,"ARX",CTR,"CON")=RxNorm Code Value Association

 +109     ; VAR(#,"ARX",CTR,"DTS")=DTSId of the RxNorm Concept

 +110     ;

 +111     ;Association Information (UNII) - Multiple Records Returned (CTR)

 +112     ; VAR(#,"ASN",CTR,"CON")=UNII Code Value Association

 +113     ; VAR(#,"ASN",CTR,"DTS")=DTSId of the UNII Concept

 +114     ;

 +115     ;Inverse Association Information (RxNorm) - Multiple Records Returned (CTR)

 +116     ; VAR(#,"IAR",CTR,"CON")=RxNorm Code Value of Inverse Association

 +117     ; VAR(#,"IAR",CTR,"DTS")=DTSId of the RxNorm Concept

 +118     ; VAR(#,"IAR",CTR,"TRM")=Inverse Association Term

 +119     ;

 +120     ;Date Concept Added/Retired

 +121     ; VAR(#,"XADT")=Date Added

 +122     ; VAR(#,"XRDT")=Date Retired

 +123     ;

 +124     ;RxNorm Only - TTY

 +125     ; VAR(#,"TTY",CTR,"TTY")=TTY Code

 +126     ; VAR(#,"TTY",CTR,"XADT")=Date Added

 +127     ; VAR(#,"TTY",CTR,"XRDT")=Date Retired