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,…​

default null;

creationDate

No

No

Date

Appointment creation date

default null;

description

No

No

String

Short free text describing the appointment

default null;

externalId

No

No

String

default null;

externalIdentifier

No

No

array of ExternalIdentifier

default null;

lastUpdate

No

No

Date

Date of last appointment update

default null;

attachment

No

No

array of AttachmentRefOrValue

default null;

note

No

No

array of Note

default null;

relatedEntity

No

No

array of AppointmentRelatedEntityRefOrValue

default null;

status

No

No

AppointmentStatusType

default null;

validFor

Yes

No

TimePeriod

default null;

@type

Yes

No

String

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

default null;

@baseType

No

No

String

When sub-classing, this defines the super-class

default null;

@schemaLocation

No

No

String

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

default null;

id

No

No

String

Unique identifier

default null;

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

href

No

No

URI

Hyperlink reference

default null;

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