For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Contact Sales
DocsAPI reference
DocsAPI reference
  • API Reference
        • POSTCreate facility credentialing span
        • GETGet facility credentialing span
        • GETGet all facility credentialing spans
        • DELDelete facility credentialing span
        • PATCHUpdate facility credentialing span
        • POSTCreate provider credentialing span
        • GETGet provider credentialing span
        • GETGet all provider credentialing spans
        • DELDelete provider credentialing span
        • PATCHUpdate provider credentialing span
Contact Sales
LogoLogo
API ReferenceCredentialingV2

Update facility credentialing span

Beta
PATCH
/api/provider-credentialing-span/v2/facility/:facility_credentialing_id
PATCH
/api/provider-credentialing-span/v2/facility/:facility_credentialing_id
$curl -X PATCH https://api.joincandidhealth.com/api/provider-credentialing-span/v2/facility/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32 \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "contracting_provider_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
>}'
1{
2  "contracting_provider": {
3    "npi": "npi",
4    "is_rendering": true,
5    "is_billing": true,
6    "provider_type": "INDIVIDUAL",
7    "license_type": "MD",
8    "organization_provider_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
9    "qualifications": [
10      {
11        "identifier_code": "MCR",
12        "identifier_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
13        "identifier_value": {
14          "type": "medicare_provider_identifier",
15          "provider_number": "provider_number",
16          "state": "AA"
17        },
18        "period": {
19          "start_date": "start_date",
20          "end_date": "end_date"
21        }
22      },
23      {
24        "identifier_code": "MCR",
25        "identifier_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
26        "identifier_value": {
27          "type": "medicare_provider_identifier",
28          "provider_number": "provider_number",
29          "state": "AA"
30        },
31        "period": {
32          "start_date": "start_date",
33          "end_date": "end_date"
34        }
35      }
36    ],
37    "first_name": "first_name",
38    "last_name": "last_name",
39    "organization_name": "organization_name",
40    "tax_id": "tax_id",
41    "taxonomy_code": "taxonomy_code",
42    "addresses": [
43      {
44        "address": {
45          "address1": "address1",
46          "city": "city",
47          "state": "AA",
48          "zip_code": "zip_code",
49          "zip_plus_four_code": "zip_plus_four_code",
50          "address2": "address2"
51        },
52        "address_type": "DEFAULT"
53      },
54      {
55        "address": {
56          "address1": "address1",
57          "city": "city",
58          "state": "AA",
59          "zip_code": "zip_code",
60          "zip_plus_four_code": "zip_plus_four_code",
61          "address2": "address2"
62        },
63        "address_type": "DEFAULT"
64      }
65    ],
66    "employment_start_date": "2023-01-15",
67    "employment_termination_date": "2023-01-15"
68  },
69  "credentialing_status": "work_in_progress",
70  "facility_credentialing_span_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
71  "is_enabled": true,
72  "payer": {
73    "payer_uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
74    "payer_id": "payer_id",
75    "payer_name": "payer_name",
76    "availity_payer_name": "availity_payer_name",
77    "availity_claims_payer_id": "availity_claims_payer_id",
78    "availity_eligibility_id": "availity_eligibility_id",
79    "availity_remittance_payer_id": "availity_remittance_payer_id",
80    "street_address": {
81      "address1": "address1",
82      "city": "city",
83      "state": "AA",
84      "zip_code": "zip_code",
85      "zip_plus_four_code": "zip_plus_four_code",
86      "address2": "address2"
87    }
88  },
89  "service_facility": {
90    "organization_service_facility_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
91    "name": "name",
92    "aliases": [
93      "aliases",
94      "aliases"
95    ],
96    "telecoms": [
97      "telecoms",
98      "telecoms"
99    ],
100    "address": {
101      "address1": "address1",
102      "city": "city",
103      "state": "AA",
104      "zip_code": "zip_code",
105      "zip_plus_four_code": "zip_plus_four_code",
106      "address2": "address2"
107    },
108    "description": "description",
109    "external_id": "external_id",
110    "npi": "npi",
111    "place_of_service_code": "01",
112    "clia_number": "clia_number",
113    "mammography_certification_number": "mammography_certification_number",
114    "status": "active",
115    "operational_status": "C",
116    "mode": "instance",
117    "type": "DX",
118    "physical_type": "si"
119  },
120  "end_date": "2023-01-15",
121  "payer_loaded_date": "2023-01-15",
122  "start_date": "2023-01-15",
123  "submitted_date": "2023-01-15"
124}
Was this page helpful?
Previous

Create provider credentialing span

Next
Built with

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

facility_credentialing_idUUIDRequired

Request

This endpoint expects an object.
contracting_provider_idUUIDRequired
The ID of the billing provider for which the service facility is covered by the credentialing span.
payer_uuidUUIDOptional
The ID of the payer doing the credentialing.
start_datedateOptional
Start date of the credentialing span.
end_datedateOptional
End date of the credentialing span.
submitted_datedateOptional
Date that the credential paperwork was submitted.
payer_loaded_datedateOptional
Date that the payer loaded the credentialing span into their system.

Response

This endpoint returns an object.
contracting_providerobject
The practice location at which the rendering provider is covered by the credentialing span.
credentialing_statusenum
Status of the credentialing span.
Allowed values:
facility_credentialing_span_idUUID
is_enabledboolean
Is the credentialing span enabled?
payerobject
The payer doing the credentialing.
service_facilityobject
The service facility covered by the credentialing span.
end_datedate
End date of the credentialing span.
payer_loaded_datedate
Date that the payer loaded the credentialing span into their system.
start_datedate
Start date of the credentialing span.
submitted_datedate
Date that the credential paperwork was submitted.

Errors

403
Unauthorized Error
404
Entity Not Found Error
422
HTTP Request Validations Error
422
Unprocessable Entity Error