Slot read

get/Slot/{id}
Page View

This resource contains details for available appointment times for a healthcare organization. There may be one or more slots allotted to a particular period of time (e.g., five appointments available per hour) or multiple participants for an appointment.

A Slot resource only includes an indicator for available/busy, not detailed information about available appointments. It’s expected that you'd use this resource to kick off a workflow in your own system to book an appointment.

You can review or retrieve available appointment times.

read

Review a specific Slot resource with available appointment times for a given healthcare organization.

To use a read interaction, you must know the related resource ID, which you may not have in your real workflows. A read is likely only a follow-up option after receiving the specific resource in a recent FHIR® passthrough or data on demand exchange.

Typically, you should use the more flexible _search with query parameters, unless you're guaranteed to request data directly from a FHIR® server using the resource ID. Learn more about using FHIR® identifiers.

Request parameters

cURL request example

bash
1
curl 'https://api.redoxengine.com/fhir/R4/{destinationSlug}/{environmentFlag}/Slot/{id}' \
2
--request GET \
3
--header 'Authorization: Bearer $API_TOKEN'

Request Parameters

  • id
    required, string

    Slot identifier

Response fields and example

1400 Appointment
json
1
{}
  • resourceType
    required, string

    Identifies the type of the resource

    Value: Slot
  • schedule
    required, object

    The schedule resource that this slot defines an interval of status information.

    Must be a resource of type Schedule.

    • reference
      string

      A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.

  • status
    required, string

    busy | free | busy-unavailable | busy-tentative | entered-in-error.

    Possible Values: busy, free, busy-unavailable, busy-tentative, entered-in-error
  • start
    required, string

    Date/Time that the slot is to begin.

  • end
    required, string

    Date/Time that the slot is to conclude.

  • id
    string

    The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

  • contained
    Array of Schedule, Practitioner or Location

    These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

    • resourceType
      required, string

      Identifies the type of the resource

      Value: Schedule
    • actor
      required, Array of object

      Slots that reference this schedule resource provide the availability details to these referenced resource(s).

      Must reference one of the following types of resources:

      • Practitioner
      • Location
      • reference
        string

        A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.

    • id
      string

      The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

    • active
      boolean

      Whether this schedule record is in active use or should not be used (such as was entered in error).

  • identifier
    Array of object

    External Ids for this item.

    • extension
      Array of Boolean, String, CodeableConcept, Coding

      May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

      • url
        required, string

        Source of the definition for the extension code - a logical name or a URL.

      • valueBoolean
        boolean

        A single value for the extension.

    • use
      string

      The purpose of this identifier.

      Possible Values: usual, official, temp, secondary, old (If known)
    • system
      string

      Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

    • value
      string

      The portion of the identifier typically relevant to the user and which is unique within the context of the system.

  • serviceType
    Array of object

    The type of appointments that can be booked into this slot (ideally this would be an identifiable service - which is at a location, rather than the location itself). If provided then this overrides the value provided on the availability resource.

    • coding
      Array of object

      A reference to a code defined by a terminology system.

      • system
        string

        The identification of the code system that defines the meaning of the symbol in the code.

      • code
        string

        A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

    • text
      string

      A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.