### Search Appointments by Start Date, Additional Days, and Caregiver ID

Source: https://apidocs.clearcareonline.com/

This example demonstrates searching for appointments starting on a specific date and extending for a number of additional days, filtered by caregiver ID. The `additionalDays` parameter is optional and valid for values 1 to 6.

```json
{
"startDate": "20200102",
"additionalDays": "4",
"caregiverId": "948043"
}
```

--------------------------------

### Retrieve Location Response Example

Source: https://apidocs.clearcareonline.com/

Example JSON response structure for a successful GET request to the location endpoint.

```json
{
  "resourceType": "Location",
  "id": 1,
  "name": "Noe Valley",
  "managingOrganization": 
{
    "reference": "Organization/1669"
},
  "telecom": 
[
    {
      "system": "phone",
      "use": "work",
      "value": "9990876689"
},
    {
      "system": "fax",
      "use": "work",
      "value": "9990876689"
}
],
  "address": 
{
    "city": "PleasantVille",
    "postalCode": "94103",
    "state": "vic",
    "text": "1050 W Wishard Blvd",
    "line": 
[
      "1050 W Wishard Blvd"
],
    "type": "postal",
    "use": "work"
}

}
```

--------------------------------

### Search Locations Response Example

Source: https://apidocs.clearcareonline.com/

Example JSON response structure for a successful POST search request.

```json
{
  "entry": 
[
    {
      "resource": 
{
        "address": 
{
          "city": "PleasantVille",
          "postalCode": "94103",
          "state": "CA",
          "text": "1050 W Wishard Blvd",
          "line": 
[
            "1050 W Wishard Blvd"
],
          "type": "postal",
          "use": "work"
},
        "id": "1",
        "managingOrganization": 
{
          "reference": "Organization/1669"
},
        "name": "Noe Valley",
        "resourceType": "Location",
        "telecom": 
[
          {
            "system": "phone",
            "use": "work",
            "value": "9990876689"
},
          {
            "system": "fax",
            "use": "work",
            "value": "9990876689"
}
]
},
      "search": 
{
        "mode": "match",
        "score": 1
}
}
],
  "id": "searchParams",
  "resourceType": "Bundle",
  "totalRecords": "1",
  "type": "searchset"

}
```

--------------------------------

### Response sample for subscription search

Source: https://apidocs.clearcareonline.com/

Example of a successful response when searching for subscriptions.

```json
{
  "entry": [
    {
      "resource": {
        "channel": {
          "type": "rest-hook"
        },
        "contact": [
          {
            "system": "email",
            "use": "work",
            "value": "bob@gmail.com"
          },
          {
            "system": "phone",
            "use": "work",
            "value": "9990876689"
          },
          {
            "system": "fax",
            "use": "work",
            "value": "9990876689"
          },
          {
            "system": "phone",
            "use": "mobile",
            "value": "9990876689"
          },
          {
            "system": "phone",
            "use": "home",
            "value": "9990876689"
          }
        ],
        "criteria": "applicant.status.changed",
        "end": "2021-01-01T00:00:00",
        "endpoint": "https://webhook.site/390cc321-b628-497d-8fed-57b2981ed931",
        "error": "No errors",
        "header": [
          "Authorization: Bearer secret-token-abc-123"
        ],
        "id": "1",
        "payload": "application/fhir+json",
        "reason": "admintask.status.complete",
        "resourceType": "Subscription",
        "status": "active",
        "meta": {
          "tag": [
            {
              "code": "agencyId",
              "display": 1669
            }
          ]
        }
      },
      "search": {
        "mode": "match",
        "score": 1
      }
    }
  ],
  "id": "searchParams",
  "resourceType": "Bundle",
  "totalRecords": "1",
  "type": "searchset"
}
```

--------------------------------

### AgencyAdmin Search Request Examples

Source: https://apidocs.clearcareonline.com/

Examples for searching AgencyAdmin records using specific criteria.

```json
  {
    "roles": "Super Admin"
  }
```

```json
  {
    "family": "Doe",
    "given": "John"
  }
```

--------------------------------

### Date Data Type Example

Source: https://apidocs.clearcareonline.com/

A date example. Partial dates (year or year+month) are also acceptable. Time zones are not included.

```Date
2018-06-12
```

--------------------------------

### Get AllergyIntolerance Response Sample

Source: https://apidocs.clearcareonline.com/

Example JSON response for retrieving AllergyIntolerance objects for a patient, returned as a Bundle.

