Skip to content

SearchTimeSlot

SearchTimeSlot

Data type: 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

Name Type Description Example
@type (1) string When sub-classing, this defines the sub-class Extensible name
appointmentCategory string defines the category of appointment time slots are searched for null
externalIdentifier ExternalIdentifier [n..m]
requestDate DateTime Date when the search time slot was requested null
requestPostedDate DateTime Date when the request was posted null
searchResult string Result of the search time slot (success or fail for example) null
state TaskStateType
stateChangeDate DateTime The date and time the state changed. null
stateChangeMessage Message [n..m] Message for the state change described as a combination of a text and a code. []
stateChangeHistory StateChange [n..m]
availableTimeSlot TimeSlot [n..m]
relatedEntity SearchTimeSlotRelatedEntityRefOrValue [n..m]
relatedParty RelatedPartyOrPartyRole
relatedPlace RelatedPlaceRefOrValue
requestedTimeSlot TimeSlot [n..m]
@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