Version: 2011.01.25

Krames StayWell External Web Service Documentation

These methods have been deprecated.
Use the ListCPTCodes(), ListICD9Codes(), and ListMeSHCodes() methods instead.

ListCodes Method

This section actually consists of three separate methods. As they are very similar, they will all be described together, with differences noted. There are three different medical vocabularies used for indexing documents in the UCR. These are CPT, ICD9, and MeSH. These methods allow you to see all the codes which are mapped to documents to which you are licensed. They are not complete lists of codes from the respective vocabularies. Each of these three methods will provide a list of all the codes for either ICD9, CPT, or MeSH, but each method provides only one type. For example, the GetMeSHList method will only give a list of MeSH codes, not ICD9 or CPT codes. These methods are not generally meant for frequent use, but rather to assist clients to integrate their systems with our content. For instance, they may be used to produce a list of concept codes that an in-house application may use to match with a local database of information. Also, each of these methods will take an optional IncludeDocuments parameter which, when set to true, will list each document that is associated with each code. Also, the GetMeSHList method will list all the “names” associated with each MeSH code. The MeSH concept names are often multiple-word descriptions and each concept can have multiple synonyms. One synonym for each MeSH code is designated the primary synonym and uniquely names the MeSH concept. The GetMeSHList method has some additional search functionality described below.

Method Names:

  • GetCPTList
  • GetICD9List
  • GetMeSHList

Parameter name: XmlRequest

Alternate form for HTTP GET or HTTP POST has no parameters.

For example:
http://external.ws.staywell.com/[SiteName]/Documents.svc/GetMeSHList

Sample Request XML:

Sample for GetCPTList

<CPTListRequest IncludeDocuments=”true”/>

Sample for GetICD9List

<ICD9ListRequest IncludeDocuments=”true”/>

Samples for GetMeshList

<MeSHListRequest IncludeDocuments="true" SearchPhrase="children disease" LogicalOperator=”Or”/>
<MeSHListRequest IncludeDocuments="true" SearchPhrase="cillin" PartialWord="true"/>
<MeSHListRequest IncludeDocuments="true" SearchPhrase="children disease"/>

or

<MeSHListRequest IncludeDocuments="false" SearchPhrase="heart"/>

or

<MeSHListRequest/>

The attributes are all optional. The SearchPhrase, LogicalOperator and PartialWord attributes are only used for MeSH searches. The SearchPhrase can be an empty string (which is equivalent to no SearchPhrase attribute), or a single word, or a list of words delimited by spaces. When PartialWord is true, SearchPhrase is treated as a substring to find in the MeSH concept names. The LogicalOperator attribute cannot be supplied with PartialWord=”true”. When LogicalOperator is “And” or not present, a MeSH concept matches when one or more of its “names” contains every word in the Search Phrase. When LogicalOperator is “Or”, a MeSH concepts matches when one or more of its names contains any of the words in the Search phrase. When the PartialWord attribute is true, a MeSH concept matches when one or more of its names contains the actual substring supplied in the SearchPhrase attribute. In the sample GetMeshList response given below, a Search Phrase with “Heart” or “Disease Heart” would match and return the given Mesh code, but “Heart Cardiac” would not match, since no single Term listed has both the words Heart and Cardiac.

Sample Response XML:

for GetMeSHList

<MeSHList xmlns="http://ws.staywell.com">
	<MeSH code="D006331">
		<Term PrimaryTerm="true">Heart Diseases</Term>
		<Term PrimaryTerm="false">Cardiac Disease</Term>
		<Term PrimaryTerm="false">Cardiac Diseases</Term>
		<Term PrimaryTerm="false">Disease, Cardiac</Term>
		<Term PrimaryTerm="false">Disease, Heart</Term>
		<Term PrimaryTerm="false">Diseases, Cardiac</Term>
		<Term PrimaryTerm="false">Diseases, Heart</Term>
		<Term PrimaryTerm="false">Heart Disease</Term>
		<Document ContentTypeId="2" ContentId="backpain" IsCustom="0"/>
		<Document ContentTypeId="2" ContentId="exercise" IsCustom="0"/>
		<Document ContentTypeId="22" ContentId="carecancer" IsCustom="1"/>
	</MeSH>
</MeSHList>

for GetCPTList

<CPTList xmlns="http://ws.staywell.com">
	<CPT code="32405"/>
	<CPT code="d6602"/>
	<CPT code="j1460"/>
	<CPT code="UA"/>
</CPTList>

for GetICD9List

<ICD9List xmlns="http://ws.staywell.com">
	<ICD9 code="414.0"/>
	<ICD9 code="429.9"/>
</ICD9List>