```json
{
  "entry": [
    {
      "code": {
        "text": "Actonel"
      },
      "id": "1164785",
      "note": [
        {
          "text": "test from api 3"
        }
      ],
      "patient": {
        "reference": "patient/2040133"
      },
      "resourceType": "AllergyIntolerance"
    }
  ],
  "id": "searchParams",
  "resourceType": "Bundle",
  "totalRecords": 1,
  "type": "searchset"
}
```

--------------------------------

### DateTime Data Type Example

Source: https://apidocs.clearcareonline.com/

A date and time example. The time '24:00' is not allowed. If hours and minutes are provided, a time zone must also be included.

```DateTime
2016-03-01T04:06
```

--------------------------------

### Location Search Queries

Source: https://apidocs.clearcareonline.com/

Examples of search parameters for the /v1/locations/ endpoint.

```text
Eg1 v1/locations/?name=Noe Valley   
Eg2 v1/locations/?managingOrganization=1669   
Eg3 /v1/locations/?address:contains=CA   
Eg4 /v1/locations/?address=house no 6, 534 Erewhon strt   
Eg5 /v1/locations/?address-city=PleasantVille   
Eg6 /v1/locations/?address-state=Vic   
Eg7 /v1/locations/?address-postalcode=94103   
Eg8 /v1/locations/?phoneNumber=9990876689   
Eg9 /v1/locations/?faxNumber=9990876689
```

--------------------------------

### Time Data Type Example

Source: https://apidocs.clearcareonline.com/

A time of day example without date specifications. Neither '24:00' nor time zones are permitted.

```Time
11:22:36
```

--------------------------------

### URI Data Type Example

Source: https://apidocs.clearcareonline.com/

A Uniform Resource Identifier (URI) example. URIs are case-sensitive and can be absolute or relative.

```URI
urn:uuid:53fefa32-fcbb-4ff8-8a92-55ee120877b7
```

--------------------------------

### Search Subscriptions by Status (Requested)

Source: https://apidocs.clearcareonline.com/

Example to search for subscriptions that have a 'requested' status.

```http
/v1/subscriptions/?status=requested
```

--------------------------------

### Search Appointments by Start Date and Client ID

Source: https://apidocs.clearcareonline.com/

Use this snippet to search for appointments on a specific start date for a given client. Ensure the date is in YYYYMMDD format.

```json
{
"startDate": "20200608",
"clientId": "92169"
}
```

--------------------------------

### Constructing Production Base URL

Source: https://apidocs.clearcareonline.com/

This example demonstrates how to construct a full API endpoint by appending the desired resource to the production base URL.

```HTTP
https://connect.clearcareonline.com/v1/practitioners
```

--------------------------------

### Get Organization by ID Example

Source: https://apidocs.clearcareonline.com/

This example demonstrates how to retrieve a specific Organization resource using its ID. The trailing slash in the URL is crucial for the request to be processed correctly. This endpoint returns a FHIR Organization resource.

```http
GET /v1/organizations/12345/
```

```http
https://connect.clearcareonline.com/v1/organizations/{id}/
```

--------------------------------

### Encounter Creation Response Sample

Source: https://apidocs.clearcareonline.com/

Example JSON response after successfully creating an Encounter.

```json
{
  * "resourceType": "Encounter",
  * "id": "128777063"

}
```

--------------------------------

### Request Payload Example for Appointment Search

Source: https://apidocs.clearcareonline.com/

This is an example of a request payload for the appointment search endpoint, specifying start date, additional days, and caregiver ID. Dates in the response body are returned in UTC format.

```json
{
  * "startDate": "20200602",
  * "additionalDays": "2",
  * "caregiverId": "3306118"

}
```

--------------------------------

### Activity Response Sample

Source: https://apidocs.clearcareonline.com/

Example JSON response for a successful retrieval of an Activity object.

```json
{
  "id": 296370839,
  "agencyId": "1669",
  "patientId": "1216865",
  "caregiverId": "1908649",
  "date": "2026-01-21",
  "description": "Called patient to schedule follow-up appointment.",
  "shiftId": "12345",
  "carelogId": "67890",
  "statusId": 2,
  "activityTypeId": 5
}
```

--------------------------------

### Retrieve Resource Bundle Response Sample

Source: https://apidocs.clearcareonline.com/

Example of a 200 OK response containing a Bundle of ChargeItem and CareLog resources.

