generated: '2026-07-18'
method: derived
source: openapi/credentially-gateway-openapi-original.json
note: Entity graph derived from OpenAPI schemas, tags, and path/id-reference fields (profileId, employeePublicId, stagePublicId, groupPublicId, placementId, locationId). Cardinality inferred from list vs single-resource operations.
entities:
- name: Profile
  description: A clinical staff member's credentialing record (the central entity); addressable by id or email.
  id_fields: [profileId]
  schemas: [ProfileDto, ProfileDetailDto, ProfileLightDto, CreateProfileResponseDto]
- name: Placement
  description: An assignment of a profile to a location/role, progressed across stages on a board.
  id_fields: [placementId, id]
  schemas: [PlacementResponseDto, PlacementPageDto]
- name: PlacementRole
  schemas: [RoleResponse, RoleRequest]
- name: Location
  description: Facility / site where placements occur.
  id_fields: [locationId, id]
  schemas: [LocationResponse, LocationRequest]
- name: LocationType
  schemas: [LocationTypeResponse]
- name: Jurisdiction
  schemas: [JurisdictionResponse]
- name: Stage
  description: A column on the placement board (rename/recolour/enable/reorder).
  id_fields: [stagePublicId]
  schemas: [StageResponse, StageListResponse]
- name: Document
  description: A file attached to a profile, with OCR/auto-fill and approve/reject workflow.
  schemas: [DocumentDto, ActiveFileDto, DocumentTypeDto, OrganisationDocumentTypeDto]
- name: DbsCheck
  description: A DBS (background) check on a profile.
  id_fields: [dbsCheckId]
  schemas: [DbsCheckDto]
- name: CompliancePackage
  description: A set of compliance requirements assignable to a profile.
  schemas: [CompliancePackageDto, CompliancePackageBasicDto, EmployeeComplianceRequirementDto]
- name: OrganisationGroup
  description: A group of profiles (members) within the organisation.
  id_fields: [groupPublicId]
  schemas: [OrganisationGroupDto, OrganisationGroupMemberDto]
- name: Reference
  schemas: [ProfileReferenceDto, ProfileReferencesDto, RefereeDto]
- name: RightToWork
  schemas: [RightToWorkDto]
- name: Note
  description: A note attached to a profile or a placement.
  schemas: [ProfileNoteDto, PlacementNoteResponseDto]
relationships:
- from: Placement
  to: Profile
  type: belongs_to
  via: employeePublicId
- from: Placement
  to: Location
  type: belongs_to
  via: locationId
- from: Placement
  to: PlacementRole
  type: belongs_to
  via: roleId
- from: Placement
  to: Stage
  type: belongs_to
  via: stagePublicId
- from: Document
  to: Profile
  type: belongs_to
  via: profileId
- from: DbsCheck
  to: Profile
  type: belongs_to
  via: profileId
- from: CompliancePackage
  to: Profile
  type: has_many
  via: profileId
- from: OrganisationGroup
  to: Profile
  type: has_many
  via: groupPublicId (members)
- from: Reference
  to: Profile
  type: belongs_to
  via: profileId
- from: RightToWork
  to: Profile
  type: has_one
  via: profileId
- from: Note
  to: Profile
  type: belongs_to
  via: profileId
- from: Note
  to: Placement
  type: belongs_to
  via: placementId