Slot - FHIR Resource (stu3)


This Slot Resource uses the FHIR API standard for access and structure.

Validate an Slot FHIR Resource (stu3)



Resource Attributes

AttributeField is listTypeDescription
appointmentTypefalseCodeableConcept# The style of appointment or patient that may be booked in the slot (not service type)
commentfalsestring# Comments on the slot to describe any extended information. Such as custom constraints on the slot
endfalseinstant# Date/Time that the slot is to conclude
identifiertrueIdentifier# External Ids for this item
overbookedfalseboolean# This slot has already been overbooked, appointments are unlikely to be accepted for this time
schedulefalseReference# The schedule resource that this slot defines an interval of status information
serviceCategoryfalseCodeableConcept# A broad categorisation of the service that is to be performed during this appointment
serviceTypetrueCodeableConcept# 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
specialtytrueCodeableConcept# The specialty of a practitioner that would be required to perform the service requested in this appointment
startfalseinstant# Date/Time that the slot is to begin
statusfalsecode# busy | free | busy-unavailable | busy-tentative | entered-in-error

Slot Example

{
  "status": "free",
  "comment": "Assessments should be performed before requesting appointments in this slot.",
  "serviceCategory": {
    "coding": [
      {
        "code": "17",
        "display": "General Practice"
      }
    ]
  },
  "end": "2013-12-25T09:30:00Z",
  "schedule": {
    "reference": "Schedule/example"
  },
  "resourceType": "Slot",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n\t\t\t25 Dec 2013 9:15am - 9:30am: <b>Busy</b> Physiotherapy\n\t\t</div>"
  },
  "serviceType": [
    {
      "coding": [
        {
          "code": "57",
          "display": "Immunization"
        }
      ]
    }
  ],
  "specialty": [
    {
      "coding": [
        {
          "code": "408480009",
          "display": "Clinical immunology"
        }
      ]
    }
  ],
  "start": "2013-12-25T09:15:00Z",
  "appointmentType": {
    "coding": [
      {
        "code": "WALKIN",
        "system": "http://hl7.org/fhir/v2/0276",
        "display": "A previously unscheduled walk-in visit"
      }
    ]
  },
  "id": "example"
}

Slot Structure


  
{
  "resourceType" : "Slot",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // External Ids for this item
  "serviceCategory" : { CodeableConcept }, // A broad categorisation of the service that is to be performed during this appointment
  "serviceType" : [{ CodeableConcept }], // 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
  "specialty" : [{ CodeableConcept }], // The specialty of a practitioner that would be required to perform the service requested in this appointment
  "appointmentType" : { CodeableConcept }, // The style of appointment or patient that may be booked in the slot (not service type)
  "schedule" : { Reference(Schedule) }, // R!  The schedule resource that this slot defines an interval of status information
  "status" : "<code>", // R!  busy | free | busy-unavailable | busy-tentative | entered-in-error
  "start" : "<instant>", // R!  Date/Time that the slot is to begin
  "end" : "<instant>", // R!  Date/Time that the slot is to conclude
  "overbooked" : <boolean>, // This slot has already been overbooked, appointments are unlikely to be accepted for this time
  "comment" : "<string>" // Comments on the slot to describe any extended information. Such as custom constraints on the slot
}


 

Slot Search Parameters

The following search parameters can be used to query Slot resources. Just submit the like so:

https://api.1up.health/fhir/stu3/Slot?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
identifiertextidentifier
schedulereferenceschedule
slot-typetextserviceType
startdatestart
statustextstatus