```json
{
  "resourceType": "Bundle",
  "id": "searchParams",
  "type": "searchset",
  "totalRecords": 2,
  "entry": [
    {
      "resource": {
        "resourceType": "ChargeItem/Item",
        "id": "1798143",
        "type": "Item",
        "partOf": {
          "reference": "Encounter/128777063"
        },
        "subject": {
          "reference": "Patient/2065430"
        },
        "occurrencePeriod": {
          "start": "2022-02-15T12:00:00",
          "end": "2022-02-15T13:00:00"
        },
        "performer": [
          {
            "actor": {
              "reference": "Practitioner/2408379"
            }
          }
        ],
        "rates": {
          "mileage": [
            {
              "code": "rate",
              "display": 0.75
            },
            {
              "code": "unit",
              "display": "km"
            }
          ]
        },
        "price": {
          "value": 7.5
        },
        "quantity": {
          "value": 10,
          "unit": "km"
        },
        "meta": {
          "tags": [
            {
              "code": "finalized",
              "display": true
            },
            {
              "code": "agencyId",
              "display": "1669"
            },
            {
              "code": "invoiced",
              "display": false
            },
            {
              "code": "updated",
              "display": "2023-01-26T18:27:29.464148"
            }
          ]
        }
      },
      "resourceType": "ChargeItem",
      "id": "128777063",
      "type": "CareLog",
      "subject": {
        "reference": "Patient/2065430"
      },
      "occurrencePeriod": {
        "start": "2022-02-15T12:00:00",
        "end": "2022-02-15T13:00:00"
      },
      "performer": [
        {
          "actor": {
            "reference": "Practitioner/2408379"
          }
        }
      ],
      "rates": {
        "billRate": [
          {
            "code": "type",
            "display": "Hourly"
          },
          {
            "code": "name",
            "display": "Hour"
          },
          {
            "code": "amount",
            "display": 25
          },
          {
            "code": "unit",
            "display": "hr"
          }
        ]
      },
      "price": {
        "value": 25
      },
      "meta": {
        "tags": [
          {
            "code": "finalized",
            "display": true
          },
          {
            "code": "regular",
            "display": 1
          },
          {
            "code": "ot",
            "display": 0
          },
          {
            "code": "dot",
            "display": 0
          },
          {
            "code": "invoiced",
            "display": false
          },
          {
            "code": "updated",
            "display": "2023-01-26T18:27:29.464148"
          }
        ]
      }
    }
  ]
}
```

--------------------------------

### Define DocumentReference securityLabel and type

Source: https://apidocs.clearcareonline.com/

Example structure for the securityLabel and type fields added to the DocumentReference GET response.

```json
"securityLabel": [{"text": "Unrestricted"}]
```

```json
"type": {"text": "Electronic Signature Authorization"}
```

--------------------------------

### Search Subscriptions Response (200 OK)

Source: https://apidocs.clearcareonline.com/

Sample successful response (200 OK) for a subscription search operation. It returns a Bundle resource containing matching subscription entries.

```json
{
  "resourceType": "Bundle",
  "id": "searchParams",
  "type": "searchset",
  "totalRecords": 1,
  "entry": [
    {
      "resource": 
{
        "channel": 
{
          "type": "rest-hook"
},
        "contact": [
          {
            "system": "email",
            "use": "work",
            "value": "test@gmail.com"
},
          {
            "system": "phone",
            "use": "work",
            "value": "9990876689"
},
          {
            "system": "fax",
            "use": "work",
            "value": "9990876689"
},
          {
            "system": "phone",
            "use": "mobile",
            "value": "9990876689"
},
          {
            "system": "phone",
            "use": "home",
            "value": "9990876689"
}
],
        "criteria": "applicant.status.changed",
        "end": "2021-01-01T00:00:00",
        "endpoint": "https://webhook.site/390cc321-b628-497d-8fed-57b2981ed931",
        "error": "No errors",
        "header": [
          "Authorization: Bearer secret-token-abc-123"
],
        "id": "1",
        "payload": "application/fhir+json",
        "reason": "Monitor new neonatal function",
        "resourceType": "Subscription",
        "status": "active",
        "meta": 
{
          "tag": [
            {
              "code": "agencyId",
              "display": 1669
}
]
}
},
      "search": 
{
        "mode": "match",
        "score": 1
}
}
]

}
```

--------------------------------

### GET Request with Trailing Slash

Source: https://apidocs.clearcareonline.com/

All commands sent to the API must include a trailing slash for a successful response. This example shows fetching a list of document references.

```HTTP
GET v1/documentReferences/
```

--------------------------------

### Practitioner Resource Sample (JSON)

Source: https://apidocs.clearcareonline.com/

This is a sample JSON response for a Practitioner resource. It includes details such as active status, name, contact information, address, and meta- tags.

