clqms-be/public/components/schemas/master-data.yaml
mahdahar fcaf9b74ea feat: Restructure OpenAPI documentation with modular components
- Add OpenApiDocs controller for serving bundled API docs

- Split monolithic api-docs.yaml into modular components/

- Add organized paths/ directory with endpoint definitions

- Create bundling scripts (JS, PHP, Python) for merging docs

- Add API_DOCS_README.md with documentation guidelines

- Update Routes.php for new API documentation endpoints

- Update swagger.php view and TestDefSiteModel
2026-02-16 14:20:52 +07:00

158 lines
3.5 KiB
YAML

Location:
type: object
properties:
LocationID:
type: integer
description: Primary key
SiteID:
type: integer
description: Reference to site
LocCode:
type: string
maxLength: 6
description: Location code (short identifier)
Parent:
type: integer
nullable: true
description: Parent location ID for hierarchical locations
LocFull:
type: string
maxLength: 255
description: Full location name
Description:
type: string
maxLength: 255
description: Location description
LocType:
type: string
description: Location type code (e.g., ROOM, WARD, BUILDING)
CreateDate:
type: string
format: date-time
EndDate:
type: string
format: date-time
nullable: true
Contact:
type: object
properties:
ContactID:
type: integer
description: Primary key
NameFirst:
type: string
description: First name (required)
NameLast:
type: string
description: Last name
Title:
type: string
description: Title (e.g., Dr, Mr, Mrs)
Initial:
type: string
description: Middle initial
Birthdate:
type: string
format: date-time
description: Date of birth
EmailAddress1:
type: string
format: email
description: Primary email address
EmailAddress2:
type: string
format: email
description: Secondary email address
Phone:
type: string
description: Primary phone number
MobilePhone1:
type: string
description: Primary mobile number
MobilePhone2:
type: string
description: Secondary mobile number
Specialty:
type: string
description: Medical specialty code
SubSpecialty:
type: string
description: Sub-specialty code
CreateDate:
type: string
format: date-time
EndDate:
type: string
format: date-time
description: Occupation display text
Occupation:
type: object
properties:
OccupationID:
type: integer
description: Primary key
OccCode:
type: string
description: Occupation code
OccText:
type: string
description: Occupation name/text
Description:
type: string
description: Additional description
CreateDate:
type: string
format: date-time
MedicalSpecialty:
type: object
properties:
SpecialtyID:
type: integer
description: Primary key
SpecialtyText:
type: string
description: Specialty name/text
Parent:
type: integer
description: Parent specialty ID for hierarchical structure
Title:
type: string
description: Title/abbreviation
CreateDate:
type: string
format: date-time
EndDate:
type: string
format: date-time
Counter:
type: object
properties:
CounterID:
type: integer
description: Primary key
CounterDesc:
type: string
description: Counter description/name
CounterValue:
type: integer
description: Current counter value
CounterStart:
type: integer
description: Starting value for the counter
CounterEnd:
type: integer
description: Ending value (for auto-reset)
CounterReset:
type: string
description: Reset pattern (e.g., D=Daily, M=Monthly, Y=Yearly)
CreateDate:
type: string
format: date-time
EndDate:
type: string
format: date-time