| Retrieves cpt/hcpcs related data | Only CPT and HCPCS related data can be retrieved with this |
| Retrieves code related data | Only CPT and HCPCS related data can be retrieved with this |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| keyword | path | string | No | General keyword(s) to search on |
| codeList | path | string | No | Array of HCPCS/CPT codes to find |
| codeId | path | int | No | Single VitalWare code identifier to return |
| codeRange | path | BasePropCodeRange | No | Start and optional end code range (both strings) to search on |
| startRow | path | int | No | Return results starting at the indicated row number |
| limit | path | int | No | Maxiumum number of results to return (default is 50, maximum is 200) |
| includeDeletedCodes | path | bool | No | Whether or not to return deleted codes (default is true) |
| targetDate | path | DateTime | No | Date of service to use for versioned code data, defaults to the date of the request if not provided |
To override the Content-type in your clients, use the HTTP Accept Header, append the .soap11 suffix or ?format=soap11
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /soap11 HTTP/1.1
Host: api.vitalware.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: CptItemData
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<CptItemData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ServiceStack">
<codeId>0</codeId>
<codeList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</codeList>
<codeRange>
<codeEnd>String</codeEnd>
<codeStart>String</codeStart>
</codeRange>
<includeDeletedCodes>false</includeDeletedCodes>
<keyword>String</keyword>
<limit>0</limit>
<startRow>0</startRow>
<targetDate>0001-01-01T00:00:00</targetDate>
</CptItemData>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<CptItemDataResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ServiceStack">
<Request>
<codeId>0</codeId>
<codeList xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>String</d3p1:string>
</codeList>
<codeRange>
<codeEnd>String</codeEnd>
<codeStart>String</codeStart>
</codeRange>
<includeDeletedCodes>false</includeDeletedCodes>
<keyword>String</keyword>
<limit>0</limit>
<startRow>0</startRow>
<targetDate>0001-01-01T00:00:00</targetDate>
</Request>
<Response>
<records>
<Record>
<addOnCode>String</addOnCode>
<addedDate>String</addedDate>
<adjustedApcPayment>String</adjustedApcPayment>
<apcCode>String</apcCode>
<ascApproved>String</ascApproved>
<ascMultiProc>String</ascMultiProc>
<ascPymtAmt>String</ascPymtAmt>
<ascPymtInd>String</ascPymtInd>
<ascPymtIndDefin>String</ascPymtIndDefin>
<ascPymtWeight>String</ascPymtWeight>
<code>String</code>
<codeDisplay>String</codeDisplay>
<codeId>String</codeId>
<codeType>String</codeType>
<deletedDate>String</deletedDate>
<devReqProc>String</devReqProc>
<em51>String</em51>
<em63>String</em63>
<facMpfs>String</facMpfs>
<fdaApprovePend>String</fdaApprovePend>
<fullImpFacTotal>String</fullImpFacTotal>
<fullImpNonFacTotal>String</fullImpNonFacTotal>
<globSurg>String</globSurg>
<isDeleted>String</isDeleted>
<labFee>String</labFee>
<longDescription>String</longDescription>
<mcs>String</mcs>
<medicarePreferred>String</medicarePreferred>
<mediumDescription>String</mediumDescription>
<minUnadjRate>String</minUnadjRate>
<mpRvu>String</mpRvu>
<natPayRate>String</natPayRate>
<natUnadjRate>String</natUnadjRate>
<nonFacMpfs>String</nonFacMpfs>
<oppsFacilityPrice>String</oppsFacilityPrice>
<paymentLimit>String</paymentLimit>
<pct10>String</pct10>
<pct25>String</pct25>
<pct50>String</pct50>
<pct75>String</pct75>
<pct90>String</pct90>
<proPct10>String</proPct10>
<proPct25>String</proPct25>
<proPct50>String</proPct50>
<proPct75>String</proPct75>
<proPct90>String</proPct90>
<relativeWeight>String</relativeWeight>
<rn>String</rn>
<shortDescription>String</shortDescription>
<statusIndicator>String</statusIndicator>
<statusIndicatorDesc>String</statusIndicatorDesc>
<tranFacPeRvu>String</tranFacPeRvu>
<tranFacilityPricing>String</tranFacilityPricing>
<tranNonFacPeRvu>String</tranNonFacPeRvu>
<tranNonFacilityPricing>String</tranNonFacilityPricing>
<workRvu>String</workRvu>
</Record>
</records>
<totalCount>0</totalCount>
</Response>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
</d2p1:ResponseError>
</d2p1:Errors>
</ResponseStatus>
<ResponseXml>String</ResponseXml>
</CptItemDataResponse>
</soap:Body>
</soap:Envelope>