Get all provider credentialing spans

GET

/api/provider-credentialing-span/v2

GET

1 import uuid
2 
3 from candid import CandidApiClient
4 
5 client = CandidApiClient(
6     client_id="YOUR_CLIENT_ID",
7     client_secret="YOUR_CLIENT_SECRET",
8 )
9 client.credentialing.v_2.get_all(
10     limit=1,
11     page_token="eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9",
12     payer_uuid=uuid.UUID(
13         "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
14     ),
15     provider_id=uuid.UUID(
16         "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
17     ),
18     as_rendering_provider=True,
19     as_contracting_provider=True,
20 )

Play

200Retrieved

1 {
2   "items": [
3     {
4       "provider_credentialing_span_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
5       "rendering_provider": {
6         "npi": "string",
7         "is_rendering": true,
8         "is_billing": true,
9         "provider_type": "INDIVIDUAL",
10         "license_type": "MD",
11         "organization_provider_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
12         "qualifications": [
13           {
14             "identifier_code": "MCR",
15             "identifier_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
16             "identifier_value": {
17               "type": "medicare_provider_identifier",
18               "provider_number": "string",
19               "state": "AA"
20             },
21             "period": {
22               "start_date": "string",
23               "end_date": "string"
24             }
25           }
26         ],
27         "first_name": "string",
28         "last_name": "string",
29         "organization_name": "string",
30         "tax_id": "string",
31         "taxonomy_code": "string",
32         "addresses": [
33           {
34             "address": {
35               "address1": "string",
36               "city": "string",
37               "state": "AA",
38               "zip_code": "string",
39               "zip_plus_four_code": "string",
40               "address2": "string"
41             },
42             "address_type": "DEFAULT"
43           }
44         ],
45         "employment_start_date": "2023-01-01",
46         "employment_termination_date": "2023-01-01"
47       },
48       "contracting_provider": {
49         "npi": "string",
50         "is_rendering": true,
51         "is_billing": true,
52         "provider_type": "INDIVIDUAL",
53         "license_type": "MD",
54         "organization_provider_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
55         "qualifications": [
56           {
57             "identifier_code": "MCR",
58             "identifier_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
59             "identifier_value": {
60               "type": "medicare_provider_identifier",
61               "provider_number": "string",
62               "state": "AA"
63             },
64             "period": {
65               "start_date": "string",
66               "end_date": "string"
67             }
68           }
69         ],
70         "first_name": "string",
71         "last_name": "string",
72         "organization_name": "string",
73         "tax_id": "string",
74         "taxonomy_code": "string",
75         "addresses": [
76           {
77             "address": {
78               "address1": "string",
79               "city": "string",
80               "state": "AA",
81               "zip_code": "string",
82               "zip_plus_four_code": "string",
83               "address2": "string"
84             },
85             "address_type": "DEFAULT"
86           }
87         ],
88         "employment_start_date": "2023-01-01",
89         "employment_termination_date": "2023-01-01"
90       },
91       "payer": {
92         "payer_uuid": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
93         "payer_id": "string",
94         "payer_name": "string",
95         "availity_payer_name": "string",
96         "availity_claims_payer_id": "string",
97         "availity_eligibility_id": "string",
98         "availity_remittance_payer_id": "string",
99         "street_address": {
100           "address1": "string",
101           "city": "string",
102           "state": "AA",
103           "zip_code": "string",
104           "zip_plus_four_code": "string",
105           "address2": "string"
106         }
107       },
108       "regions": {
109         "type": "states",
110         "states": [
111           "AA"
112         ]
113       },
114       "credentialing_status": "work_in_progress",
115       "source": "string",
116       "is_enabled": true,
117       "start_date": "2023-01-01",
118       "end_date": "2023-01-01",
119       "submitted_date": "2023-01-01",
120       "payer_loaded_date": "2023-01-01",
121       "medallion_payer_enrollment_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
122     }
123   ],
124   "next_page_token": "string",
125   "prev_page_token": "string"
126 }

Query parameters

limitintegerOptional

Maximum number of entities per page, defaults to 100.

page_tokenstringOptional

payer_uuidUUIDOptional

Filter by payer.

provider_idUUIDOptional

Filter to a particular provider. Use in conjunction as_rendering_provider and as_contracting_provider.

as_rendering_providerbooleanOptional

Filter to credentialing spans where the provider is a rendering provider. To use this filter provider_id is required.

as_contracting_providerbooleanOptional

Filter to credentialing spans where the provider is a contracting provider. To use this filter provider_id is required.

Response

This endpoint returns an object.

itemslist of objects

next_page_tokenstringOptional

prev_page_tokenstringOptional

Get all provider credentialing spans

Headers

Query parameters

Response

Errors