Client
A client represents a patient / resident in a health care facility.
type Client {
actionPlanHistory: [CompletedActionPlan!]
activeAbsence: TemporaryAbsence
activeCareDegree: CareDegree
activeContract: Contract
activeHealthInsurance: InsuranceBillingData
activeLtci: InsuranceBillingData
additionalSupportServices: [SupportService!]!
admittedAt: Date
admittedBy: Employee
allergies: [AllergyData!]!
apartment(
refDate: Date
): Apartment
bankAccounts: [ClientBankAccount!]
benefitsCalendar(
startDate: Date!
): [BenefitCalendarEntry!]!
bloodSugarInsulinReport(
filter: ReportFilterInput!
): BloodSugarInsulinReport
bookedBenefits(
filter: BookedBenefitsFilterInput!
): [Benefit!]!
budgetAccounts: BudgetAccounts!
careDegreeDocumentations: [CareDegreeDocumentation!]
careDegrees(
filter: CareDegreeFilterInput
): [CareDegree!]!
careEnd: LocalDateTime
careRelevantInformation: CareRelevantInformation
careStart: LocalDateTime
careTeam: CareTeam
careType: String
connectedPerson: ConnectedPerson
contactPersons(
types: [ContactPersonRelation!]
): [ContactRef!]!
contract(
id: ContractID!
): Contract!
contracts: [Contract!]!
counsellingInterview(
date: Date
): CounsellingInterview!
currentActionPlan: CompletedActionPlan
debtorAccountCode: String
demiseIncidentReportDraft: DemiseIncidentReport
demiseIncidentReportHistory: [DemiseIncidentReport!]
diagnoses: [ICD10Code!]
documents: [Document]
draftActionPlan: DraftActionPlan
emergencyCall: EmergencyCall
hasDebtorAccount: Boolean!
hasSepaMandates: Boolean!
healthInsuranceBillingData: [InsuranceBillingData!]!
helpingToolsData: HelpingToolsData!
housingSituation: [String!]!
id: ClientID!
impairments: [ImpairmentData!]!
internetProvider: InternetProvider @deprecated
intolerances: [IntoleranceData!]!
invoices(
month: Date!
): [Invoice!]
isArchived: Boolean!
latestFinalisedStructuredInformation: StructuredInformation
ltciBillingData: [InsuranceBillingData!]!
medicalCharacteristics: [String!]!
medications: Medications!
notes: String
performanceReport(
filter: ReportFilterInput!
): PerformanceReport
phoneProvider: PhoneProvider @deprecated
physicalConditions: [String!]!
prescription(
id: PrescriptionID!
): Prescription!
prescriptions: [Prescription!]!
rentContracts: [RentContract!]!
reportSheet(
filter: ReportSheetFilter
): [ReportSheetEntry!]!
residentialPark: ResidentialPark!
self: PersonalData!
severeDisabilities: SevereDisabilities
status: ClientStatus!
structuredInformationDraft: StructuredInformation
structuredInformationHistory: [StructuredInformation]
suppliedWith: [Client!]
temporaryAbsences(
filter: ClientTemporaryAbsenceFilter
): [TemporaryAbsence!]!
tvProvider: TvProvider @deprecated
vitalSignTypes(
date: Date!
): [VitalSignType!]!
vitalSigns(
after: String
filter: VitalSignsFilterInput!
first: Int!
): VitalSignConnection!
}
Fields
Client.actionPlanHistory ● [CompletedActionPlan!] list object
Complete action plan history
Client.activeAbsence ● TemporaryAbsence object
Returns the currently active absence of the client. Optional, returns null if the client is not absent currently.
Client.activeCareDegree ● CareDegree object
The current active care degree. "active" = Status "approved" with the newest due date according to now
See Client.careDegrees for historical information.
Client.activeContract ● Contract object
Fetches the active contract of the client. Returns null if there is yet no active contract.
Client.activeHealthInsurance ● InsuranceBillingData object
The current active health insurance.
Returns null if there is no active health insurance.
See Client.healthInsuranceBillingData for historical information.
Client.activeLtci ● InsuranceBillingData object
The current active long-term care insurance.
Returns null if there is no active long-term care insurance.
See Client.ltciBillingData for historical information.
Client.additionalSupportServices ● [SupportService!]! non-null object
Additional support services that the client uses (e.g. pharmacy)
Client.admittedAt ● Date scalar
When the client was admitted in the residential park
Client.admittedBy ● Employee object
The employee that admitted the client
Client.allergies ● [AllergyData!]! non-null object
All factors the client is allergic to (e.g. pollen)
Client.apartment ● Apartment object
The apartment the client is living in at the given date.
Client.apartment.refDate ● Date scalar
(Optional) Defaults to the current date if not specified.
Client.bankAccounts ● [ClientBankAccount!] list object
List of associated bank accounts.
Client.benefitsCalendar ● [BenefitCalendarEntry!]! non-null object
Fetches all benefit calendar entries for this client in given 7 days period.
Client.benefitsCalendar.startDate ● Date! non-null scalar
Client.bloodSugarInsulinReport ● BloodSugarInsulinReport object
Fetches the blood sugar insulin report for the client at a given time period.
Returns null, if there is no report for this time period.
Client.bloodSugarInsulinReport.filter ● ReportFilterInput! non-null input
Client.bookedBenefits ● [Benefit!]! non-null interface
Fetches all benefits that are booked for the client in the current contract
Client.bookedBenefits.filter ● BookedBenefitsFilterInput! non-null input
Client.budgetAccounts ● BudgetAccounts! non-null object
The list of budget accounts assigned to this client.
Client.careDegreeDocumentations ● [CareDegreeDocumentation!] list object
Optional documentations regarding care degree changes
Client.careDegrees ● [CareDegree!]! non-null object
List of recorded care degrees Optionally works with date range and fetches only care degrees valid between two dates
Client.careDegrees.filter ● CareDegreeFilterInput input
Client.careEnd ● LocalDateTime scalar
End of the client's care in the residential park (due to moving, death, etc.), optional
Client.careRelevantInformation ● CareRelevantInformation object
Additional information regarding the client care needs (free text)
Client.careStart ● LocalDateTime scalar
When the client's care in the residential park started
Client.careTeam ● CareTeam object
(Optional) If null, the client is not assigned to any specific care team.
Client.careType ● String scalar
Client.connectedPerson ● ConnectedPerson object
Person that the client lives with at the institution (e.g. spouse)
Client.contactPersons ● [ContactRef!]! non-null object
Additional contact persons.
Client.contactPersons.types ● [ContactPersonRelation!] list enum
Client.contract ● Contract! non-null object
Fetches a single contract by contract id.
Client.contract.id ● ContractID! non-null scalar
Client.contracts ● [Contract!]! non-null object
Fetches all contracts for this client.
Client.counsellingInterview ● CounsellingInterview! non-null object
Contains data about the counselling interview held with a certain client
Client.counsellingInterview.date ● Date scalar
Client.currentActionPlan ● CompletedActionPlan object
The actual action plan of the client
Client.debtorAccountCode ● String scalar
The associated debtor account. Necessary for the DATEV exports.
Client.demiseIncidentReportDraft ● DemiseIncidentReport object
Fetch the client's current demise incident draft
Client.demiseIncidentReportHistory ● [DemiseIncidentReport!] list object
Fetch all client's historical demise incident reports
Client.diagnoses ● [ICD10Code!] list object
All diagnoses assigned to the client
Client.documents ● [Document] list object
All documents attached to this client
Client.draftActionPlan ● DraftActionPlan object
The actual draft
Client.emergencyCall ● EmergencyCall object
Client.hasDebtorAccount ● Boolean! non-null scalar
Returns true, if a debtor account is configured.
Client.hasSepaMandates ● Boolean! non-null scalar
Returns true if the client has at least one SEPA mandate
Client.healthInsuranceBillingData ● [InsuranceBillingData!]! non-null object
List of all recorded health insurance information, including history.
Client.helpingToolsData ● HelpingToolsData! non-null object
The helping tools assigned to the client with the corresponding current status
Client.housingSituation ● [String!]! non-null scalar
Specific information about the living conditions of the client (e.g. no refrigerator available)
Client.id ● ClientID! non-null scalar
Unique identifier of the client
Client.impairments ● [ImpairmentData!]! non-null object
List of all impaired abilities of the client (e.g. hearing)
Client.internetProvider ● InternetProvider deprecated enum
No longer supported
Deprecated. Has to be reworked later.
Client.intolerances ● [IntoleranceData!]! non-null object
Substances that are not suitable for consumption by the client (e.g. gluten)
Client.invoices ● [Invoice!] list object
Fetches the invoices of a client for a single calendar month
Client.invoices.month ● Date! non-null scalar
Client.isArchived ● Boolean! non-null scalar
A flag to show if the client is active (TRUE) or archived (FALSE)
Client.latestFinalisedStructuredInformation ● StructuredInformation object
return the last finalised structured information based on conversation date
Client.ltciBillingData ● [InsuranceBillingData!]! non-null object
List of all recorded long-term care insurance information, including history.
Client.medicalCharacteristics ● [String!]! non-null scalar
List of all additional medical conditions that the client has (e.g. diabetes)
Client.medications ● Medications! non-null object
All data regarding the client's medications
Client.notes ● String scalar
Additional information about the client (optional)
Client.performanceReport ● PerformanceReport object
Fetches the benefit performance report for the client for a given time period.
Returns null if the performance report for the given month is not yet available.
Client.performanceReport.filter ● ReportFilterInput! non-null input
Client.phoneProvider ● PhoneProvider deprecated enum
No longer supported
Deprecated. Has to be reworked later.
Client.physicalConditions ● [String!]! non-null scalar
List of physical conditions that the client has (e.g. depression)
Client.prescription ● Prescription! non-null object
Fetches a single prescription by prescription id.
Client.prescription.id ● PrescriptionID! non-null scalar
Client.prescriptions ● [Prescription!]! non-null object
Fetches all prescriptions for this client.
Client.rentContracts ● [RentContract!]! non-null object
A list of all current, future and past rent contracts of this client.
Client.reportSheet ● [ReportSheetEntry!]! non-null object
Fetches the report sheet entries of a client
Client.reportSheet.filter ● ReportSheetFilter input
Client.residentialPark ● ResidentialPark! non-null object
Park the client is managed by.
Client.self ● PersonalData! non-null object
Personal data of the client, including name, address, and contact information.
Client.severeDisabilities ● SevereDisabilities object
Shows the severe disability of a client if they experience one
Client.status ● ClientStatus! non-null enum
Current status of the client
Client.structuredInformationDraft ● StructuredInformation object
get the structured information draft
Client.structuredInformationHistory ● [StructuredInformation] list object
retrieve all finalised structured information for a client
Client.suppliedWith ● [Client!] list object
All clients supplied at the same residential park
Client.temporaryAbsences ● [TemporaryAbsence!]! non-null object
A list of all temporary absences of the client
Client.temporaryAbsences.filter ● ClientTemporaryAbsenceFilter input
Client.tvProvider ● TvProvider deprecated enum
No longer supported
Deprecated. Has to be reworked later.
Client.vitalSignTypes ● [VitalSignType!]! non-null enum
Returns all vital sign types of a client for a given date
Client.vitalSignTypes.date ● Date! non-null scalar
Client.vitalSigns ● VitalSignConnection! non-null object
Return all vital signs of a client for a given period
Client.vitalSigns.after ● String scalar
Client.vitalSigns.filter ● VitalSignsFilterInput! non-null input
Client.vitalSigns.first ● Int! non-null scalar
Returned By
assignClientToCareTeam mutation ● client query ● clients query ● createClient mutation ● updateClientCoreData mutation
Member Of
Apartment object ● BenefitDashboardDetail object ● CareTeam object ● Client object ● ClientAbsenceInformation object ● ClientEntry object ● ClientMonthlyRevenue object ● ClientPendingDegree object ● ClientsCostsBudgetRatio object ● ClientWorkItem object ● ConnectedPerson object ● ContractDetails object ● DividedPerformanceReport object ● IncompleteClientEntry object ● Invoice object ● PerformanceReportDetails object ● PrescriptionClientDetails object ● RentContract object ● ResidentialPark object ● SingleClientEntry object ● SingleClientWorkItem object