Public Sector Solutions Standard Objects

The Public Sector Solutions data models provide objects and fields to support licensing and permitting, inspections and assessments, case and program management, benefit management, grantmaking, and other features for your organization. Use the objects to work with these features and transform the delivery of public services.

Accreditation
Represents the professional accreditations of a facility. For example, a joint commission accredits a facility as a general acute care hospital.
ActionPlan
Represents the instance of an action plan, a set of tasks created from an action plan template. This object is available in API version 44.0 and later.
ActionPlanBaseTemplateAsgn
Represents a junction between an action plan template and a related record. An action plan template can be assigned to a job position, position, or a recruitment requisition. This object is available in API version 62.0 only.
ActionPlanItem
Represents the instance of an action plan item.This object is available in API version 44.0 and later.
ActionPlanTemplate
Represents the instance of an action plan template. This object is available in API version 44.0 and later.
ActionPlanTemplateItem
Represents the instance of an item on an action plan template version. This object is available in API version 44.0 and later.
ActionPlanTemplateItemValue
Represents the value associated with an action plan template item. This object is available in API version 44.0 and later.
ActionPlanTemplateVersion
Represents the version of an action plan template. This object is available in API version 44.0 and later.
ActionPlanTemplateAssignment
Represents a junction between an action plant template's version and the target object associated with them. This object is available in API version 56.0 and later.
ActionPlanTmplItmAssessmentInd
Represents the action plan template items and the assessment indicator definitions associated with them.
ApplicationForm
Represents the high level information of a submitted application. This object is available in API version 62.0 and later.
ApplicationFormEvaluation
Represents the details of the information verification initiated for an object. This object is available in API version 62.0 and later.
ApplicationFormEvalPtcp
Represents information about a user or group of participants who have access to an application form evaluation. This object is available in API version 62.0 and later.
ApplicationFormParticipant
Represents information about a user or group of participants who have access to an application form. This object is available in API version 62.0 and later.
ApplicationFormRelation
Represents the relationship between an application and the context in which it’s held. For example, a application form related to recruitment requisition. This object is available in API version 62.0 and later.
ApplicationDecision
Represents a final decision performed for the specified Application. This object is available in API version 56.0 and later.
ApplicationRenderMethod
Represents how a part of an application can be rendered. This object is available in API version 61.0 and later.
ApplicationReview
Represents a review performed against a specified Application. This object is available in API version 56.0 and later.
ApplicationStageDefinition
Represents a stage of an application. This object is available in API version 61.0 and later.
ApplicationTimeline
Represents the milestone dates in the application process. This object is available in API version 57.0 and later.
AssessmentIndicatorDefinition
Define parameters that act as markers of compliance for inspections. This object is available in API version 47.0 and later.
AssessmentIndDefinedValue
Stores the list of acceptable values which are defined as part of assessment indicator definition for a single and multi select question. This object is available in API version 49.0 and later.
AssessmentIndValue
Stores the list of target or captured values which are defined as part of assessment indicator definition for a single and multi select question. This object is available in API version 49.0 and later.
AssessmentTask
Perform tasks in inspections to capture information. This object is available in API version 47.0 and later.
AssessmentTaskDefinition
Associate an assessment task with an assessment indicator definition. This object is available in API version 48.0 and later.
AssessmentTaskContentDocument
Associate content documents to visits. This object is available in API version 47.0 and later.
AssessmentTaskIndDefinition
Associate an assessment indicator definition with an assessment task definition.This object is available in API version 48.0 and later.
AuthApplicationAsset
Information related to the association between an Asset and the Application for the license of an Asset. This object is available in API version 49.0 and later.
AuthApplicationPlace
Information related to the association between a location and its application for the license of the location. This object is available in API version 49.0 and later.
AuthLocationAccessSchedule
Represents the operating hours during a specified period in which authorization is valid for a place. This object is available in API version 49.0 and later.
Award
Represents a person's or organization's professional awards.
Benefit
Represents the benefits provided by public sector agencies that aim to support citizens and their businesses. This object stores whether the benefit is for financial or service-based organizations.
BenefitAssignment
Represents the enrollment information of an individual or business that is captured in an application. For example, an individual who is unemployed can raise an application requesting help from the government. If it is approved, the individual is enrolled into the unemployment insurance benefit. This object is available in API version 52.0 and later.
BenefitAssignmentAdjustment
Represents a monetary or non-monetary benefit adjustment made to an enrollee that can be disbursed in various frequencies. This object is available in API version 56.0 and later.
BenefitDisbursement
Represents the allocation of an enrollee's benefit that can be made as monetary or non-monetary with different frequencies. This object is available in API version 56.0 and later.
BenefitDisbursementAdj
Represents the changes of an enrollee's benefit that can be made as monetary or non-monetary with similar units of measure. This object is available in API version 56.0 and later.
BenefitItemCode
Represents information about a code set or a code set bundle that identifies an item that is associated with a benefit. This object is available in API version 59.0 and later.
BenefitPrvdSearchableFld
Represents a collection of denormalized data from certain fields in the Provider Management data model. Provider search queries this object instead of multiple objects, which improves search performance. This object is available in API version 59.0 and later.
BenefitSchedule
Represents information about the plan for delivering the benefit. This object is available in API version 58.0 and later.
BenefitScheduleAssignment
Represents the junction between Benefit Schedule and Benefit Assignment objects. This object is available in API version 59.0 and later.
BenefitSession
Represents information about an instance of a planned benefit delivery This object is available in API version 58.0 and later.
BenefitSpecialty
Represents a junction between a benefit and a care specialty. The object maps the benefits provided to constituents with the specialties offered by the network of service providers. This object is available in API version 59.0 and later.
BenefitType
Represents information about the type of benefits that can be applied to an individual or a group.
BoardCertification
Represents the practitioner's board certifications such as being board-certified in cardiology and cardiovascular disease.
Budget
Tracks an estimate of future revenue or expenses during a specific time period. This object is available in API version 53.0 and later.
BudgetAllocation
Represents a subsection of a Budget that shows where allocated resources are being applied. This object is available in API version 53.0 and later.
BudgetCategory
Represents the purpose of the budget line item. This object is available in API version 57.0 and later.
BudgetCategoryValue
Captures budget values for category and time period. This object is available in API version 57.0 and later.
BudgetParticipant
Represents information about a user or group of participants who have access to a budget. This object is available in API version 59.0 and later.
BudgetPeriod
Defines a distinct time interval in which the estimate applies. This object is available in API version 57.0 and later.
BusinessLicense
Represents an authorization issued by a regulatory agency. The authorization can be granted to an organization, a contact, or a specific user.
BusinessLicenseApplication
Represents an application form submitted by a business owner. This object is available in API version 49.0 and later.
BusinessMilestone
Represents the milestones of a business, such as acquisition, market listing, and expansion.
BusinessProfile
Represents details about the business on the license or permit application. This object is available in API version 49.0 and later.
BusinessType
Represents a category of any activity (business or individual), such as healthcare, restaurant, or retail. This object is available in API version 49.0 and later.
BusRegAuthorizationType
Represents the association between authorization activity and license or permit type.
BusRegAuthTypeDependency
Information related to the association of permit to permit dependency in a given business context. This object is available in API version 50.0 and later.
CareBarrier
Represents an obstacle or circumstance that prevents a constituent from getting the required care or services. This object is available in API version 61.0 and later.
CareBarrierType
Represents the standard, defined list of barriers maintained by an organization. This object is available in API version 61.0 and later.
CarePlan
Represents an instantiation of a care plan template for a particular individual in order to reach specific goals. This object is available in API version 55.0 and later.
CarePlanDetail
Represents additional information associated with a care plan record. These details may be things addressed by the care plan, contributors in the care plan, supporting information, and so on. This object is available in API version 61.0 and later.
CarePlanTemplate
Represents the template for a type of care plan that can be offered for a household scenario. This object is available in API version 55.0 and later.
CarePlanTemplateBenefit
Represents a junction between a care plan template and a benefit. This object stores the benefit details of a care plan. This object is available in API version 55.0 and later.
CarePlanTemplateGoal
Represents a junction between a care plan template and a goal definition. This object stores the goal details of a care plan template. This object is available in API version 55.0 and later.
CareProviderAdverseAction
Captures adverse actions against the provider, such as malpractice lawsuits or revoked licenses.
CareProviderFacilitySpecialty
Represents all the specialties that the practitioner provides at a given location. For example, a physician who is board-certified in both spine and neuro may provide spine services at one location and neuro services at another.
CareSpecialty
Represents a listing of provider specialty codes and descriptions.
CaseEpisode
Represents the episode linked to a case or a case proceeding result, where a business or person or license is the subject. This object is available in API version 58.0 and later.
CaseParticipant
Represents a junction between a case, and an account or a contact. This object stores the details of the participant associated with a case. This participant could be the applicant, co-applicant, a household, or even a business account. This object is available in API version 54.0 and later.
CaseProceeding
Represents a legal and formal demand for the enforcement of an individual’s rights against another party in a court of justice. This object is available in API version 58.0 and later.
CaseProceedingComplaint
Represents the association between a complaint and its corresponding case proceeding. This object is available in API version 58.0 and later.
CaseProceedingInfraction
Represents the association between an infraction and its corresponding case proceeding. This object is available in API version 58.0 and later.
CaseProceedingParticipant
Represents a junction between the case proceeding and a participant, such as an account or a contact. This object stores the details of a participant who is involved in a case proceeding. This object is available in API version 58.0 and later.
CaseProceedingResult
Represents the outcome of a legal case for a participant. This object is available in API version 58.0 and later.
CaseProgram
Represents the junction between Case and Program objects. This object is available in API version 57.0 and later.
Claim
Represents the types of claims, such as life, auto, or home.
ClaimItem
Represents claim items (such as collision damage, roadside assistance, rental care) and their coverage details.
ClaimParticipant
Represents the participants of a claim such as those insured, the claimants, and the witnesses. The object associates claims with participant accounts.
CodeSet
Represents various industry defined codes in the context of their systems and versions of those systems. These codes are used in all sorts of digital records. This object is available in API version 59.0 and later.
CodeSetBundle
Represents a group of code sets across multiple systems and versions. All of these code sets refer to the same conceptual entity. This object is available in API version 59.0 and later.
ComplaintCase
Represents the association between a public complaint and its corresponding case. This object is available in API version 52.0 and later.
ComplaintParticipant
Represents a junction between a public complaint, and an account or a contact. This object stores the details of the participant who registers a complaint with the authorities. This participant could be the applicant, co-applicant, a household, or even a business account. This object is available in API version 54.0 and later.
Contact
Represents a contact, which is a person associated with an account.
ContactProfile
Represents information about an individual, such as their ethnicity, citizenship, birth place, race, and so on.
CourseOffering
Represents an instance of a training course with location and date details of training courses This object is available in API version 49.0 and later.
CustodyChainEntry
Represents information about an entry or event in the chain of custody. This object is available in API version 59.0 and later.
CustodyItem
Represents information about an item in the custody chain. This object is available in API version 59.0 and later.
CustodyItemRelation
Represents the relationship between a custody item and the context in which it’s held. For example, a custody item related to a case or case proceeding. This object is available in API version 59.0 and later.
CustodyItemRgltyCodeVio
Represents a junction between a custody item and the related regulatory code violation. The violation can be related to laws, regulations, or code that is associated with the custody item. This object is available in API version 59.0 and later.
DocumentChecklistItem
Represents a checklist item for a file documentation upload.
Employee2
Represents an employee within a company or an organization. This object is available in API version 62.0 and later.
Employment
Represents the details of an individual's employment with an organization. This object is available in API version 62.0 and later.
EmploymentOffer
Represents an employment offer for a selected candidate. This object is available in API version 62.0 and later.
EmploymentOfferVettingEval
Represents a junction between an employment offer and a vetting evaluation of the offer recipient. This object is available in API version 62.0 and later.
Examination
Represents information about the authorized examinations that qualify a license or permit. This object is available in API version 49.0 and later.
FundingAward
Represents an award given to an individual or organization to facilitate a goal related to the funder’s mission. This object is available in API version 57.0 and later.
FundingAwardAmendment
Represents a modification to the scope or finances of a previously approved award. This object is available in API version 57.0 and later.
FundingAwardParticipant
Represents information about a user or group of participants who have access to a funding award. This object is available in API version 59.0 and later.
FundingAwardRequirement
Represents a deliverable or milestone that is needed for the award to either be approved or closed. This object is available in API version 57.0 and later.
FundingAwardRqmtSection
Represents a part of a funding award requirement to be completed or reviewed. This object is available in API version 62.0 and later.
FundingDisbursement
Represents a payment that has been made or scheduled to be made to a funding recipient. This object is available in API version 57.0 and later.
FundingOpportunity
The pool of money available for distribution for a specific purpose. This object is available in API version 57.0 and later.
FundingOppParticipant
Represents information about a user or group of participants who have access to a funding opportunity. This object is available in API version 60.0 and later.
GenericVisitTask
Represents information about a task that can be performed during a visit.
GenericVisitTaskContext
Represents the context or purpose for a generic visit task.
GoalAssignment
Represents the assignment of a goal. This object is available in API version 55.0 and later.
GoalAssignmentDetail
Represents additional information associated with a goal assignment. This object is available in API version 61.0 and later.
GoalDefinition
The definition of a care plan goal in the reusable PGI library that’s a part of Integrated Care Management. When instantiated, GoalDefinition records create GoalAssignment records that serve as goals in care plans. This object is available in API version 57.0 and later.
GnrcVstKeyPerformanceInd
Represents the key performance indicators that can be recorded while performing a task during a visit. You can compare the expected and actual metric values with the key performance indicator records.
GnrcVstTaskContextRelation
Represents common attributes used for a visit task and a visit task context.
HealthcareFacility
Represents a healthcare facility and all its related details. These details may be physical, functional, geographic, or business details.
HealthcarePractitionerFacility
Represents the different locations in which a practitioner provides services.
HealthcareProvider
Represents business-level details about the provider organization or the practitioner.
HealthcareProviderNpi
Represents identifiers from the National Provider Identifier that are assigned to every facility and licensed practitioner in the United States. Also includes NPI assigned date, primary mailing address on file, and so on.
HealthcareProviderSpecialty
Represents specialties for a practitioner or a provider service organization. A provider can have multiple specialties such as anesthesiology and cardiovascular.
IndividualApplication
Represents an application form submitted by an individual or organization. This object is available in API version 50.0 and later.
IndividualApplicationTask
Represents a task related to an application. This object is available in the API version 61.0 and later.
IndividualApplnParticipant
Represents information about a user or group of participants who have access to a individual application. This object is available in API version 59.0 and later.
InspectionAssessmentInd
Represents the assessment indicators recorded during an inspection. This object is available in API version 49.0 and later.
InspectionType
Represents the type of inspections related to a permit or license. This object is available in API version 49.0 and later.
InsurancePolicy
Represents a type of insurance policy. This object is available in API version 59.0 and later.
InsurancePolicyTransaction
Represents a transaction related to a change that affects the premium of an insurance policy, such as an endorsement, renewal, or cancellation. This object is available in API version 60.0 and later.
IntakeFormSection
Represents a section of an intake form such as a job application, a complaint, or a referral. This object is available in API version 63.0 and later.
Interaction
Represents an interaction (phone call, in-person meeting, or video conference) between two or more people (attendees), typically including at least one representative and one customer or partner.
InteractionAttendee
Represents an attendee of an interaction.
InteractionRelatedAccount
Represents a junction between an interaction and account that's related to that interaction.
InteractionSumDiscussedAccount
Represents information about the companies discussed in an interaction.
InteractionSummary
Represents the summary of an interaction, including confidentiality information.
JobApplnSearchableField
Represents searchable data for job applications, enabling criteria-based search and filtering to find applications that match the user-specific criteria. This object is available in API version 62.0 and later.
JobPosition
Represents an instance of employment in a particular position in the organization. This object is available in API version 62.0 and later.
JobPositionPayGrade
Represents a junction between a job position and a position pay grade. This object is available in API version 62.0 and later.
JobPostingSearchableField
Object used for searching and Filtering published Job Postings. This object is available in API version 62.0 and later.
JobPstnRecruitmentRqs
Represents a junction between a job position and a recruitment requisition. This object is available in API version 62.0 and later.
Location
Represents a warehouse, service vehicle, work site, or other element of the region where your team performs field service work. You can associate activities with specific locations. Activities, such as the tasks and events related to a location, appear in the activities timeline when you view the location detail page.
Occupation
Represents a group of positions that engage in a specialized line of work and require a connected set of skills, knowledge, or qualifications. For example, the occupation of Registered Nurses in the Healthcare occupation group. This object is available in API version 62.0 and later.
OccupationGroup
Represents a group of occupations that involve broadly similar functions, knowledge and skills, or materials and equipment. For example, Architecture and Engineering, Military, and Healthcare. This object is available in API version 62.0 and later.
OmniAssessmentTask
Represents the information about an assessment task that is associated with an OmniScript. This object is available in API version 55.0 and later.
OmniDataPack
For internal use only.
OmniDataTransform
For internal use only.
OmniDataTransformItem
For internal use only.
OmniESignature
For internal use only.
OmniProcess
For internal use only.
OmniProcessCompilation
For internal use only.
OmniProcessElement
For internal use only.
OmniProcessOmniAsmtTask
Represents a junction between an omni process and an omni assessment task. This object is available in API version 63.0 and later.
OmniProcessTransientData
For internal use only.
OmniScriptSavedSession
For internal use only.
OmniUiCard
For internal use only.
OperatingHours
Represents the hours that a facility is open.
OperatingHoursHoliday
Represents the day or hours for which a provider or practitioner facility is unavailable to offer service.
PartyCertifiedCapacity
Represents the information captured from the certificate of capacity, such as the party's capacity to work, a timeline for recovery, and return to work. This object is available in API version 60.0 and later.
PartyExpense
Represents the expense incurred by an individual or account. This object is available in API version 58.0 and later.
PartyFinancialAsset
Represents the financial asset owned by an individual or account. This object is available in API version 58.0 and later.
PartyIncome
Represents all income earned by an individual. The income could be from various sources such as salary, commissions, fees, rental properties, and so on.
PartyProfile
Represents information about the profile of a party, such as an account. This object is available in API version 62.0 and later.
PartyProfileAddress
Represents information about the address of the party. This object is available in API version 62.0 and later.
PayGrade
Represents a range of positions that require sufficiently similar responsibilities and competencies, and are associated with a common pay band. This object is available in API version 62.0 and later.
PayGradeStep
Represents a pay range within the pay band associated with a pay grade. Pay steps enable pay raises within the pay band. This object is available in API version 62.0 and later.
PayGradeStepLocation
Represents a junction between a pay grade step and a location. This object is available in API version 62.0 and later.
PaymentRequest
Represents a financial compensation request for goods or services provided by a third party. This object is available in API version 60.0 and later.
PaymentRequestLine
Represents the line item details of the financial compensation request. This object is available in API version 60.0 and later.
PersonDisability
Represents information about a person's disability. This object is available in API version 58.0 and later.
PersonEducation
Represents information about the professional education for a person.
PersonEmployment
Represents information about a person’s employment.
PersonExamination
Represents the examinations taken by a person. This object is available in API version 49.0 and later.
PersonLifeEvent
Represents the life events of an individual, such as marriage, birth of a child, birthday, engagement.
Polygon
Represents a polygon with the polygon mapping data stored as a blob. This object is available in API version 50.0 and later.
Position
Represents a functional role that is characterized by specific duties and responsibilities, and required skills and qualifications. This object is available in API version 62.0 and later.
PositionPayGrade
Represents a junction between a position and a pay grade. This object is available in API version 62.0 and later.
PreliminaryApplicationRef
Represents the saved applications and pre-screening forms. This object is available in API version 49.0 and later.
Program
Represents information about the enrollment and disbursement of benefits in a program.
ProgramCohortMember
Represents program enrollees that are part of a given cohort. This object is available in API version 61.0 and later.
ProgramEnrollment
Represents details of enrollment for benefits in a program. This object is available in API version 57.0 and later.
PublicApplicationParticipant
Represents a junction between an individual application or business license application, and an account or a contact. This object stores the details of the participants associated with an application. This participant could be the applicant, co-applicant, a household, or even a business account that is added to an application. This object is available in API version 58.0 and later.
PublicComplaint
Represents the complaints submitted by public users. This object is available in API version 49.0 and later.
RecruitmentContentSection
Represents the content that you want to include in a section of a recruitment posting. This object is available in API version 62.0 and later.
RecruitmentPosting
Represents an advertisement of a vacancy that you're recruiting for and specifies when and where the advertisement is posted. This object is available in API version 62.0 and later.
RecruitmentPostingCntntSect
Represents a junction between a recruitment posting and a recruitment content section. This object is available in API version 62.0 and later.
RecruitmentRequisition
Represents a formal request to recruit for a position or a provider vacancy. This object is available in API version 62.0 and later.
RecruitmentRequisitionLoc
Represents a junction between recruitment requisition and location This object is available in API version 62.0 and later.
RecruitmentRequisitionPtcp
Represents information about a user or group of participants who have access to a recruitment requisition. This object is available in API version 62.0 and later.
RecurrenceSchedule
Represents the recurrence schedule for a benefit schedule. This object is available with Program Management in API version 57.0 and later.
ReceivedDocument
Contains a request for an operation to be performed on a document, such as rotating, splitting, or text extraction.
ReceivedDocumentType
Represents a junction object between Received Document and Document Type. This object is available in API version 58.0 and later.
Referral
Represents the information on client referrals in an organization. This object is available in API version 56.0 and later.
RegulatoryAuthority
Represents an organization or government agency that provides authorization. This object is available in API version 49.0 and later.
RegulatoryAuthorizationType
Represents the authorization issued by the regulatory body.
RegulatoryCode
Represents the regulation code enforced by the regulatory body. This object is available in API version 49.0 and later.
RegulatoryCodeUse
Represents a junction between a set of assessment questions and the regulatory code associated with them. This object is available in API version 55.0 and later.
RegCodeAssessmentInd
Represents the regulatory codes and the assessment indicator definitions associated with them. This object is available in API version 49.0 and later.
RegulatoryCodeViolation
Represents the transactional violation data that has been identified during an inspection. This entity ties the inspection question that is violated, violation reason and the regulatory code details. This object is available in API version 49.0 and later.
RegulatoryTrxnFee
Represents the association of regulatory transaction fees with your applications, inspections, or violations. This object is available in API version 51.0 and later.
RegulatoryTrxnFeeItem
Represents the storage of specific fee items associated with your regulatory transaction fees. This object is available in API version 51.0 and later.
RegAuthorizationTypeProduct
Represents the association of authorization type and product. This object is available in API version 49.0 and later.
SignatureTask
Represents the signature-related information that a visitor captures as part of a visit. This object is available in API version 50.0 and later.
SignatureTaskLineItem
Represents a junction between a signature task and a digital signature captured in a visit. This object is available in API version 50.0 and later.
TagCategory
Group similar interest tags together into tag categories.
TimeSlot
Represents a range of time on a specified day of the week during which a provider or practitioner offers service. Operating hours consist of one or more time slots. Operating hours consist of one or more time slots.
TrainingCourseParticipant
Represents the trainings completed by a person. This object is available in API version 49.0 and later.
TrnCourse
Represents information about the authorized trainings that qualify a license or permit. This object is available in API version 49.0 and later.
VettingEvaluation
Represents the evaluation of a candidate based on a vetting procedure. This object is available in API version 62.0 and later.
ViolationEnforcementAction
Represents the action that a regulatory authority takes to address violations. This object is available in API version 49.0 and later.
ViolationType
Represents violations types for licenses and permits. This object is available in API version 49.0 and later.
ViolationTypeUse
Represents a junction between a set of assessment questions and the violation type associated with them. This object is available in API version 55.0 and later.
ViolationTypeAssessmentInd
Represents violation types associated with assessment indicator definitions. This object is available in API version 49.0 and later.
Visit
Represents a visit to inspect, assess compliance, or assess an applicant’s ability to get a license or permit or inspect. This object is available in API version 47.0 and later.
Visitor
Represents the inspectors performing inspection visits. This object is available in API version 56.0 and later.
VisitedParty
Represents the contact person at the account that’s being visited. This object is available in API version 49.0 and later.
VolunteerProject
Represents information about activities that must be carried out within a certain time frame, at a specified location, by one or more volunteers.
WorkerCompCoverageClass
Represents the compensation coverage class that a worker belongs to. This object is available in API version 60.0 and later.

Public Sector Solutions Developer Guide

Public Sector Solutions Standard Objects

See Also