```json
{
  "resourceType": "Practitioner",
  "id": "1",
  "active": true,
  "status": "string",
  "name": 
[
    {
      "use": "official",
      "family": "Abelton",
      "given": 
[
        "Abel"
],
      "text": "Abel Abelton"
},
    {
      "use": "nickName",
      "given": 
[
        "Abel"
],
      "text": "Abel"
}
],
  "telecom": 
[
    {
      "system": "email",
      "use": "work",
      "value": "test@gmail.com"
},
    {
      "system": "phone",
      "use": "work",
      "value": "9990876689"
},
    {
      "system": "fax",
      "use": "work",
      "value": "9990876689"
},
    {
      "system": "phone",
      "use": "mobile",
      "value": "9990876689"
},
    {
      "system": "phone",
      "use": "home",
      "value": "9990876689"
}
],
  "address": 
[
    {
      "city": "PleasantVille",
      "country": "United States",
      "postalCode": 94103,
      "state": "CA",
      "text": "1050 W Wishard Blvd",
      "line": 
[
        "1050 W Wishard Blvd"
],
      "type": "postal",
      "use": "work"
}
],
  "gender": "male",
  "birthDate": "1990-01-05",
  "contact": 
[
    {
      "name": 
[
        {
          "text": "John Doe",
          "use": "official",
          "family": "Doe",
          "given": 
[
            "John"
]
}
],
      "address": 
[
        {
          "text": "1234 W Wishard Blvd",
          "line": 
[
            "1234 W Wishard Blvd"
],
          "city": "San Francisco",
          "state": "CA",
          "postalCode": "94123",
          "country": "United States",
          "type": "postal",
          "use": "work"
}
],
      "telecom": 
[
        {
          "system": "email",
          "value": "sample@email.com"
},
        {
          "system": "phone",
          "use": "home",
          "value": "9703711223"
},
        {
          "system": "phone",
          "use": "mobile",
          "value": "9703711222"
}
],
      "relationship": 
[
        {
          "coding": 
[
            {
              "code": "SPS"
}
]
}
],
      "emergencyContact": true,
      "note": "Note",
      "id": "1"
}
],
  "created": "2019-01-05T10:29:30.66563",
  "deactivated": "",
  "updated": "2019-10-05T10:29:30.66563",
  "qualification": 
[
    {
      "identifier": 
{
        "use": "MS",
        "value": "City college of San Francisco"
},
      "code": 
{
        "coding": 
[
          {
            "code": "MS",
            "display": "Master of science"
}
],
        "text": "Masters"
},
      "issuer": 
{
        "display": "Princeton University"
}
}
],
  "communication": 
[
    {
      "coding": 
[
        {
          "code": "en-us",
          "display": "English"
}
],
      "text": "Language"
}
],
  "rates": 
{
    "payRate": 
[
      {
        "code": "amount",
        "display": 18
},
      {
        "code": "method",
        "display": "HOURLY"
},
      {
        "code": "type",
        "display": "PAIRED"
},
      {
        "code": "id",
        "display": "Standard Hourly_cl0svmgzw000008mlm1qd3w92##HOURLY"
},
      {
        "code": "name",
        "display": "Standard Hourly"
}
]
},
  "meta": 
{
    "tag": 
[
      {
        "code": "agencyId",
        "display": "1669"
},
      {
        "code": "isHired",
        "display": "True"
},
      {
        "code": "referrerPersonId",
        "display": "5577898"
},
      {
        "code": "notes",
        "display": "New notes"
},
      {
        "code": "status",
        "display": "0"
},
      {
        "code": "personId",
        "display": "3559229"
},
      {
        "code": "locationId",
        "display": "1017"
},
      {
        "code": "locationName",
        "display": "Noe Valley"
},
      {
        "code": "deactivated",
        "display": "2022-02-22"
},
      {
        "code": "caregiverDeactivationReason",
        "display": "Terminated - Quit"
},
      {
        "code": "hiredDate",
        "display": "2021-12-01"
},
      {
        "code": "eligibleToRehire",
        "display": "yes"
}
]
}

}
```

--------------------------------

### GET Request for Specific Resource without Trailing Slash

Source: https://apidocs.clearcareonline.com/

When making specific searches or fetching a single resource, the trailing slash should be omitted. This example includes query parameters.

```HTTP
GET v1/documentReferences/6769250/?agencyId=1234
```

--------------------------------

### Search Subscriptions by Email and Sort

Source: https://apidocs.clearcareonline.com/

Example demonstrating how to search for subscriptions by email and sort the results by contact phone number. Note that sorting by 'contact_phone_number' might not be directly supported as a primary search parameter.

```http
/v1/subscriptions/?contact_email:contains=bob@gmail.com&_sort=contact_phone_number
```

--------------------------------

### RelatedPerson Search Examples

Source: https://apidocs.clearcareonline.com/

Various query examples for the /v1/relatedperson/ endpoint.

