VitalWare API

<back to all web services

SherpaConceptInformation

The following routes are available for this service:
GET POST/sherpaConceptInformationGet concept Info for a Concept ID
GET POST/sherpaConceptInformation/{conceptBaseId}Get XML concept Info for a Concept IDConcept Base ID can be directly within the URL as part of the path
Parameters:
NameParameterData TypeRequiredDescription
conceptBaseIdpathintNoThe conceptBaseId of the concept to find information on

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/SherpaConceptInformation HTTP/1.1 
Host: api.vitalware.com 
Content-Type: application/xml
Content-Length: length

<SherpaConceptInformation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ServiceStack">
  <conceptBaseId>0</conceptBaseId>
</SherpaConceptInformation>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SherpaConceptInformationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ServiceStack">
  <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>
  <request>
    <conceptBaseId>0</conceptBaseId>
  </request>
  <result>
    <Messages>
      <SherpaMessage>
        <Message>String</Message>
      </SherpaMessage>
    </Messages>
    <Results>
      <Instructions>
        <InstructionType>
          <SherpaInstructionType>
            <Instruction>
              <SherpaInstruction>
                <codeRanges>String</codeRanges>
                <instruction>String</instruction>
              </SherpaInstruction>
            </Instruction>
            <type>String</type>
          </SherpaInstructionType>
        </InstructionType>
        <type>String</type>
      </Instructions>
      <SelectedConcepts>
        <ConceptType>
          <SherpaConceptType>
            <Concepts>
              <Concept>
                <SherpaConcept>
                  <count>0</count>
                  <desc>String</desc>
                  <hasInfo>false</hasInfo>
                  <id>0</id>
                </SherpaConcept>
              </Concept>
            </Concepts>
            <count>0</count>
            <type>String</type>
            <typeID>0</typeID>
          </SherpaConceptType>
        </ConceptType>
      </SelectedConcepts>
      <SelectedDiagnosisPageset>
        <Diagnosis>
          <SherpaDiagnosis>
            <code>String</code>
            <codeAlt>String</codeAlt>
            <desc>String</desc>
            <id>0</id>
          </SherpaDiagnosis>
        </Diagnosis>
      </SelectedDiagnosisPageset>
      <SelectedDiagnosisTotal>
        <count>0</count>
      </SelectedDiagnosisTotal>
      <infoNodes>
        <Info>
          <SherpaResultInfo>
            <description>String</description>
            <label>String</label>
            <title>String</title>
            <type>String</type>
            <typeID>0</typeID>
          </SherpaResultInfo>
        </Info>
      </infoNodes>
    </Results>
  </result>
</SherpaConceptInformationResponse>