Pre Encounter Organization External Providers V 1 Update

PUT

/organization-external-providers/v1/:id/:version

PUT

/organization-external-providers/v1/:id/:version

import requests
url = "https://api.taigabilling.com/organization-external-providers/v1/id/version"
payload = {
    "name": {
        "family": "string",
        "given": ["string"],
        "use": "USUAL"
    },
    "types": ["REFERRING"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.json())

{
  "deactivated": true,
  "id": "string",
  "name": {
    "family": "string",
    "given": [
      "string"
    ],
    "use": "USUAL",
    "period": {
      "start": "2023-01-15",
      "end": "2023-01-15"
    },
    "suffix": "string"
  },
  "organization_id": "string",
  "types": [
    "REFERRING"
  ],
  "updated_at": "2024-01-15T09:30:00Z",
  "updating_user_id": "string",
  "version": 1,
  "addresses": [
    {
      "use": "HOME",
      "line": [
        "string"
      ],
      "city": "string",
      "state": "string",
      "postal_code": "string",
      "country": "string",
      "administrative_area": "string",
      "county": "string",
      "period": {
        "start": "2023-01-15",
        "end": "2023-01-15"
      }
    }
  ],
  "emails": [
    "string"
  ],
  "fax_number": "string",
  "license_type": "MD",
  "npi": "string",
  "other_fax_numbers": [
    "string"
  ],
  "other_phone_numbers": [
    "string"
  ],
  "phone_number": "string",
  "tax_id": "string",
  "taxonomy_code": "string"
}

Updates an organization external provider. The path must contain the next version number to prevent race conditions. For example, if the current version of the provider is n, you will need to send a request to this endpoint with /{id}/n+1 to update the provider. Updating historic versions is not supported. BadRequestError is returned when the NPI is already in use by another provider.

Authentication

AuthorizationBearer

Send your Taiga API key as a Bearer token. Create and manage keys in the Taiga developer portal.

Path parameters

idstringRequiredformat: "uuid"

The unique identifier for an OrganizationExternalProvider in the database

versionstringRequired

Request

This endpoint expects an object.

nameobjectRequired

typeslist of enumsRequired

Allowed values:

npistring or nullOptional

tax_idstring or nullOptional

taxonomy_codestring or nullOptional

phone_numberstring or nullOptional

other_phone_numberslist of strings or nullOptional

fax_numberstring or nullOptional

other_fax_numberslist of strings or nullOptional

emailslist of strings or nullOptional

license_typeenum or nullOptional

addresseslist of objects or nullOptional

Response

deactivatedboolean

True if the object is deactivated. Deactivated objects are not returned in search results but are returned in all other endpoints including scan.

idstringformat: "uuid"

The unique identifier for an OrganizationExternalProvider in the database

nameobject

organization_idstring

The organization that owns this object.

typeslist of enums

Allowed values:

updated_atdatetime

updating_user_idstring

The user ID of the user who last updated the object.

versioninteger

The version of the object. Any update to any property of an object object will create a new version.