Appointment

Extends

Entity

An Appointment is an arrangement to do something or meet someone at a particular time, at a place (for face to face appointment) or in a contact medium (for phone appointment).

Field Required Nullable Type Description Constraints Example

category

No

No

String

Business category : intervention for example or to be more precise after SalesIntervention, orderDeliveryIntervention,…​

creationDate

No

No

DateTime

Appointment creation date

description

No

No

String

Short free text describing the appointment

externalId

No

No

String

externalIdentifier

No

No

array of ExternalIdentifier

lastUpdate

No

No

DateTime

Date of last appointment update

attachment

No

No

array of AttachmentRefOrValue

note

No

No

array of Note

relatedEntity

No

No

array of AppointmentRelatedEntityRefOrValue

status

No

No

AppointmentStatusType

validFor

Yes

No

TimePeriod

@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