Patient
@icure/medical-device-sdk / Patient
Class: Patient
Implementsβ
Table of contentsβ
Constructorsβ
Propertiesβ
- active
- addresses
- administrativeNote
- alias
- author
- birthSex
- civility
- codes
- companyName
- created
- dateOfBirth
- dateOfDeath
- deactivationReason
- deceased
- deletionDate
- education
- endOfLife
- ethnicity
- externalId
- firstName
- gender
- id
- identifiers
- labels
- languages
- lastName
- maidenName
- mergeToPatientId
- mergedIds
- modified
- names
- nationality
- note
- parameters
- partnerName
- partnerships
- patientHealthCareParties
- patientProfessions
- personalStatus
- picture
- placeOfBirth
- placeOfDeath
- profession
- properties
- race
- responsible
- rev
- spouseName
- ssin
- systemMetaData
Methodsβ
Constructorsβ
constructorβ
β’ new Patient(json
)
Parametersβ
Name | Type |
---|---|
json | IPatient |
Defined inβ
Propertiesβ
activeβ
β’ active: boolean
Is the patient active (boolean).
Implementation ofβ
PotentiallyEncryptedPatient.active
Defined inβ
addressesβ
β’ addresses: Address
[]
the list of addresses (with address type).
Implementation ofβ
PotentiallyEncryptedPatient.addresses
Defined inβ
administrativeNoteβ
β’ Optional
administrativeNote: string
An administrative note, not confidential.
Implementation ofβ
PotentiallyEncryptedPatient.administrativeNote
Defined inβ
aliasβ
β’ Optional
alias: string
An alias of the person, nickname, ...
Implementation ofβ
PotentiallyEncryptedPatient.alias
Defined inβ
authorβ
β’ Optional
author: string
The id of the [User] that created this patient. When creating the patient, this field will be filled automatically by the current user id if not provided.
Implementation ofβ
PotentiallyEncryptedPatient.author
Defined inβ
birthSexβ
β’ Optional
birthSex: PatientBirthSexEnum
the birth sex of the patient: male, female, indeterminate, unknown
Implementation ofβ
PotentiallyEncryptedPatient.birthSex
Defined inβ
civilityβ
β’ Optional
civility: string
Mr., Ms., Pr., Dr. ...
Implementation ofβ
PotentiallyEncryptedPatient.civility
Defined inβ
codesβ
β’ codes: Set
<CodingReference
>
A code is an item from a codification system that qualifies the content of this patient.
Implementation ofβ
PotentiallyEncryptedPatient.codes
Defined inβ
companyNameβ
β’ Optional
companyName: string
the name of the company this patient is member of.
Implementation ofβ
PotentiallyEncryptedPatient.companyName
Defined inβ
createdβ
β’ Optional
created: number
the creation date of the patient (encoded as epoch).
Implementation ofβ
PotentiallyEncryptedPatient.created
Defined inβ
dateOfBirthβ
β’ Optional
dateOfBirth: number
The birthdate encoded as a fuzzy date on 8 positions (YYYYMMDD) MM and/or DD can be set to 00 if unknown (19740000 is a valid date).
Implementation ofβ
PotentiallyEncryptedPatient.dateOfBirth
Defined inβ
dateOfDeathβ
β’ Optional
dateOfDeath: number
The date of death encoded as a fuzzy date on 8 positions (YYYYMMDD) MM and/or DD can be set to 00 if unknown (19740000 is a valid date).
Implementation ofβ
PotentiallyEncryptedPatient.dateOfDeath
Defined inβ
deactivationReasonβ
β’ deactivationReason: PatientDeactivationReasonEnum
When not active, the reason for deactivation.
Implementation ofβ
PotentiallyEncryptedPatient.deactivationReason
Defined inβ
deceasedβ
β’ Optional
deceased: boolean
Is the patient deceased.
Implementation ofβ
PotentiallyEncryptedPatient.deceased
Defined inβ
deletionDateβ
β’ Optional
deletionDate: number
the soft delete timestamp. When a patient is βdeletedβ, this is set to a non null value: the moment of the deletion
Implementation ofβ
PotentiallyEncryptedPatient.deletionDate
Defined inβ
educationβ
β’ Optional
education: string
The level of education (college degree, undergraduate, phd).
Implementation ofβ
PotentiallyEncryptedPatient.education
Defined inβ
endOfLifeβ
β’ Optional
endOfLife: number
Soft delete (unix epoch in ms) timestamp of the patient
Implementation ofβ
PotentiallyEncryptedPatient.endOfLife
Defined inβ
ethnicityβ
β’ Optional
ethnicity: string
The ethnicity of the patient.
Implementation ofβ
PotentiallyEncryptedPatient.ethnicity
Defined inβ
externalIdβ
β’ Optional
externalId: string
An external (from another source) id with no guarantee or requirement for unicity .
Implementation ofβ
PotentiallyEncryptedPatient.externalId
Defined inβ
firstNameβ
β’ Optional
firstName: string
the firstname (name) of the patient.
Implementation ofβ
PotentiallyEncryptedPatient.firstName
Defined inβ
genderβ
β’ Optional
gender: PatientGenderEnum
the gender of the patient: male, female, indeterminate, changed, changedToMale, changedToFemale, unknown
Implementation ofβ
PotentiallyEncryptedPatient.gender
Defined inβ
idβ
β’ Optional
id: string
the Id of the patient. We encourage using either a v4 UUID or a HL7 Id.
Implementation ofβ
PotentiallyEncryptedPatient.id
Defined inβ
identifiersβ
β’ identifiers: Identifier
[]
Typically used for business / client identifiers. An identifier should identify a patient uniquely and unambiguously. However, iCure can't guarantee the uniqueness of those identifiers : This is something you need to take care of.
Implementation ofβ
PotentiallyEncryptedPatient.identifiers
Defined inβ
labelsβ
β’ labels: Set
<CodingReference
>
A label is an item from a codification system that qualifies a patient as being member of a certain class, whatever the value it might have taken. If the label qualifies the content of a field, it means that whatever the content of the field, the label will always apply. LOINC is a codification system typically used for labels.
Implementation ofβ
PotentiallyEncryptedPatient.labels
Defined inβ
languagesβ
β’ languages: string
[]
the list of languages spoken by the patient ordered by fluency (alpha-2 code http://www.loc.gov/standards/iso639-2/ascii_8bits.html).
Implementation ofβ
PotentiallyEncryptedPatient.languages
Defined inβ
lastNameβ
β’ Optional
lastName: string
the lastname (surname) of the patient. This is the official lastname that should be used for official administrative purposes.
Implementation ofβ
PotentiallyEncryptedPatient.lastName
Defined inβ
maidenNameβ
β’ Optional
maidenName: string
Lastname at birth (can be different of the current name), depending on the country, must be used to design the patient .
Implementation ofβ
PotentiallyEncryptedPatient.maidenName
Defined inβ
mergeToPatientIdβ
β’ Optional
mergeToPatientId: string
The id of the patient this patient has been merged with.
Implementation ofβ
PotentiallyEncryptedPatient.mergeToPatientId
Defined inβ
mergedIdsβ
β’ mergedIds: Set
<string
>
The ids of the patients that have been merged inside this patient.
Implementation ofβ
PotentiallyEncryptedPatient.mergedIds
Defined inβ
modifiedβ
β’ Optional
modified: number
the last modification date of the patient (encoded as epoch).
Implementation ofβ
PotentiallyEncryptedPatient.modified
Defined inβ
namesβ
β’ names: PersonName
[]
the list of all names of the patient, also containing the official full name information. Ordered by preference of use. First element is therefore the official name used for the patient in the application
Implementation ofβ
PotentiallyEncryptedPatient.names
Defined inβ
nationalityβ
β’ Optional
nationality: string
The nationality of the patient.
Implementation ofβ
PotentiallyEncryptedPatient.nationality
Defined inβ
noteβ
β’ Optional
note: string
A text note (can be confidential, encrypted by default).
Implementation ofβ
PotentiallyEncryptedPatient.note
Defined inβ
parametersβ
β’ parameters: Object
Extra parameters
Index signatureβ
βͺ [key: string
]: string
[]
Implementation ofβ
PotentiallyEncryptedPatient.parameters
Defined inβ
partnerNameβ
β’ Optional
partnerName: string
Lastname of the partner, should not be used to design the patient.
Implementation ofβ
PotentiallyEncryptedPatient.partnerName
Defined inβ
partnershipsβ
β’ partnerships: Partnership
[]
List of partners, or persons of contact (of class Partnership, see below).
Implementation ofβ
PotentiallyEncryptedPatient.partnerships
Defined inβ
patientHealthCarePartiesβ
β’ patientHealthCareParties: PatientHealthCareParty
[]
Links (usually for therapeutic reasons) between this patient and healthcare parties (of class PatientHealthcareParty).
Implementation ofβ
PotentiallyEncryptedPatient.patientHealthCareParties
Defined inβ
patientProfessionsβ
β’ patientProfessions: CodingReference
[]
Codified list of professions exercised by this patient.
Implementation ofβ
PotentiallyEncryptedPatient.patientProfessions
Defined inβ
personalStatusβ
β’ Optional
personalStatus: PatientPersonalStatusEnum
any of single
, in_couple
, married
, separated
, divorced
, divorcing
, widowed
, widower
, complicated
, unknown
, contract
, other
.
Implementation ofβ
PotentiallyEncryptedPatient.personalStatus
Defined inβ
pictureβ
β’ Optional
picture: ArrayBuffer
A picture usually saved in JPEG format.
Implementation ofβ
PotentiallyEncryptedPatient.picture
Defined inβ
placeOfBirthβ
β’ Optional
placeOfBirth: string
The place of birth.
Implementation ofβ
PotentiallyEncryptedPatient.placeOfBirth
Defined inβ
placeOfDeathβ
β’ Optional
placeOfDeath: string
The place of death.
Implementation ofβ
PotentiallyEncryptedPatient.placeOfDeath
Defined inβ
professionβ
β’ Optional
profession: string
The current professional activity.
Implementation ofβ
PotentiallyEncryptedPatient.profession
Defined inβ
propertiesβ
β’ properties: Set
<Property
>
Extra properties
Implementation ofβ
PotentiallyEncryptedPatient.properties
Defined inβ
raceβ
β’ Optional
race: string
The race of the patient.
Implementation ofβ
PotentiallyEncryptedPatient.race
Defined inβ
responsibleβ
β’ Optional
responsible: string
The id of the data owner that is responsible of this patient. When creating the patient, will be filled automatically by the current user data owner id ([HealthcareProfessional], [Patient] or [MedicalDevice]) if missing
Implementation ofβ
PotentiallyEncryptedPatient.responsible
Defined inβ
revβ
β’ Optional
rev: string
the revision of the patient in the database, used for conflict management / optimistic locking.
Implementation ofβ
PotentiallyEncryptedPatient.rev
Defined inβ
spouseNameβ
β’ Optional
spouseName: string
Lastname of the spouse for a married woman, depending on the country, can be used to design the patient.
Implementation ofβ
PotentiallyEncryptedPatient.spouseName
Defined inβ
ssinβ
β’ Optional
ssin: string
Social security inscription number.
Implementation ofβ
PotentiallyEncryptedPatient.ssin
Defined inβ
systemMetaDataβ
β’ Optional
systemMetaData: SystemMetaDataOwnerEncrypted
Implementation ofβ
PotentiallyEncryptedPatient.systemMetaData
Defined inβ
Methodsβ
marshalβ
βΈ marshal(): IPatient
Returnsβ
IPatient