```text
v1/relatedperson/
```

```text
v1/relatedperson/?last_name=Jonathon&_sort=-first_name,last_name,email
```

```text
v1/relatedperson/?relationship=Doctor
```

```text
v1/relatedperson/?patient=210014
```

```text
v1/relatedperson/?organization=West United Church
```

--------------------------------

### POST /v1/adminTasks/

Source: https://apidocs.clearcareonline.com/

Creates a new administrative task in the system.

```APIDOC
## POST /v1/adminTasks/

### Description
Creates a new administrative task.

### Method
POST

### Endpoint
https://connect.clearcareonline.com/v1/adminTasks/

### Parameters
#### Request Body
- **status** (string) - Required - Enum: "complete", "received", "failed".
- **description** (string) - Required - Detailed description of the task (max 5000 chars).
- **executionDate** (string) - Required - Date of execution (yyyy-mm-dd).
- **dueDate** (string) - Optional - Due date (yyyy-mm-ddTH:M:S).
- **requester** (Array of objects) - Required - Details about the requester (profile IDs or resource objects).
- **owner** (Array of objects) - Optional - Profile ID or agency admin ID of the owner.
- **meta** (object) - Required - Metadata containing agencyId.

### Request Example
{
  "status": "complete",
  "description": "This is sample request description",
  "executionDate": "2018-04-16",
  "dueDate": "2018-04-16T12:36:40",
  "requester": [{"resourceType": "Patient", "id": "77553"}],
  "owner": [{"resourceType": "admin", "id": "5269"}],
  "meta": {"tag": [{"code": "agencyId", "display": 1669}]}
}

### Response
#### Success Response (201)
- **id** (integer) - Task ID
- **resourceType** (string) - Resource type

#### Response Example
{
  "id": 74027299,
  "resourceType": "Task"
}
```

--------------------------------

### RelatedPerson GET Request

Source: https://apidocs.clearcareonline.com/

The base URL for the GET request to the RelatedPerson endpoint.

```text
https://connect.clearcareonline.com/v1/relatedperson/
```

--------------------------------

### Patient Search Query Examples

Source: https://apidocs.clearcareonline.com/

Examples of query strings for filtering patient search results.

```text
v1/patients/?family:contains=Aaron
```

```text
v1/patients/?family:contains=Aaron&_sort=last_name,-email
```

```text
v1/patients/?externalId=WVudDoxMjExNTM5
```

```text
v1/patients/?created=lt2016-03-01T04:06
```

```text
v1/patients/?family_member:contains=Kevin
```

```text
v1/patients/?tags=1,2,3
```

--------------------------------

### Create TaskLog Response Sample

Source: https://apidocs.clearcareonline.com/

This is a sample JSON response upon successful creation of a TaskLog object. It confirms the success and provides the ID of the newly created task log.

```json
{
  "success": true,
  "taskLogId": 12118
}
```

--------------------------------

### Create AllergyIntolerance Response Sample

Source: https://apidocs.clearcareonline.com/

Example JSON response upon successful creation of an AllergyIntolerance object.

```json
{
  "id": "1164785",
  "resourceType": "AllergyIntolerance"
}
```

--------------------------------

### Positive Integer Data Type Example

Source: https://apidocs.clearcareonline.com/

An example of a positive integer, which is any integer greater than or equal to 1.

```Integer
1-9
```

--------------------------------

### Create Subscription Response

Source: https://apidocs.clearcareonline.com/

This is a sample successful response (201 Created) when creating a subscription. It typically returns the resource type and the ID of the newly created subscription.

```json
{
  "resourceType": "Subscription",
  "id": 1

}
```

--------------------------------

### Code Data Type Example

Source: https://apidocs.clearcareonline.com/

A code example, representing a value from a controlled set of strings. It is typically a single string without leading whitespace.

```Code
en-US
```

--------------------------------

### Search Appointments by Month Number and Client ID

Source: https://apidocs.clearcareonline.com/

This example demonstrates searching for all assigned shifts/appointments within a specific month for a client. The `monthNo` parameter requires the YYYYMM format.

```json
{
"clientId": "92169",
"monthNo": "202104"
}
```

--------------------------------

### Character Validation Example

Source: https://apidocs.clearcareonline.com/

This example shows a string that includes various special characters and whitespace characters that are validated by the API. Note that certain Unicode character points below 32 are not allowed.

```Text
!@#$%^&*()[]-+ =<>?./|'
```

--------------------------------

### Practitioner Resource Sample

Source: https://apidocs.clearcareonline.com/

This JSON snippet represents a successful response for a Practitioner resource. It includes personal details, contact information, address, and professional qualifications.

