The patient document object represents a medical document associated to a patient.
| Name | Type | Description |
|---|---|---|
| id | UUID | The unique identifier of the document. |
| patient | Patient(id: UUID, username: string?, first_name: string?, last_name: string?, date_of_birth: Date?, locale: "fr" | "en" | "pt", email: string?, phone: string?, address: Address(street_address: string, zip_code: string, city: string, state: string?, country: string?)?, sex: "MALE" | "FEMALE" | "OTHER"?, updated_at: DateTime, created_at: DateTime, external_id: string?, healthcare_system_identifier: string?, summary: string?, metadata: JSON?, custom_fields: JSON?, integrations: Integrations(apero_id: string?)?, tags: string[]) | The patient associated to the document. |
| title | string? | The title of the document. |
| description | string? | A brief summary describing the document. |
| file | File(id: UUID, ephemeral_url: EphemeralUrl(url: string, expires_at: DateTime), mime_type: string, thumbnail_url: undefined?, uploader: undefined?, uploaded_at: DateTime)? | |
| related_appointment | UUID? | The unique identifier of the most recent related document. |
Example
{
"id": "98FCE1EF-DBCA-41EF-8BC7-4D1621AC07C6",
"patient": {
"id": "98FCE1EF-DBCA-41EF-8BC7-4D1621AC07C6",
"username": "johndoe",
"first_name": "John",
"last_name": "Doe",
"date_of_birth": "1972-06-23T00:00:00.000Z",
"locale": "fr",
"email": "[email protected]",
"phone": "+33612356789",
"address": {
"street_address": "6838 Hollywood Blvd",
"zip_code": "90028",
"city": "Los Angeles",
"state": "California",
"country": "United States of America"
},
"sex": "MALE",
"updated_at": "2022-03-10T19:16:23.456Z",
"created_at": "2022-03-10T19:16:23.456Z",
"external_id": "example_string",
"healthcare_system_identifier": "example_string",
"summary": "example_string",
"metadata": {
"example_key": "example_string"
},
"custom_fields": {
"blood_type": "A+"
},
"integrations": {
"apero_id": "123"
},
"tags": [
"example_string"
]
},
"title": "example_string",
"description": "example_string",
"file": {
"id": "98FCE1EF-DBCA-41EF-8BC7-4D1621AC07C6",
"ephemeral_url": {
"url": "https://example.com",
"expires_at": "2022-06-24T14:36:22"
},
"mime_type": "image/png",
"thumbnail_url": {
"url": "https://example.com",
"expires_at": "2022-06-24T14:36:22"
},
"uploader": {
"id": "98FCE1EF-DBCA-41EF-8BC7-4D1621AC07C6",
"gender": "FEMALE",
"first_name": "Jane",
"last_name": "Doe",
"phone": "+33612356789",
"email": "example_string",
"prefix": "Pr",
"title": "Professor",
"timezone": "Europe/Paris",
"roles": [
"ADMINISTRATOR"
],
"biography": "Dr John Doe, MD is a graduate of George Washington University School of Medicine.",
"metadata": {
"example_key": "example_string"
},
"ephemeral_avatar_url": {
"url": "https://example.com",
"expires_at": "2022-06-24T14:36:22"
},
"self_login_enabled": true
},
"uploaded_at": "2022-03-10T19:16:23.456Z"
},
"related_appointment": "98FCE1EF-DBCA-41EF-8BC7-4D1621AC07C6"
}