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

Attributes

id
string

The identifier of the schedule

text
json

Descriptive and status information about the schedule

actor
array[json]

Resource(s) (practitioner or location) that availability information is being provided for

comment
string

Comments on availability

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.

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"
      }
    }
  ]
}