version: working

This is a demonstration Domain for modelling a Cafe that takes orders for drinks.

Data Model of jargon/Cafe

Data Definitions of jargon/Cafe

Store

A Cafe, that sells a limited range of drinks

Property	Definition	Type
id	All Stores are uniquely identified by a numerical identifier.	Numeric
orders	Cafes store a list of their Orders, both historic and current. Orders that are complete have an Order.status value of 'Completed'. For more information see the Order Status Lifecycle.	Order
address	The address of the Cafe	Address

Order

An order for a single drink

Property	Definition	Type
id	A unique identifier for an Order.This identifier is also used to make a Payment for this Order.	Numeric
milk	The type of milk	Code (MilkType)
size	The size of the cup	Code (CupSize)
type	The type of drink	Code (DrinkType)
status		Code (OrderStatus)

Payment

Details of the payment for an order

Property	Definition	Type
status	Identifies if the payment was valid or not.	Code (PaymentStatus)
order		Order

Address

From jargon.AS4590

An Australian Standard representation of an addresss, according to AS4590

Property	Definition	Type
ClientCurrency	Details the relationship between the client and the associated address at the point in time of interchange. The examples provided list the recommended values. Use of additional oralternative Domain values should be accompanied by metadata as agreed by theinvolved parties.	Text
CountryName	A code indicating the country, territory, colony or dependency for an address. The recommended Code description is the list of Country Name Codes in ISO 3166.Other Code description may be used though should be accompanied by metadata toperform the conversion from the abbreviation to the full description as agreed bythe involved parties.	Text
DeliveryPoint	A unique number created by Australia Post for an address.	Text
LevelNumber	Within a complex, the number of the floor or level of a multi-storey building/sub-complex	Text
LevelType	Within a complex, an abbreviation used to distinguish the floor or level of a multi-storey building/sub-complex	Text
Line1	Free text address line 1. Unstructured address may be repeated up to 4 lines (NOTE: where this is anoverseas address the country name code becomes mandatory). This is also used for overseas addresses. NOTE: Where there is a need to transfer an Australian address that does notconform with the commonly used address format, the unstructured address linesmay be used. These data elements should not be used except when it is impossibleto use of the other more structured address data elements.While 4 lines have been provided for unstructured Australian address details, not alllines need to be used.Unstructured address lines, when used, should contain the entire address.	Text
Line2	Free text address line 2	Text
Line3	Free text address line 3	Text
Line4	Free text address line 4	Text
LocalityName	The name of the locality/suburb of the address.	Text
LocationDescriptor	A free text data element to describe the position of the address relative to another physical site. Usage Examples:NEAR THE NORTHBRIDGE OVERPASSVia Blackmans RdOFF PRINCESS STRear 150 Smith StOVER SWANPORT BRIDGE3 km PAST THE BLACK STUMP SIGNDIAGONALLY OPPOSITE TOWN HALLCORNER SMITH STREET	Text
LotNumber	The reference number allocated to a property for subdivision administration purposes prior to road numbering. Usage: Where an official Road number has not been assigned, this field may be used for postal purposes as well as the physical identification of an address site. While the word ‘LOT’ should not appear within this data element, for identification purposes, the word ‘LOT’ must precede the lot number.	Text
PostalDeliveryNumber	Identification number for the channel of postal delivery. Usage Examples:PO BOX C96 (Postal delivery number is C96)RMB 123 (Postal delivery number is 123)	Text
PostalDeliveryType	Identification for the channel of postal delivery. Usage: Used where mail is to be delivered to a box, bag or agent for pick-up by theintended recipient or to the rural mail box number where no other address exists.	Text
Postcode	The Australian numeric descriptor for a postal delivery area, aligned with locality, suburb or place	Text
SiteName	The name of the site, if any, of the location at the address.	Text
StateTerritory	The State or Territory code of the address	Text
Status	To identify the category of the address, as officially assigned by an addressing authority authorised by the Jurisdictional State or Territory, or Australia Post for postal type addresses. The examples provided list the recommended values. Use of additional oralternative Domain values may be used and should be accompanied by metadata asagreed by the involved parties.Official address: indicates that the address and its component parts have beenformally assigned by the responsible state jurisdiction/s.Valid alias address: indicates that the address is an acceptable alias to the officialaddress by the responsible state jurisdiction/s.Invalid alias address: indicates a non-official address. E.g. a vanity address where aperceived up-market locality name is incorrectly used in place of the officiallyassigned locality nameObsolete address: an address that is no longer valid. For example where there is achange of street name, change of locality or where a RMB address previously usedhas been replaced by Rural NumberingWhere the Address Status is not stated or unknown a null entry will be recorded.	Text
StreetName	Name of the street e.g. Archer Street	Text
StreetNumber1	Start of Range Number of the street, e.g.21-25 Archer Street, where streetNumber1 is 21	Text
StreetNumber2	Start of Range Number of the street, e.g.21-25 Archer Street, where streetNumber2 is 25	Text
StreetSuffix	20-24 Genetics Lane North, where North is the street suffix	Text
StreetType	23 Archer Road, where Road is the street type	Text
SubComplexAddress	Complex addresses can require multiple levels of Address.	Address
Type	This element is to distinguish between a physical address (geographical place) or virtual address.	Text
UnitNumber	Mrs Joyce Citizen Apartment 7 (Sub dwelling unit number is 7)Level 3 Apex Building 48 Johnson Rd CLAYTON VIC 3168	Text
UnitType	Mrs Joyce Citizen Apartment 7 (Sub-dwelling unit type code is APT)Level 3 Apex Building 48 Johnson Rd CLAYTON VIC 3168	Text
Usage	The role or use of the address in relation to the client. (Can be an Australian address whilst the client is overseas). Examples include:Primary address—The property address normally used by the client. (Theseaddresses desirably should have been assigned by a Council)NOTE: Where this is the principal place of residence of the client the residentialcode should be used.Secondary address—The address of an additional property attached to the client.Residential—The address of the principal place of residence for the client.Temporary accommodation—The address where the client is resident for atemporary period.Business—The address of the principal place of business for the client.Overseas address—The address used by the client when overseas.Delivery address—The address used for goods delivery purposes.Postal/correspondence—The address used by the client for receipt ofcorrespondence.Where the address purpose is not stated or unknown a null entry will be recorded.An address may have more than one purpose.	Text
UsagePeriod	Usage Period of the address. Start datetime, enddatetime	Text

Code Tables of jargon/Cafe

jargon.codeTables(jargon.Cafe:working[MilkType,CupSize,DrinkType,OrderStatus,PaymentStatus])

State Diagram of Order lifecycle

Open API Specification of jargon/Cafe

This specification is available in different forms:

• As a JSON specification
• As a browsable Swagger Ui page

Imported Domains

• [address] - jargon/AS4590:0.0.2