Appointment
Appointment
Data type: 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).
| Name | Type | Description | Example |
|---|---|---|---|
| validFor (1) | TimePeriod | ||
| @type (1) | string | When sub-classing, this defines the sub-class Extensible name | |
| category | string | Business category : intervention for example or to be more precise after SalesIntervention, orderDeliveryIntervention,... | null |
| creationDate | DateTime | Appointment creation date | null |
| description | string | Short free text describing the appointment | null |
| externalId | string | ||
| externalIdentifier | ExternalIdentifier [n..m] | ||
| lastUpdate | DateTime | Date of last appointment update | null |
| attachment | AttachmentRefOrValue [n..m] | ||
| contactMedium | ContactMedium [n..m] | ||
| note | Note [n..m] | ||
| relatedEntity | AppointmentRelatedEntityRefOrValue [n..m] | ||
| relatedParty | RelatedPartyOrPartyRole [n..m] | ||
| relatedPlace | RelatedPlaceRefOrValue | ||
| status | AppointmentStatusType | ||
| @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 |