SearchTimeSlot

Extends: Entity

This task resource is used to retrieve available time slots. One of this available time slot is after used to create or reschedule an appointment

Field Required Nullable Type Description Constraints Example

Field	Required	Nullable	Type	Description	Example
`appointmentCategory`	No	No	`String`	defines the category of appointment time slots are searched for
`externalIdentifier`	No	No	`array` of ExternalIdentifier
`requestDate`	No	No	`DateTime`	Date when the search time slot was requested
`requestPostedDate`	No	No	`DateTime`	Date when the request was posted
`searchResult`	No	No	`String`	Result of the search time slot (success or fail for example)
`state`	No	No	`TaskStateType`
`stateChangeDate`	No	No	`DateTime`	The date and time the state changed.
`stateChangeMessage`	No	No	`array` of Message	Message for the state change described as a combination of a text and a code.	[]
`stateChangeHistory`	No	No	`array` of StateChange
`availableTimeSlot`	No	No	`array` of TimeSlot
`relatedEntity`	No	No	`array` of SearchTimeSlotRelatedEntityRefOrValue
`requestedTimeSlot`	No	No	`array` of TimeSlot
`@type`	Yes	No	`String`	When sub-classing, this defines the sub-class Extensible name
`@baseType`	No	No	`String`	When sub-classing, this defines the super-class
`@schemaLocation`	No	No	`String`	A URI to a JSON-Schema file that defines additional attributes and relationships
`id`	No	No	`String`	Unique identifier	2d7ed5fd-9f62-4211-bc84-357f5f7b80f5
`href`	No	No	`URI`	Hyperlink reference	https://api.example.org/resource/id

appointmentCategory

String

defines the category of appointment time slots are searched for

externalIdentifier

array of ExternalIdentifier

requestDate

DateTime

Date when the search time slot was requested

requestPostedDate

DateTime

Date when the request was posted

searchResult

String

Result of the search time slot (success or fail for example)

state

TaskStateType

stateChangeDate

DateTime

The date and time the state changed.

stateChangeMessage

array of Message

Message for the state change described as a combination of a text and a code.

[]

stateChangeHistory

array of StateChange

availableTimeSlot

array of TimeSlot

requestedTimeSlot

array of TimeSlot

@type

Yes

String

When sub-classing, this defines the sub-class Extensible name

@baseType

String

When sub-classing, this defines the super-class

@schemaLocation

String

A URI to a JSON-Schema file that defines additional attributes and relationships

id

String

Unique identifier

2d7ed5fd-9f62-4211-bc84-357f5f7b80f5

href

URI

Hyperlink reference

https://api.example.org/resource/id