POST api/v1/infrastructure/providers/{tenantXRef}/add?sendUserCredentialsToProvider={sendUserCredentialsToProvider}

Setup doctor environment (create ProviderConfiguration, register user, insert default templates, etc)

Request Information

URI Parameters

Name	Description	Type	Additional information
sendUserCredentialsToProvider	indicate whether we need to user credentials via email directly to doctor	boolean	Required
tenantXRef	the tenant for the provider (i.e. the Xref for the practice/business)	string	Required

Body Parameters

Command object with provider configuration and other fields needed

Com.Healthbridge.Hhas.Billing.Interface.ValueObjects.ProviderConfigurationVo

Name	Type	Additional information
PracticeId	globally unique identifier	None.
PracticeTenantId	globally unique identifier	None.
PracticeXRef	string	None.
BranchXRef	string	None.
PracticeName	string	None.
SpecialityCode	string	None.
SubSpecialityCode	string	None.
PracticeNumber	string	None.
BillingIdentifier	string	None.
BillingStatus	string	None.
BillingStartDate	date	None.
BillingEndDate	date	None.
TreatingPracticeNumber	string	None.
TreatingDoctorName	string	None.
DispensingDoctor	string	None.
DispensingLicNum	string	None.
HPCSANumber	string	None.
Qualification	string	None.
SpecialityDescription	string	None.
TelephoneNumber	string	None.
FaxNumber	string	None.
CellphoneNumber	string	None.
EmailAddress	string	None.
PhysicalAddress	string	None.
PostalAddress	string	None.
ContactNumber	string	None.
NetworkedSchemes	Collection of string	None.
ManualPricingSchemes	Collection of string	None.
Options	Dictionary of string [key] and string [value]	None.
LastUpdatedDate	date	None.
IsLocumProvider	boolean	None.
KnownAs	string	None.

Request Formats

application/json, text/json

Sample:

{
  "PracticeId": "63ca33b5-a4c0-46cc-9b4d-97057e3bad43",
  "PracticeTenantId": "014f2125-3c67-414c-a040-e0528c73907d",
  "PracticeXRef": "sample string 2",
  "BranchXRef": "sample string 3",
  "PracticeName": "sample string 4",
  "SpecialityCode": "sample string 5",
  "SubSpecialityCode": "sample string 6",
  "PracticeNumber": "sample string 7",
  "BillingIdentifier": "sample string 8",
  "BillingStatus": "sample string 9",
  "BillingStartDate": "2025-04-11T04:45:36Z",
  "BillingEndDate": "2025-04-11T04:45:36Z",
  "TreatingPracticeNumber": "sample string 10",
  "TreatingDoctorName": "sample string 11",
  "DispensingDoctor": "sample string 12",
  "DispensingLicNum": "sample string 13",
  "HPCSANumber": "sample string 14",
  "Qualification": "sample string 15",
  "SpecialityDescription": "sample string 16",
  "TelephoneNumber": "sample string 17",
  "FaxNumber": "sample string 18",
  "CellphoneNumber": "sample string 19",
  "EmailAddress": "sample string 20",
  "PhysicalAddress": "sample string 21",
  "PostalAddress": "sample string 22",
  "ContactNumber": "sample string 23",
  "NetworkedSchemes": [
    "sample string 1",
    "sample string 2"
  ],
  "ManualPricingSchemes": [
    "sample string 1",
    "sample string 2"
  ],
  "Options": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "LastUpdatedDate": "2025-04-11T04:45:36Z",
  "IsLocumProvider": true,
  "KnownAs": "sample string 25"
}

application/xml, text/xml

Sample:

<Practice xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://mpsapi.healthbridge.com/rcm/billing/v1/practice/">
  <BillingEndDate>2025-04-11T04:45:36.1239467+02:00</BillingEndDate>
  <BillingIdentifier>sample string 8</BillingIdentifier>
  <BillingStartDate>2025-04-11T04:45:36.1239467+02:00</BillingStartDate>
  <BillingStatus>sample string 9</BillingStatus>
  <BranchXRef>sample string 3</BranchXRef>
  <CellphoneNumber>sample string 19</CellphoneNumber>
  <ContactNumber>sample string 23</ContactNumber>
  <DispensingDoctor>sample string 12</DispensingDoctor>
  <DispensingLicNum>sample string 13</DispensingLicNum>
  <EmailAddress>sample string 20</EmailAddress>
  <FaxNumber>sample string 18</FaxNumber>
  <HPCSANumber>sample string 14</HPCSANumber>
  <IsLocumProvider>true</IsLocumProvider>
  <KnownAs>sample string 25</KnownAs>
  <LastUpdatedDate>2025-04-11T04:45:36.1239467+02:00</LastUpdatedDate>
  <ManualPricingSchemes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ManualPricingSchemes>
  <NetworkedSchemes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </NetworkedSchemes>
  <Options xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Options>
  <PhysicalAddress>sample string 21</PhysicalAddress>
  <PostalAddress>sample string 22</PostalAddress>
  <PracticeId>63ca33b5-a4c0-46cc-9b4d-97057e3bad43</PracticeId>
  <PracticeName>sample string 4</PracticeName>
  <PracticeNumber>sample string 7</PracticeNumber>
  <PracticeTenantId>014f2125-3c67-414c-a040-e0528c73907d</PracticeTenantId>
  <PracticeXRef>sample string 2</PracticeXRef>
  <Qualification>sample string 15</Qualification>
  <SpecialityCode>sample string 5</SpecialityCode>
  <SpecialityDescription>sample string 16</SpecialityDescription>
  <SubSpecialityCode>sample string 6</SubSpecialityCode>
  <TelephoneNumber>sample string 17</TelephoneNumber>
  <TreatingDoctorName>sample string 11</TreatingDoctorName>
  <TreatingPracticeNumber>sample string 10</TreatingPracticeNumber>
</Practice>

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 'ProviderConfigurationVo'.

Response Information

Resource Description

Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects.RestApiResultOfSystem.String

Name	Type	Additional information
Sucess	boolean	None.
ResponseCode	integer	None.
ResponseMessage	string	None.
Data	string	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": "sample string 4",
  "Links": [
    {
      "Rel": "sample string 1",
      "HRef": "sample string 2"
    },
    {
      "Rel": "sample string 1",
      "HRef": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<RestApiResultOfstring xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Com.Healthbridge.Core.CommonDomain.Interface.ValueObjects">
  <Data>sample string 4</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>
</RestApiResultOfstring>

URI parameters

Headers | Add header

Body

Status

Headers

Body

POST api/v1/infrastructure/providers/{tenantXRef}/add?sendUserCredentialsToProvider={sendUserCredentialsToProvider}

Request Information

URI Parameters

Body Parameters

Request Formats

application/json, text/json

application/xml, text/xml

application/x-www-form-urlencoded

Response Information

Resource Description

Response Formats

application/json, text/json

application/xml, text/xml