Slot - FHIR Resource (dstu2)
This Slot Resource uses the FHIR API standard for access and structure.
Validate an Slot FHIR Resource (dstu2)
Slot Attributes
AttributeField is listTypeDescription
Description: This slot has already been overbooked, appointments are unlikely to be accepted for this time
FHIR Version: dstu2
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: Comments on the slot to describe any extended information. Such as custom constraints on the slot
FHIR Version: dstu2
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"comment": Learn more about the (Slot) comment FHIR attribute
Description: Date/Time that the slot is to conclude
FHIR Version: dstu2
Attribute Type : instant
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"end": Learn more about the (Slot) end FHIR attribute
Description: The schedule resource that this slot defines an interval of status information
FHIR Version: dstu2
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"schedule": Learn more about the (Slot) schedule FHIR attribute
Description: busy | free | busy-unavailable | busy-tentative
FHIR Version: dstu2
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"freeBusyType": Learn more about the (Slot) freeBusyType FHIR attribute
Description: Date/Time that the slot is to begin
FHIR Version: dstu2
Attribute Type : instant
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"start": Learn more about the (Slot) start FHIR attribute
Description: External Ids for this item
FHIR Version: dstu2
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
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: dstu2
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"type": Learn more about the (Slot) type FHIR attribute
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
"type" : { 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
"schedule" : { Reference(Schedule) }, // R! The schedule resource that this slot defines an interval of status information
"freeBusyType" : "<code>", // R! busy | free | busy-unavailable | busy-tentative
"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/dstu2/Slot?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
fb-type | text | freeBusyType |
identifier | text | identifier |
schedule | reference | schedule |
slot-type | text | type |
start | date | start |
