POST api/provider/add

Request Information

URI Parameters

None.

Body Parameters

ProviderModel
NameDescriptionTypeAdditional information
provider_id

globally unique identifier

None.

display_txt

string

None.

last_name_txt

string

None.

first_name_txt

string

None.

active_ind

boolean

None.

address_1_txt

string

None.

address_2_txt

string

None.

city_txt

string

None.

state_txt

string

None.

zip_txt

string

None.

npi_txt

string

None.

secondary_id_txt

string

None.

secondary_id_type_txt

string

None.

federal_tax_id_type_txt

string

None.

federal_tax_id_txt

string

None.

taxonomy_cd_txt

string

None.

default_billing_provider_id

globally unique identifier

None.

billing_provider_ind

boolean

None.

rendering_provider_ind

boolean

None.

referring_provider_ind

boolean

None.

phone_txt

string

None.

note_txt

string

None.

created_dt

date

None.

created_by

globally unique identifier

None.

updated_dt

date

None.

updated_by

globally unique identifier

None.

fax_txt

string

None.

practice_name_txt

string

None.

email_address_txt

string

None.

signature_dat

string

None.

meaningful_phase_ind

integer

None.

provider_type

string

None.

direct_address

string

None.

direct_password_txt

string

None.

PatientCareTeams

Collection of PatientCareTeamModel

None.

ProviderInsurances

Collection of ProviderInsuranceModel

None.

ProviderInsurances1

Collection of ProviderInsuranceModel

None.

Request Formats

application/json, text/json

