GET api/Hcps/GetHcpDetail/{hcpId}

Provide further details about a specific HCP, including all practices and locations, state license number, NPI, etc. As the GetHcpDetails operations takes the ID of the HCP as an argument, the call to this operation usually follows a call to GetHcps, the response to which the HCP IDs are provided.

Request Information

URI Parameters

Name	Description	Type	Additional information
hcpId	The ID of the HCP as returned in the GetHcps response.	integer	Required

Body Parameters

None.

Response Information

Resource Description

JSON representing an HcpDetailResults object. See detailed documentation for JSON format.

HcpDetailResults

Name	Description	Type	Additional information
Status	Property that contains a Status object, indicating the status of the request	Status	None.
HCPDetail	Property containing the returned HcpDetail object matching the specified HCP ID	HcpDetail	None.

Response Formats

application/json, text/json

Sample:

{
  "Status": {
    "StatusCode": 1,
    "StatusMessage": "sample string 2"
  },
  "HCPDetail": {
    "FirstName": "sample string 1",
    "MiddleName": "sample string 2",
    "LastName": "sample string 3",
    "Suffix": "sample string 4",
    "Specialty": "sample string 5",
    "NPI": "sample string 6",
    "REMS_ID": "sample string 7",
    "IsPriority": true,
    "Practices": [
      {
        "PracticeID": 1,
        "Name": "sample string 2",
        "WebsiteURL": "sample string 3",
        "Locations": [
          {
            "LocationID": 1,
            "StreetAddress1": "sample string 2",
            "StreetAddress2": "sample string 3",
            "City": "sample string 4",
            "State": "sample string 5",
            "ZipCode": "sample string 6",
            "Phone": "sample string 7",
            "Fax": "sample string 8",
            "EmailAddress": "sample string 9",
            "Latitude": 10.0,
            "Longitude": 11.0,
            "Distance": 1.1
          },
          {
            "LocationID": 1,
            "StreetAddress1": "sample string 2",
            "StreetAddress2": "sample string 3",
            "City": "sample string 4",
            "State": "sample string 5",
            "ZipCode": "sample string 6",
            "Phone": "sample string 7",
            "Fax": "sample string 8",
            "EmailAddress": "sample string 9",
            "Latitude": 10.0,
            "Longitude": 11.0,
            "Distance": 1.1
          }
        ]
      },
      {
        "PracticeID": 1,
        "Name": "sample string 2",
        "WebsiteURL": "sample string 3",
        "Locations": [
          {
            "LocationID": 1,
            "StreetAddress1": "sample string 2",
            "StreetAddress2": "sample string 3",
            "City": "sample string 4",
            "State": "sample string 5",
            "ZipCode": "sample string 6",
            "Phone": "sample string 7",
            "Fax": "sample string 8",
            "EmailAddress": "sample string 9",
            "Latitude": 10.0,
            "Longitude": 11.0,
            "Distance": 1.1
          },
          {
            "LocationID": 1,
            "StreetAddress1": "sample string 2",
            "StreetAddress2": "sample string 3",
            "City": "sample string 4",
            "State": "sample string 5",
            "ZipCode": "sample string 6",
            "Phone": "sample string 7",
            "Fax": "sample string 8",
            "EmailAddress": "sample string 9",
            "Latitude": 10.0,
            "Longitude": 11.0,
            "Distance": 1.1
          }
        ]
      }
    ]
  }
}

application/xml, text/xml

Sample:

<HcpDetailResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MDLocatorService.Models">
  <HCPDetail>
    <FirstName>sample string 1</FirstName>
    <IsPriority>true</IsPriority>
    <LastName>sample string 3</LastName>
    <MiddleName>sample string 2</MiddleName>
    <NPI>sample string 6</NPI>
    <Practices>
      <Practice>
        <Locations>
          <Location>
            <City>sample string 4</City>
            <Distance>1.1</Distance>
            <EmailAddress>sample string 9</EmailAddress>
            <Fax>sample string 8</Fax>
            <Latitude>10</Latitude>
            <LocationID>1</LocationID>
            <Longitude>11</Longitude>
            <Phone>sample string 7</Phone>
            <State>sample string 5</State>
            <StreetAddress1>sample string 2</StreetAddress1>
            <StreetAddress2>sample string 3</StreetAddress2>
            <ZipCode>sample string 6</ZipCode>
          </Location>
          <Location>
            <City>sample string 4</City>
            <Distance>1.1</Distance>
            <EmailAddress>sample string 9</EmailAddress>
            <Fax>sample string 8</Fax>
            <Latitude>10</Latitude>
            <LocationID>1</LocationID>
            <Longitude>11</Longitude>
            <Phone>sample string 7</Phone>
            <State>sample string 5</State>
            <StreetAddress1>sample string 2</StreetAddress1>
            <StreetAddress2>sample string 3</StreetAddress2>
            <ZipCode>sample string 6</ZipCode>
          </Location>
        </Locations>
        <Name>sample string 2</Name>
        <PracticeID>1</PracticeID>
        <WebsiteURL>sample string 3</WebsiteURL>
      </Practice>
      <Practice>
        <Locations>
          <Location>
            <City>sample string 4</City>
            <Distance>1.1</Distance>
            <EmailAddress>sample string 9</EmailAddress>
            <Fax>sample string 8</Fax>
            <Latitude>10</Latitude>
            <LocationID>1</LocationID>
            <Longitude>11</Longitude>
            <Phone>sample string 7</Phone>
            <State>sample string 5</State>
            <StreetAddress1>sample string 2</StreetAddress1>
            <StreetAddress2>sample string 3</StreetAddress2>
            <ZipCode>sample string 6</ZipCode>
          </Location>
          <Location>
            <City>sample string 4</City>
            <Distance>1.1</Distance>
            <EmailAddress>sample string 9</EmailAddress>
            <Fax>sample string 8</Fax>
            <Latitude>10</Latitude>
            <LocationID>1</LocationID>
            <Longitude>11</Longitude>
            <Phone>sample string 7</Phone>
            <State>sample string 5</State>
            <StreetAddress1>sample string 2</StreetAddress1>
            <StreetAddress2>sample string 3</StreetAddress2>
            <ZipCode>sample string 6</ZipCode>
          </Location>
        </Locations>
        <Name>sample string 2</Name>
        <PracticeID>1</PracticeID>
        <WebsiteURL>sample string 3</WebsiteURL>
      </Practice>
    </Practices>
    <REMS_ID>sample string 7</REMS_ID>
    <Specialty>sample string 5</Specialty>
    <Suffix>sample string 4</Suffix>
  </HCPDetail>
  <Status>
    <StatusCode>1</StatusCode>
    <StatusMessage>sample string 2</StatusMessage>
  </Status>
</HcpDetailResults>