```json
{
  "resourceType": "Bundle",
  "id": "searchParams",
  "type": "searchset",
  "totalRecords": 1,
  "entry": [
    {
      "resource": {
        "resourceType": "Practitioner",
        "id": 1,
        "active": true,
        "name": [
          {
            "text": "Allen Aaron",
            "use": "official",
            "family": "Aaron",
            "given": [
              "Allen"
            ]
          },
          {
            "text": "Al",
            "use": "nickName",
            "given": [
              "Al"
            ]
          }
        ],
        "telecom": [
          {
            "system": "email",
            "use": "work",
            "value": "test@gmail.com"
          },
          {
            "system": "phone",
            "use": "work",
            "value": "9990876689"
          },
          {
            "system": "fax",
            "use": "work",
            "value": "9990876689"
          },
          {
            "system": "phone",
            "use": "mobile",
            "value": "9990876689"
          },
          {
            "system": "phone",
            "use": "home",
            "value": "9990876689"
          }
        ],
        "address": [
          {
            "use": "work",
            "type": "postal",
            "text": "1050 W Wishard Blvd",
            "line": [
              "1050 W Wishard Blvd"
            ],
            "city": "PleasantVille",
            "state": "CA",
            "postalCode": 94103,
            "country": "United states"
          }
        ],
        "gender": "male",
        "birthDate": "1990-01-05",
        "contact": [
          {
            "name": [
              {
                "text": "John Doe",
                "use": "official",
                "family": "Doe",
                "given": [
                  "John"
                ]
              }
            ],
            "address": [
              {
                "text": "1234 W Wishard Blvd",
                "line": [
                  "1234 W Wishard Blvd"
                ],
                "city": "San Francisco",
                "state": "CA",
                "postalCode": "94123",
                "country": "United States",
                "type": "postal",
                "use": "work"
              }
            ],
            "telecom": [
              {
                "system": "email",
                "value": "sample@email.com"
              },
              {
                "system": "phone",
                "use": "home",
                "value": "9703711223"
              },
              {
                "system": "phone",
                "use": "mobile",
                "value": "9703711222"
              }
            ],
            "relationship": [
              {
                "coding": [
                  {
                    "code": "SPS"
                  }
                ]
              }
            ],
            "emergencyContact": true,
            "note": "Note",
            "id": "1"
          }
        ],
        "created": "2019-01-05T10:29:30.66563",
        "deactivated": "",
        "updated": "2019-10-05T10:29:30.66563",
        "qualification": [
          {
            "code": {
              "coding": [
                {
                  "code": "MS",
                  "display": "Master of science"
                }
              ],
              "text": "Masters"
            },
            "issuer": {
              "display": "City college of San Francisco"
            }
          }
        ],
        "communication": [
          {
            "coding": [
              {
                "code": "en-us",
                "display": "English"
              }
            ],
            "text": "Language"
          }
        ],
        "rates": {
          "payRate": [
            {
              "code": "amount",
              "display": 18
            },
            {
              "code": "method",
              "display": "HOURLY"
            },
            {
              "code": "type",
              "display": "PAIRED"
            },
            {
              "code": "id",
              "display": "Standard Hourly_cl0svmgzw000008mlm1qd3w92##HOURLY"
            },
            {
              "code": "name",
              "display": "Standard Hourly"
            }
          ]
        },
        "meta": {
          "tag": [
            {
              "code": "agencyId",
              "display": 1669
            },
            {
              "code": "isHired",
              "display": true
            },
            {
              "code": "referrerPersonId",
              "display": 5577898
            },
            {
              "code": "notes",
              "display": "New notes"
            },
            {
              "code": "status",
              "display": 0
            },
            {
              "code": "personId",
              "display": 3559229
            },
            {
              "code": "locationId",
              "display": 1017
            },
            {
              "code": "locationName",
              "display": "Noe Valley"
            }
          ]
        }
      }
    }
  ]
}
```

--------------------------------

### GET /v1/encounter/{id}

Source: https://apidocs.clearcareonline.com/

Retrieves a specific encounter by its ID.

