Slot - FHIR Resource (stu3)
This Slot Resource uses the FHIR API standard for access and structure.
Validate an Slot FHIR Resource (stu3)
Slot Attributes
AttributeField is listTypeDescription
Description: busy | free | busy-unavailable | busy-tentative | entered-in-error
FHIR Version: stu3
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": "free"Learn more about the (Slot) status FHIR attribute
Description: This slot has already been overbooked, appointments are unlikely to be accepted for this time
FHIR Version: stu3
Attribute Type : boolean
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"overbooked": Learn more about the (Slot) overbooked FHIR attribute
Description: A broad categorisation of the service that is to be performed during this appointment
FHIR Version: stu3
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"serviceCategory": {
"coding": [
{
"code": "17",
"display": "General Practice"
}
]
}Learn more about the (Slot) serviceCategory FHIR attribute
Description: Date/Time that the slot is to conclude
FHIR Version: stu3
Attribute Type : instant
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"end": "2013-12-25T09:30:00Z"Learn more about the (Slot) end FHIR attribute
Description: The schedule resource that this slot defines an interval of status information
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"schedule": {
"reference": "Schedule/example"
}Learn more about the (Slot) schedule FHIR attribute
Description: 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
FHIR Version: stu3
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"serviceType": [
{
"coding": [
{
"code": "57",
"display": "Immunization"
}
]
}
]Learn more about the (Slot) serviceType FHIR attribute
Description: Comments on the slot to describe any extended information. Such as custom constraints on the slot
FHIR Version: stu3
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"comment": "Assessments should be performed before requesting appointments in this slot."Learn more about the (Slot) comment FHIR attribute
Description: The specialty of a practitioner that would be required to perform the service requested in this appointment
FHIR Version: stu3
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"specialty": [
{
"coding": [
{
"code": "408480009",
"display": "Clinical immunology"
}
]
}
]Learn more about the (Slot) specialty FHIR attribute
Description: Date/Time that the slot is to begin
FHIR Version: stu3
Attribute Type : instant
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"start": "2013-12-25T09:15:00Z"Learn more about the (Slot) start FHIR attribute
Description: The style of appointment or patient that may be booked in the slot (not service type)
FHIR Version: stu3
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"appointmentType": {
"coding": [
{
"code": "WALKIN",
"system": "http://hl7.org/fhir/v2/0276",
"display": "A previously unscheduled walk-in visit"
}
]
}Learn more about the (Slot) appointmentType FHIR attribute
Description: External Ids for this item
FHIR Version: stu3
Attribute Type : Identifier
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": Learn more about the (Slot) identifier FHIR attribute
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 them like so:
https://api.1up.health/fhir/stu3/Slot?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
identifier | text | identifier |
schedule | reference | schedule |
slot-type | text | serviceType |
start | date | start |
status | text | status |
