POST v1/organization/providers/pccupdate

Update Providers (PCC EMR only): Update list of providers (physicians) defined in the organization. This can be an Add, Update, or Remove. If an Update is attempted but no provider can be found using the ProviderSearchValues or the non-null Update Values (filled in with the ProviderSearchValues as necessary), a new provider will be added. For Update and Remove actions, the ProviderSearchFields must contain values for Last Name, First Name, and NPI. For Add actions, the ProviderAddUpdateValues must contain values for Last Name, First Name, and NPI.

Request Information

URI Parameters

None.

Body Parameters

PCCProviderUpdate

Name	Description	Type	Additional information
ProviderAddUpdateValues	PCC Provider object containing data to be used for update and add actions. Non-null values will be used to update specific fields during an update. Null values will cause no update of that field to occur.	PCCProvider	None.
ProviderSearchValues	Identifies the provider field values to use for lookup/matching. This allows for PCCProviderSearchValues to be used for lookup/matching and the ProviderUpdateAddValues to be used as the update values. Only used for matching during Update and Remove actions. Ignored for Add actions. For an Add action, the values in the ProviderUpdateAddValues will be used to check for an existing provider.	PCCProviderSearchValues	None.
ProviderAction	Identifies which action to perform during update. ADD is the default action if no action is specified.	ProviderActions	None.
Location	Location (aka facility) the Provider is associated with. For an Add action, the new Provider will be associated with this Location. For an Update or Remove action, this is used in conjunction with the search values to lookup the correct Provider.	Location	None.

Request Formats

application/json, text/json

Sample:

{
  "ProviderAddUpdateValues": {
    "LastName": "sample string 1",
    "FirstName": "sample string 2",
    "NPI": "sample string 3"
  },
  "ProviderSearchValues": {
    "LastName": "sample string 1",
    "FirstName": "sample string 2",
    "NPI": "sample string 3"
  },
  "ProviderAction": 0,
  "Location": {
    "Name": "sample string 1",
    "Abbreviation": "sample string 2"
  }
}

application/xml, text/xml

Sample:

<PCCProviderUpdate xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ProviderAddUpdateValues>
    <LastName>sample string 1</LastName>
    <FirstName>sample string 2</FirstName>
    <NPI>sample string 3</NPI>
  </ProviderAddUpdateValues>
  <ProviderSearchValues>
    <LastName>sample string 1</LastName>
    <FirstName>sample string 2</FirstName>
    <NPI>sample string 3</NPI>
  </ProviderSearchValues>
  <ProviderAction>ADD</ProviderAction>
  <Location>
    <Name>sample string 1</Name>
    <Abbreviation>sample string 2</Abbreviation>
  </Location>
</PCCProviderUpdate>

Response Information

Resource Description

BaseResponse

Name	Description	Type	Additional information
Error	Will be set to True if any errors occur during the processing of the API method.	boolean	None.
ErrorMessage	Will contain an error message string if Error is True.	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Error": true,
  "ErrorMessage": "sample string 2"
}

application/xml, text/xml

Sample:

<BaseResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Error>true</Error>
  <ErrorMessage>sample string 2</ErrorMessage>
</BaseResponse>