```APIDOC
## GET /v1/encounter/{id}

### Description
Retrieves a specific encounter by its ID.

### Method
GET

### Endpoint
https://connect.clearcareonline.com/v1/encounter/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the encounter.

### Response
#### Success Response (200)
- **resourceType** (string) - The type of resource, which is 'Encounter'.
- **id** (string) - The unique identifier of the encounter.
- **status** (string) - The status of the encounter (e.g., 'COMPLETE').
- **subject** (object) - Information about the subject of the encounter.
  - **display** (string) - The display name of the subject.
  - **reference** (string) - A reference to the subject resource (e.g., 'Patient/2065430').
- **participant** (object) - Information about the participants in the encounter.
  - **Individual** (array) - A list of individual participants.
    - **reference** (string) - A reference to the practitioner resource (e.g., 'Practitioner/2408379').
    - **Display** (string) - The display name of the participant.
- **serviceProvider** (object) - Information about the service provider.
  - **reference** (string) - A reference to the organization resource (e.g., 'Organization/6321').
- **appointment** (object) - Information about the appointment.
  - **reference** (string) - A reference to the appointment resource (e.g., 'Appointment/44172786').
- **partOf** (object) - Information about a related encounter.
  - **reference** (string) - A reference to a related encounter resource (e.g., 'Encounter/128776234').
- **meta** (object) - Metadata associated with the encounter.
  - **tag** (array) - Tags associated with the encounter.
    - **code** (string) - The code of the tag.
    - **display** (any) - The display value of the tag.
- **period** (object) - The time period during which the encounter occurred.
  - **start** (string) - The start time of the encounter.
  - **end** (string) - The end time of the encounter.
- **items** (object) - Items associated with the encounter.
  - **mileage** (array) - Mileage details.
    - **code** (string) - The code for the mileage item.
    - **display** (any) - The display value for the mileage item.
    - **billClient** (boolean) - Whether to bill the client for mileage.
    - **payPractitioner** (boolean) - Whether to pay the practitioner for mileage.
  - **expenseCredit** (array) - Expense credit details.
    - **date** (string) - The date of the expense credit.
    - **amount** (number) - The amount of the expense credit.
    - **description** (string) - The description of the expense credit.
    - **billClient** (boolean) - Whether to bill the client for the expense.
    - **payPractitioner** (boolean) - Whether to pay the practitioner for the expense.
- **rates** (object) - Rate information for the encounter.
  - **payRate** (array) - Pay rate details.
    - **type** (string) - The type of pay rate (e.g., 'Hourly').
    - **name** (string) - The name of the pay rate.
    - **amount** (number) - The amount of the pay rate.
  - **billRate** (array) - Bill rate details.
    - **type** (string) - The type of bill rate (e.g., 'Hourly').
    - **name** (string) - The name of the bill rate.
    - **amount** (number) - The amount of the bill rate.

#### Response Example
```json
{
  "resourceType": "Encounter",
  "id": "128777063",
  "status": "COMPLETE",
  "subject": {
    "display": "John Doe",
    "reference": "Patient/2065430"
  },
  "participant": {
    "Individual": [
      {
        "reference": "Practitioner/2408379",
        "Display": "Jann Doe"
      }
    ]
  },
  "serviceProvider": {
    "reference": "Organization/6321"
  },
  "appointment": {
    "reference": "Appointment/44172786"
  },
  "partOf": {
    "reference": "Encounter/128776234"
  },
  "meta": {
    "tag": [
      {
        "code": "agencyId",
        "display": 1669
      },
      {
        "code": "isParent",
        "display": false
      },
      {
        "code": "childLetter",
        "display": "A"
      }
    ]
  },
  "period": {
    "start": "2022-02-15T12:00:00",
    "end": "2022-02-15T13:00:00"
  },
  "items": {
    "mileage": [
      {
        "code": "mileage",
        "display": 10,
        "billClient": true,
        "payPractitioner": true
      },
      {
        "code": "description",
        "display": "Mileage description"
      }
    ],
    "expenseCredit": [
      {
        "date": "2022-02-15T13:00:00",
        "amount": -20.2,
        "description": "description",
        "billClient": true,
        "payPractitioner": true
      }
    ]
  },
  "rates": {
    "payRate": [
      {
        "type": "Hourly",
        "name": "rate1",
        "amount": 22
      }
    ],
    "billRate": [
      {
        "type": "Hourly",
        "name": "rate1",
        "amount": 25
      }
    ]
  }
}
```

#### Error Responses
- **403** - Forbidden Entity
- **404** - Resource not found/does not exist
- **415** - Format not supported
```

--------------------------------

### Search all subscriptions

Source: https://apidocs.clearcareonline.com/

Fetches all subscriptions with default pagination. No request body is needed.

```bash
v1/subscriptions/_search/ -without payload
```

--------------------------------

### GET /v1/encounter/{carelogid}/

Source: https://apidocs.clearcareonline.com/

Retrieves an Encounter object by its ID.

```APIDOC
## GET /v1/encounter/{carelogid}/

### Description
Get `Encounter` object by id.

### Method
GET

### Endpoint
/v1/encounter/{carelogid}/

### Parameters
#### Path Parameters
- **id** (integer) - Required - ID of the Encounter.
```

