Schedule

A container for slots of time that may be available for booking appointments

http://hl7.org/fhir/R4/schedule.html

Staff availability is denoted separately at each practice location associated with the organization record. The schedule id obtained from a Schedule search is used to search for bookable time slots for appointments.

Endpoints

get
/Schedule
get
/Schedule

Schedule search

Returns a list of location/practitioner combinations that is necessary for identifying open slots when booking appointments. This endpoint does not include any parameters.

Response Payload Attributes

resourceType
string

The FHIR Resource name.

type
string

This element and value designate that the bundle is a search response. Search result bundles will always have the Bundle.type of searchset .

total
integer

The number of resources that match the search parameter.

link
array[json]

Attributes relevant to pagination, see our Pagination page for more detail.

Click to view child attributes
relation
enum [self|first|next|last]

The relation of the page search

url

The search url for the specific relation

entry
array[json]

The results bundle that lists out each object returned in the search

Click to view child attributes
resource
json

The attributes specific to the resource type, see the Attributes section below

Attributes

resourceType
string

The FHIR Resource name.

id
string

The identifier of the schedule.

text
json

Text summary of the resource, for human interpretation.

Click to view child attributes
status

The status of the narrative.

Value Options Supported:
  • generated
div

Limited xhtml content that contains the human readable text of the Schedule.

actor
array[json]

Resource(s) that availability information is being provided for.

Click to view child attributes
reference
string

The reference string of the practitioner in the format of "Practitioner/a39cafb9d1b445be95a2e2548e12a787".

type
string

Type the reference refers to (e.g. “Practitioner”).

comment
string

Comments on availability. Currently the format for this comment will be Schedule for <practitioner credentialed name> at <location>

Responses

200 OK
Request was successful.

Errors

400 Bad Request
The request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401 Unauthorized
The request requires user authentication.
403 Forbidden
The request requires user authorization.
  • curl --request GET \
     --url 'https://fumage-example.canvasmedical.com/Schedule' \
     --header 'Authorization: Bearer <token>' \
     --header 'accept: application/json'

  • import requests

url = "https://fumage-example.canvasmedical.com/Schedule"

headers = {
    "accept": "application/json",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

  •   {
    "resourceType": "Bundle",
    "type": "searchset",
    "total": 8,
    "entry": [
        {
            "resource": {
                "resourceType": "Schedule",
                "id": "Location.1-Staff.e766816672f34a5b866771c773e38f3c",
                "text": {
                    "status": "generated",
                    "div": "<div>Schedule for Youta Priti MD at California</div>"
                },
                "actor": [
                    {
                        "reference": "Practitioner/e766816672f34a5b866771c773e38f3c",
                        "type": "Practitioner"
                    }
                ],
                "comment": "Schedule for Youta Priti MD at California"
            }
        },
        {
            "resource": {
                "resourceType": "Schedule",
                "id": "Location.1-Staff.77bd177f81b14c9f943e1e30ed3dd989",
                "text": {
                    "status": "generated",
                    "div": "<div>Schedule for Breanna Heller LMFT at California</div>"
                },
                "actor": [
                    {
                        "reference": "Practitioner/77bd177f81b14c9f943e1e30ed3dd989",
                        "type": "Practitioner"
                    }
                ],
                "comment": "Schedule for Breanna Heller LMFT at California"
            }
        },
        {
            "resource": {
                "resourceType": "Schedule",
                "id": "Location.1-Staff.f65c2bed0d8643cc808e25d5cfcf5070",
                "text": {
                    "status": "generated",
                    "div": "<div>Schedule for Patrick van Nieuwenhuizen MD at California</div>"
                },
                "actor": [
                    {
                        "reference": "Practitioner/f65c2bed0d8643cc808e25d5cfcf5070",
                        "type": "Practitioner"
                    }
                ],
                "comment": "Schedule for Patrick van Nieuwenhuizen MD at California"
            }
        },
        {
            "resource": {
                "resourceType": "Schedule",
                "id": "Location.2-Staff.e766816672f34a5b866771c773e38f3c",
                "text": {
                    "status": "generated",
                    "div": "<div>Schedule for Youta Priti MD at Tennessee</div>"
                },
                "actor": [
                    {
                        "reference": "Practitioner/e766816672f34a5b866771c773e38f3c",
                        "type": "Practitioner"
                    }
                ],
                "comment": "Schedule for Youta Priti MD at Tennessee"
            }
        },
        {
            "resource": {
                "resourceType": "Schedule",
                "id": "Location.2-Staff.3a182f42885645e0bc3d608e7c02aad8",
                "text": {
                    "status": "generated",
                    "div": "<div>Schedule for Nikhil Krishnan MD at Tennessee</div>"
                },
                "actor": [
                    {
                        "reference": "Practitioner/3a182f42885645e0bc3d608e7c02aad8",
                        "type": "Practitioner"
                    }
                ],
                "comment": "Schedule for Nikhil Krishnan MD at Tennessee"
            }
        },
        {
            "resource": {
                "resourceType": "Schedule",
                "id": "Location.2-Staff.77bd177f81b14c9f943e1e30ed3dd989",
                "text": {
                    "status": "generated",
                    "div": "<div>Schedule for Breanna Heller LMFT at Tennessee</div>"
                },
                "actor": [
                    {
                        "reference": "Practitioner/77bd177f81b14c9f943e1e30ed3dd989",
                        "type": "Practitioner"
                    }
                ],
                "comment": "Schedule for Breanna Heller LMFT at Tennessee"
            }
        },
        {
            "resource": {
                "resourceType": "Schedule",
                "id": "Location.2-Staff.f65c2bed0d8643cc808e25d5cfcf5070",
                "text": {
                    "status": "generated",
                    "div": "<div>Schedule for Patrick van Nieuwenhuizen MD at Tennessee</div>"
                },
                "actor": [
                    {
                        "reference": "Practitioner/f65c2bed0d8643cc808e25d5cfcf5070",
                        "type": "Practitioner"
                    }
                ],
                "comment": "Schedule for Patrick van Nieuwenhuizen MD at Tennessee"
            }
        }
    ]
}

  • {
  "resourceType": "OperationOutcome",
  "issue": [
    {
      "severity": "error",
      "code": "invalid",
      "details": {
        "text": "Bad request"
      }
    }
  ]
}

  • {
  "resourceType": "OperationOutcome",
  "issue": [
    {
      "severity": "error",
      "code": "unknown",
      "details": {
        "text": "Authentication failed"
      }
    }
  ]
}

  • {
  "resourceType": "OperationOutcome",
  "issue": [
    {
      "severity": "error",
      "code": "forbidden",
      "details": {
        "text": "Authorization failed"
      }
    }
  ]
}