Client

A client represents a patient / resident in a health care facility.

type Client {
  actionPlanHistory: [CompletedActionPlan!]
  activeAbsence: TemporaryAbsence
  activeCareDegree: CareDegree
  activeContract: Contract
  activeHealthInsurance: InsuranceBillingData @deprecated
  activeLtci: InsuranceBillingData @deprecated
  additionalSupportServices: [SupportService!]!
  admittedAt: Date
  admittedBy: Employee
  allergies: [AllergyData!]!
  apartment(
    refDate: Date
  ): Apartment
  assignedContacts(
    type: ContactType
  ): [Contact!]
  bankAccounts: [ClientBankAccount!]
  benefitsCalendar(
    startDate: Date!
  ): [BenefitCalendarEntry!]!
  bloodSugarInsulinReport(
    filter: ReportFilterInput!
  ): BloodSugarInsulinReport
  bookedBenefits(
    filter: BookedBenefitsFilterInput!
  ): [Benefit!]!
  budgetAccounts: BudgetAccounts! @deprecated
  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
  deceasedOn: Date
  demiseIncidentReportDraft: DemiseIncidentReport
  demiseIncidentReportHistory: [DemiseIncidentReport!]
  diagnoses: [ICD10Code!]
  documents: [Document]
  draftActionPlan: DraftActionPlan
  emergencyCall: EmergencyCall
  familyDoctor: DoctorContact
  hasDebtorAccount: Boolean!
  hasSepaMandates: Boolean! @deprecated
  helpingToolsData: HelpingToolsData!
  housingSituation: [HousingSituationData!]!
  id: ClientID!
  impairments: [ImpairmentData!]!
  internetProvider: InternetProvider @deprecated
  intolerances: [IntoleranceData!]!
  invalidAddress: Boolean!
  invoices(
    month: Date!
  ): [Invoice!]
  isAmbulantLivingCommunity: Boolean!
  isArchived: Boolean!
  latestFinalisedStructuredInformation: StructuredInformation
  medicalCharacteristics: [String!]!
  medicalDiagnosis: [ClientMedicalDiagnosis!]!
  medicationPlans(
    filter: MedicationPlanFilter
  ): [MedicationPlan!]!
  medications: Medications!
  notes: String
  payerConfiguration(
    on: Date!
  ): ClientPayerConfiguration
  payerConfigurations: [ClientPayerConfiguration!]!
  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!
  sepaMandateStatus: SepaMandateStatus
  serviceAreas: [ServiceArea!]!
  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 care degree valid today, i.e. whose period from startDate to endDate contains today. Periods may overlap; then the last entered care degree takes precedence. Null if no care degree is valid today.

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 deprecated object

DEPRECATED

Use Client.payerConfiguration(on:)

The Krankenkasse the client has today, derived from the Kostenträger configuration: the differing Krankenkasse where one is recorded, the Kasse otherwise.

Returns null if no configuration is in force today or it records no Kasse. Filled: insuranceNumber, fundingAgency (and fundingAgencyId), validFrom, billingDataId (the id of the payer-configuration slice, the same for activeLtci) and invoiceRecipient.isClient; privateInvoice is always false. The supplementary-recipient, split and deduction fields are always empty.

Client.activeLtci ● InsuranceBillingData deprecated object

DEPRECATED

Use Client.payerConfiguration(on:)

The Pflegekasse the client has today, derived from the Kostenträger configuration.

Returns null if no configuration is in force today or it records no Kasse. Filled: insuranceNumber, fundingAgency (and fundingAgencyId), validFrom, billingDataId (the id of the payer-configuration slice, the same as for activeHealthInsurance) and invoiceRecipient.isClient; privateInvoice is always false. The supplementary-recipient, split and deduction fields are always empty.

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.assignedContacts ● [Contact!] list interface

List of contacts assigned to the client. If type is provided, fetches only contacts of given type (e.g. 'DOCTOR')

Client.assignedContacts.type ● ContactType enum

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! deprecated non-null object

DEPRECATED

No longer read by the client file; the Kostenträger configuration resolves the budget per Dienstbereich

The list of budget accounts assigned to this client.

Client.careDegreeDocumentations ● [CareDegreeDocumentation!] list object

Optional documentations regarding care degree changes, the latest application date (requestedOn) first. Entries without an application date come last.

Client.careDegrees ● [CareDegree!]! non-null object

List of recorded care degrees in entry order, the last entered one first. 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.deceasedOn ● Date scalar

When the client has deceased (optional)

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.familyDoctor ● DoctorContact object

The client's assigned family doctor, if any.

Client.hasDebtorAccount ● Boolean! non-null scalar

Returns true, if a debtor account is configured.

Client.hasSepaMandates ● Boolean! deprecated non-null scalar

DEPRECATED

Counts draft mandates as well. Use sepaMandateStatus.

Returns true if the client has at least one SEPA mandate, in any status — a draft counts too.

Client.helpingToolsData ● HelpingToolsData! non-null object

The helping tools assigned to the client with the corresponding current status

Client.housingSituation ● [HousingSituationData!]! non-null object

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

DEPRECATED

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.invalidAddress ● Boolean! non-null scalar

Shows if the client address is valid based on the graphhopper api

Client.invoices ● [Invoice!] list object

Fetches the invoices of a client for a single calendar month

Client.invoices.month ● Date! non-null scalar

Client.isAmbulantLivingCommunity ● Boolean! non-null scalar

Indicates if the client lives in an ambulant living community.

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 most recently finalised structured information

Client.medicalCharacteristics ● [String!]! non-null scalar

List of all additional medical conditions that the client has (e.g. diabetes)

Client.medicalDiagnosis ● [ClientMedicalDiagnosis!]! non-null object

List of all diagnosis of the client

Client.medicationPlans ● [MedicationPlan!]! non-null object

List of medication plans for the client.

Client.medicationPlans.filter ● MedicationPlanFilter input

Client.medications ● Medications! non-null object

All data regarding the client's medications

Client.notes ● String scalar

Additional information about the client (optional)

Client.payerConfiguration ● ClientPayerConfiguration object

The payer configuration valid on on. Null if none is — e.g. a gap between two slices, or no configuration at all.

Client.payerConfiguration.on ● Date! non-null scalar

Client.payerConfigurations ● [ClientPayerConfiguration!]! non-null object

All payer configuration time slices for this client, newest first.

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

DEPRECATED

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.sepaMandateStatus ● SepaMandateStatus enum

The most usable status among the SEPA mandates of the client: VALID as soon as one mandate is valid, otherwise DRAFT if one is still a draft. Null if the client has neither — no mandate at all, or only expired ones.

Client.serviceAreas ● [ServiceArea!]! non-null enum

The service areas the client is covered by today: those of the active contract, then SGB_V_HKP if the client has a prescription that is active today (see the serviceAreas filter of clientDirectory). No contract and no prescription gives an empty list. Without duplicates.

This is what the serviceAreas filter of clientDirectory matches against: a client is listed for a service area exactly when it is in this list.

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

DEPRECATED

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

ActivateMedicationPlanPayload object ● AddMedicationPayload object ● Apartment object ● AssignClientFamilyDoctorPayload object ● AssignContactToClientPayload object ● BenefitDashboardDetail object ● CareTeam object ● Client object ● ClientAbsenceInformation object ● ClientDirectoryEdge object ● ClientEntry object ● ClientMonthlyRevenue object ● ClientPendingDegree object ● ClientsCostsBudgetRatio object ● ClientWorkItem object ● CommentReportCard object ● CommitScanPayload object ● ConnectedPerson object ● ContractDetails object ● CopyMedicationPlanPayload object ● CreateMedicationPlanPayload object ● DividedPerformanceReport object ● DocumentedDemiseIncident object ● EndMedicationPlanPayload object ● IncompleteClientEntry object ● Invoice object ● MyDayReportSheetEntry object ● OccupancyReportHint object ● OccupancyReportResident object ● PerformanceReportDetails object ● Prescription object ● PrescriptionClientDetails object ● RemoveMedicationPayload object ● RentContract object ● ReportCard interface ● ReportSheetReportCard object ● ResetMedicationPlanToDraftPayload object ● ResidentialPark object ● RevenuePlanInvoice object ● SingleClientEntry object ● SingleClientWorkItem object ● SisReportCard object ● UnassignClientFamilyDoctorPayload object ● UnassignContactFromClientPayload object ● UpdateMedicationPayload object ● UpdateMedicationPlanPayload object ● VitalSignReportCard object