--------------------------------

### Organization Search Response Sample

Source: https://apidocs.clearcareonline.com/

A sample JSON response for a successful organization search request.

```json
{
  "entry": 
[
    { 
      "resource": 
{
        "active": true,
        "address": 
[
          { 
            "city": "Anchorage",
            "line": 
[
              "123, new address"
],
            "postalCode": "99546",
            "state": "Alaska",
            "text": "123 new address",
            "type": "postal",
            "use": "work"
}
],
        "id": "5891",
        "meta": 
{ 
          "tag": 
[
            { 
              "code": "subdomain",
              "display": "blue-hc"
}
]
},
        "name": "Blue Home Care",
        "resourceType": "Organization",
        "telecom": 
[
          { 
            "system": "phone",
            "use": "work",
            "value": "8768907456"
},
          { 
            "system": "fax",
            "use": "work",
            "value": "8768907456"
}
]
},
      "search": 
{ 
        "mode": "match",
        "score": 1
}
},
    { 
      "resource": 
{
        "active": true,
        "address": 
[
          { 
            "city": "Anchorage",
            "line": 
[
              "123, new lane"
],
            "postalCode": "99548",
            "state": "Alaska",
            "text": "123 new lane",
            "type": "postal",
            "use": "work"
}
],
        "id": "6312",
        "meta": 
{ 
          "tag": 
[
            { 
              "code": "subdomain",
              "display": "orange-hc"
}
]
},
        "name": "Orange Home Care",
        "resourceType": "Organization",
        "telecom": 
[
          { 
            "system": "phone",
            "use": "work",
            "value": "8909898984"
},
          { 
            "system": "fax",
            "use": "work",
            "value": "8909898984"
}
]
},
      "search": 
{ 
        "mode": "match",
        "score": 1
}
}
],
  "id": "searchParams",
  "resourceType": "Bundle",
  "totalRecords": 2,
  "type": "searchset"

}
```

--------------------------------

### Practitioner Resource Response Sample

Source: https://apidocs.clearcareonline.com/

This is a sample JSON response for a Practitioner resource, typically returned after a successful GET request. It includes the resource type and a unique identifier.

```json
{
  "resourceType": "Practitioner",
  "id": "1"

}
```

--------------------------------

### GET /v1/subscriptions/{id}/

Source: https://apidocs.clearcareonline.com/

Retrieves a specific Subscription object by its ID.

```APIDOC
## GET /v1/subscriptions/{id}/

### Description
Retrieves a specific Subscription object by its ID.

### Method
GET

### Endpoint
https://connect.clearcareonline.com/v1/subscriptions/{id}/

### Parameters
#### Path Parameters
- **id** (integer) - Required - The unique identifier of the Subscription.

### Responses
#### Success Response (200)
- **resourceType** (string) - The type of resource, which is 'Subscription'.
- **id** (integer) - The unique identifier of the Subscription.
- **status** (string) - The current status of the subscription (e.g., 'active').
- **contact** (Array of objects) - Contact information for the subscriber.
- **end** (string) - The date and time when the subscription will expire.
- **reason** (string) - The reason for the subscription.
- **criteria** (string) - The criteria for the subscription.
- **error** (string) - Details about any errors encountered.
- **channel** (object) - Information about the notification channel.
- **meta** (object) - Metadata related to the subscription.

#### Response Example (200)
```json
{
  "resourceType": "Subscription",
  "id": 1,
  "status": "active",
  "contact": [
    {
      "system": "email",
      "use": "work",
      "value": "test@gmail.com"
    },
    {
      "system": "phone",
      "use": "work",
      "value": "9990876689"
    },
    {
      "system": "fax",
      "use": "work",
      "value": "9990876689"
    },
    {
      "system": "phone",
      "use": "mobile",
      "value": "9990876689"
    },
    {
      "system": "phone",
      "use": "home",
      "value": "9990876689"
    }
  ],
  "end": "2021-01-01T00:00:00",
  "reason": "Monitor new neonatal function",
  "criteria": "Observation?code=http://loinc.org|1975-2",
  "error": "No errors",
  "channel": {
    "type": "rest-hook",
    "endpoint": "https://webhook.site/390cc321-b628-497d-8fed-57b2981ed931",
    "payload": "application/fhir+json",
    "header": [
      "Authorization: Bearer secret-token-abc-123"
    ]
  },
  "meta": {
    "tag": [
      {
        "code": "agencyId",
        "display": 1669
      }
    ]
  }
}
```

#### Error Responses
- **403** - Forbidden Entity
- **404** - Resource not found/does not exist
- **415** - Format not supported
```