PotentiallyEncryptedPatient
@icure/medical-device-sdk / PotentiallyEncryptedPatient
Interface: PotentiallyEncryptedPatient
Implemented by
Table of contents
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
Properties
active
• active: boolean
Is the patient active (boolean).
Defined in
addresses
• addresses: Address
[]
the list of addresses (with address type).
Defined in
administrativeNote
• Optional
administrativeNote: string
An administrative note, not confidential.
Defined in
alias
• Optional
alias: string
An alias of the person, nickname, ...
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.
Defined in
birthSex
• Optional
birthSex: PatientBirthSexEnum
the birth sex of the patient: male, female, indeterminate, unknown
Defined in
civility
• Optional
civility: string
Mr., Ms., Pr., Dr. ...
Defined in
codes
• codes: Set
<CodingReference
>
A code is an item from a codification system that qualifies the content of this patient.
Defined in
companyName
• Optional
companyName: string
the name of the company this patient is member of.
Defined in
created
• Optional
created: number
the creation date of the patient (encoded as epoch).
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).
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).
Defined in
deactivationReason
• deactivationReason: PatientDeactivationReasonEnum
When not active, the reason for deactivation.
Defined in
deceased
• Optional
deceased: boolean
Is the patient 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
Defined in
education
• Optional
education: string
The level of education (college degree, undergraduate, phd).
Defined in
endOfLife
• Optional
endOfLife: number
Soft delete (unix epoch in ms) timestamp of the patient
Defined in
ethnicity
• Optional
ethnicity: string
The ethnicity of the patient.
Defined in
externalId
• Optional
externalId: string
An external (from another source) id with no guarantee or requirement for unicity .
Defined in
firstName
• Optional
firstName: string
the firstname (name) of the patient.
Defined in
gender
• Optional
gender: PatientGenderEnum
the gender of the patient: male, female, indeterminate, changed, changedToMale, changedToFemale, unknown
Defined in
id
• Optional
id: string
the Id of the patient. We encourage using either a v4 UUID or a HL7 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.
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.
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).
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.
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 .
Defined in
mergeToPatientId
• Optional
mergeToPatientId: string
The id of the patient this patient has been merged with.
Defined in
mergedIds
• mergedIds: Set
<string
>
The ids of the patients that have been merged inside this patient.
Defined in
modified
• Optional
modified: number
the last modification date of the patient (encoded as epoch).
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
Defined in
nationality
• Optional
nationality: string
The nationality of the patient.
Defined in
note
• Optional
note: string
A text note (can be confidential, encrypted by default).
Defined in
parameters
• parameters: Object
Extra parameters
Index signature
▪ [key: string
]: string
[]
Defined in
partnerName
• Optional
partnerName: string
Lastname of the partner, should not be used to design the patient.
Defined in
partnerships
• partnerships: Partnership
[]
List of partners, or persons of contact (of class Partnership, see below).
Defined in
patientHealthCareParties
• patientHealthCareParties: PatientHealthCareParty
[]
Links (usually for therapeutic reasons) between this patient and healthcare parties (of class PatientHealthcareParty).
Defined in
patientProfessions
• patientProfessions: CodingReference
[]
Codified list of professions exercised by this patient.
Defined in
personalStatus
• Optional
personalStatus: PatientPersonalStatusEnum
any of single
, in_couple
, married
, separated
, divorced
, divorcing
, widowed
, widower
, complicated
, unknown
, contract
, other
.
Defined in
picture
• Optional
picture: ArrayBuffer
A picture usually saved in JPEG format.
Defined in
placeOfBirth
• Optional
placeOfBirth: string
The place of birth.
Defined in
placeOfDeath
• Optional
placeOfDeath: string
The place of death.
Defined in
profession
• Optional
profession: string
The current professional activity.
Defined in
properties
• properties: Set
<Property
>
Extra properties
Defined in
race
• Optional
race: string
The race of the patient.
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
Defined in
rev
• Optional
rev: string
the revision of the patient in the database, used for conflict management / optimistic locking.
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.
Defined in
ssin
• Optional
ssin: string
Social security inscription number.
Defined in
systemMetaData
• Optional
systemMetaData: SystemMetaDataOwnerEncrypted