POST api/v1/xref/{practiceXref}/billing/providers

Update provider details, using external xref

Request Information

URI Parameters

NameDescriptionTypeAdditional information
practiceXref

string

Required

Body Parameters

Com.Healthbridge.Hhas.Billing.Interface.Commands.UpdateProviderConfigurationByExternalSystem
NameDescriptionTypeAdditional information
PracticeId

globally unique identifier

None.
PracticeXRef

string

None.
PracticeName

string

None.
PracticeNumber

string

None.
TreatingDoctorName

string

None.
TreatingPracticeNumber

string

None.
SpecialityCode

string

None.
SubSpecialityCode

string

None.
DispensingDoctor

string

None.
DispensingLicNum

string

None.
HPCSANumber

string

None.
ContactNumber

string

None.
FaxNumber

string

None.
CellphoneNumber

string

None.
EmailAddress

string

None.
PhysicalAddress

string

None.
PostalAddress

string

None.
Qualification

string

None.
KnownAs

string

None.
IsLocumProvider

boolean

None.
CorrelationIds

Collection of string

None.
OriginatedSystem

string

None.

Request Formats

application/json, text/json

Sample: 
{
  "PracticeId": "4499a4df-9a8e-4bae-8f7f-4defa4cd53ce",
  "PracticeXRef": "sample string 2",
  "PracticeName": "sample string 3",
  "PracticeNumber": "sample string 4",
  "TreatingDoctorName": "sample string 5",
  "TreatingPracticeNumber": "sample string 6",
  "SpecialityCode": "sample string 7",
  "SubSpecialityCode": "sample string 8",
  "DispensingDoctor": "sample string 9",
  "DispensingLicNum": "sample string 10",
  "HPCSANumber": "sample string 11",
  "ContactNumber": "sample string 12",
  "FaxNumber": "sample string 13",
  "CellphoneNumber": "sample string 14",
  "EmailAddress": "sample string 15",
  "PhysicalAddress": "sample string 16",
  "PostalAddress": "sample string 17",
  "Qualification": "sample string 18",
  "KnownAs": "sample string 19",
  "IsLocumProvider": true,
  "CorrelationIds": [
    "sample string 1",
    "sample string 2"
  ],
  "OriginatedSystem": "sample string 21"
}

application/xml, text/xml

Sample: 
<UpdateProviderConfigurationByExternalSystem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Hhas.Billing.Interface.Commands">
  <CorrelationIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://mpsapi.healthbridge.com/platform/core/v1/command/">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </CorrelationIds>
  <OriginatedSystem xmlns="http://mpsapi.healthbridge.com/platform/core/v1/command/">sample string 21</OriginatedSystem>
  <CellphoneNumber>sample string 14</CellphoneNumber>
  <ContactNumber>sample string 12</ContactNumber>
  <DispensingDoctor>sample string 9</DispensingDoctor>
  <DispensingLicNum>sample string 10</DispensingLicNum>
  <EmailAddress>sample string 15</EmailAddress>
  <FaxNumber>sample string 13</FaxNumber>
  <HPCSANumber>sample string 11</HPCSANumber>
  <IsLocumProvider>true</IsLocumProvider>
  <KnownAs>sample string 19</KnownAs>
  <PhysicalAddress>sample string 16</PhysicalAddress>
  <PostalAddress>sample string 17</PostalAddress>
  <PracticeId>4499a4df-9a8e-4bae-8f7f-4defa4cd53ce</PracticeId>
  <PracticeName>sample string 3</PracticeName>
  <PracticeNumber>sample string 4</PracticeNumber>
  <PracticeXRef>sample string 2</PracticeXRef>
  <Qualification>sample string 18</Qualification>
  <SpecialityCode>sample string 7</SpecialityCode>
  <SubSpecialityCode>sample string 8</SubSpecialityCode>
  <TreatingDoctorName>sample string 5</TreatingDoctorName>
  <TreatingPracticeNumber>sample string 6</TreatingPracticeNumber>
</UpdateProviderConfigurationByExternalSystem>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'System.Web.Http.ModelBinding.JQueryMvcFormUrlEncodedFormatter' to write type 'UpdateProviderConfigurationByExternalSystem'.

Response Information

Resource Description

Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects.RestApiResultOfSystem.Guid
NameDescriptionTypeAdditional information
Sucess

boolean

None.
ResponseCode

integer

None.
ResponseMessage

string

None.
Data

globally unique identifier

None.
Links

Collection of Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects.RestApiLink

None.

Response Formats

application/json, text/json

Sample: 
{
  "Sucess": true,
  "ResponseCode": 2,
  "ResponseMessage": "sample string 3",
  "Data": "d45fefe1-ff40-4ed3-97be-4b8434844085",
  "Links": [
    {
      "Rel": "sample string 1",
      "HRef": "sample string 2"
    },
    {
      "Rel": "sample string 1",
      "HRef": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample: 
<RestApiResultOfguid xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects">
  <Data>d45fefe1-ff40-4ed3-97be-4b8434844085</Data>
  <Links>
    <RestApiLink>
      <HRef>sample string 2</HRef>
      <Rel>sample string 1</Rel>
    </RestApiLink>
    <RestApiLink>
      <HRef>sample string 2</HRef>
      <Rel>sample string 1</Rel>
    </RestApiLink>
  </Links>
  <ResponseCode>2</ResponseCode>
  <ResponseMessage>sample string 3</ResponseMessage>
  <Sucess>true</Sucess>
</RestApiResultOfguid>