Sample:
{
  "provider_id": "34d2ad0a-9ecd-4849-bed5-2a1799e8e23f",
  "display_txt": "sample string 2",
  "last_name_txt": "sample string 3",
  "first_name_txt": "sample string 4",
  "active_ind": true,
  "address_1_txt": "sample string 6",
  "address_2_txt": "sample string 7",
  "city_txt": "sample string 8",
  "state_txt": "sample string 9",
  "zip_txt": "sample string 10",
  "npi_txt": "sample string 11",
  "secondary_id_txt": "sample string 12",
  "secondary_id_type_txt": "sample string 13",
  "federal_tax_id_type_txt": "sample string 14",
  "federal_tax_id_txt": "sample string 15",
  "taxonomy_cd_txt": "sample string 16",
  "default_billing_provider_id": "0094e4f7-4e2e-4f47-ac99-992aeb202407",
  "billing_provider_ind": true,
  "rendering_provider_ind": true,
  "referring_provider_ind": true,
  "phone_txt": "sample string 21",
  "note_txt": "sample string 22",
  "created_dt": "2025-08-29T03:07:08.2255279+00:00",
  "created_by": "f0984ad1-4f26-4afa-8871-c5292ddd0f98",
  "updated_dt": "2025-08-29T03:07:08.2255279+00:00",
  "updated_by": "6aa9cbd2-c6e0-4551-9fca-a448e087d391",
  "fax_txt": "sample string 27",
  "practice_name_txt": "sample string 28",
  "email_address_txt": "sample string 29",
  "signature_dat": "sample string 30",
  "meaningful_phase_ind": 31,
  "provider_type": "sample string 32",
  "direct_address": "sample string 33",
  "direct_password_txt": "sample string 34",
  "patientCareTeams": [
    {
      "$id": "2",
      "patient_care_team_id": "1ec19a59-1ff0-4e84-a5ce-2e7277a80e08",
      "name_txt": "sample string 2",
      "type_txt": "sample string 3",
      "order": 1,
      "created_dt": "2025-08-29T03:07:08.2255279+00:00",
      "created_by": "fbb21fc3-3c52-4cbd-b4b1-b18008fdd22d",
      "patientID": 6,
      "providerID": "dc91de11-538d-4881-acd0-897a108f5ba1",
      "patient": {
        "$id": "3",
        "patientID": 1,
        "lastName": "sample string 2",
        "firstName": "sample string 3",
        "middleInitial": "sample string 4",
        "address": "sample string 5",
        "city": "sample string 6",
        "state": "sample string 7",
        "zip": "sample string 8",
        "dateOfBirth": "2025-08-29T03:07:08.2255279+00:00",
        "sex": "sample string 9",
        "dateOfEntry": "2025-08-29T03:07:08.2255279+00:00",
        "homePhone": "sample string 10",
        "workPhone": "sample string 11",
        "cellPhone": "sample string 12",
        "employer": "sample string 13",
        "occupation": "sample string 14",
        "insurance": "sample string 15",
        "insuranceIDNumber": "sample string 16",
        "creationDate": "2025-08-29T03:07:08.2255279+00:00",
        "lastUpdateDate": "2025-08-29T03:07:08.2255279+00:00",
        "patientAcctNo": "sample string 19",
        "address2": "sample string 20",
        "isArchived": true,
        "visionInsurance": "sample string 21",
        "visionInsuranceId": "sample string 22",
        "insuredName": "sample string 23",
        "insuredBirthdate": "2025-08-29T03:07:08.2255279+00:00",
        "insuredSSN": "sample string 24",
        "relationshipToInsured": "sample string 25",
        "referedBy": "sample string 26",
        "referedByName": "sample string 27",
        "responsibleName": "sample string 28",
        "responsibleAddress": "sample string 29",
        "responsibleBirthdate": "2025-08-29T03:07:08.2255279+00:00",
        "responsiblePhone": "sample string 30",
        "race": "sample string 31",
        "marriageStatus": 1,
        "employed": true,
        "studentStatus": 33,
        "emailaddress": "sample string 34",
        "doctorReferred": true,
        "referringDoctor": "sample string 36",
        "spouseName": "sample string 37",
        "spouseEmployer": "sample string 38",
        "emergencyContactName": "sample string 39",
        "emergencyContactRelation": "sample string 40",
        "emergencyContactHomePhone": "sample string 41",
        "emergencyContactWorkPhone": "sample string 42",
        "socialSecurityNum": "sample string 43",
        "selfPay": true,
        "ethnicity": "sample string 45",
        "language": "sample string 46",
        "lastUpdatedBy": 1,
        "patient_id": "a4d59a10-62f6-48c7-93fa-8af2142d5b2a",
        "coPay": 1.0,
        "defaultDoctorID": "15061418-37ca-4430-b7f9-6369c2b0cf1d",
        "defaultOfficeID": "fa2d112c-0b1a-4881-bd32-c234b517a456",
        "do_not_bill_ind": true,
        "template_ind": true,
        "template_name_txt": "sample string 49",
        "referring_provider_id": "6ca3e8d1-6aa4-4d81-bdd3-bae4e8593e98",
        "contact_method_txt": "sample string 50",
        "responsibleCity": "sample string 51",
        "responsibleState": "sample string 52",
        "responsibleZip": "sample string 53",
        "addressType": "sample string 54",
        "country": "sample string 55",
        "emailOptout": true,
        "biller_review_before_bill_patient_ind": true,
        "send_hcfa_ind": true,
        "reminders_contact_txt": "sample string 59",
        "notifications_contact_txt": "sample string 60",
        "marketing_contact_txt": "sample string 61",
        "cellPhoneProvider": "sample string 62",
        "responsibleCountry": "sample string 63",
        "spouseMaidenLastName": "sample string 64",
        "spouseMaidenFirstName": "sample string 65",
        "responsibleRelationship": "sample string 66",
        "responsibleParty": 67,
        "patientCareTeams": [
          {
            "$ref": "2"
          },
          {
            "$ref": "2"
          }
        ],
        "patientIdentifiers": [
          {
            "$id": "4",
            "patientId": 1,
            "identifierId": 2,
            "id": 3,
            "identifier": {
              "$id": "5",
              "id": 1,
              "name": "sample string 2",
              "active_ind": true
            },
            "patient": {
              "$ref": "3"
            }
          },
          {
            "$ref": "4"
          }
        ],
        "patientInsurances": [
          {
            "$id": "6",
            "patientInsuranceID": "9262fee1-4f58-489e-a2d9-80bc3605b85e",
            "patientID": 2,
            "insuranceType": 3,
            "insuranceOrder": 4,
            "insuranceName": "sample string 5",
            "status": "sample string 6",
            "memberID": "sample string 7",
            "groupID": "sample string 8",
            "insuredName": "sample string 9",
            "insuredRelation": "sample string 10",
            "insuredEmployer": "sample string 11",
            "insuredGender": "sample string 12",
            "insuredDOB": "2025-08-29T03:07:08.2255279+00:00",
            "insuredSSN": "sample string 13",
            "creationDate": "2025-08-29T03:07:08.2255279+00:00",
            "createdBy": 1,
            "lastUpdateDate": "2025-08-29T03:07:08.2255279+00:00",
            "lastUpdatedBy": 1,
            "attachment_id": "3cc1d370-0918-4880-8c1a-0eab2bae2744",
            "current_ind": true,
            "insurance_id": "f48586e4-af1e-4d99-9818-fcc22620fa38"
          },
          {
            "$ref": "6"
          }
        ],
        "patientRaces": [
          {
            "$id": "7",
            "patientID": 1,
            "race": "sample string 2",
            "patient": {
              "$ref": "3"
            }
          },
          {
            "$ref": "7"
          }
        ]
      }
    },
    {
      "$ref": "2"
    }
  ],
  "providerInsurances": [
    {
      "$id": "8",
      "provider_insurance_id": "eede7b29-e6e1-472c-ae99-81495b64250c",
      "provider_id": "9d123751-e0c6-46df-8229-10443242ae70",
      "insurance_id": "400f3c82-621e-4ae7-9e54-d226a46cea1e",
      "secondary_id_txt": "sample string 4",
      "secondary_id_type_txt": "sample string 5",
      "billing_provider_id": "147bdfe9-b163-42b8-804d-30168febf44e",
      "created_dt": "2025-08-29T03:07:08.2255279+00:00",
      "created_by": "b23444a7-1ed6-43f7-a182-21b4a23c0519",
      "updated_dt": "2025-08-29T03:07:08.2255279+00:00",
      "updated_by": "011675a9-b5e1-4aeb-92a3-c8cbc852fe05",
      "federal_tax_id_txt": "sample string 11",
      "federal_tax_id_type_txt": "sample string 12",
      "provider": {
        "$ref": "1"
      },
      "provider1": {
        "$ref": "1"
      }
    },
    {
      "$ref": "8"
    }
  ],
  "providerInsurances1": [
    {
      "$ref": "8"
    },
    {
      "$ref": "8"
    }
  ]
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.