A Doctor is a natural person who is licensed to practice medicine. All Doctors in this Resource have a validated identity and and have a currently valid medical license in Paraguay provided by the Ministry of Health (MSPBS).
Overview of Data Model for a Doctor. The Doctor Resource implements the FHIR Practitioner Resource.
| Key | Type | Required | Public | Readonly | Description | FHIR Resource |
|---|---|---|---|---|---|---|
| id | String | * | * | Identifier | ||
| photoUrl | String | * | Picture | Practitioner -> Photo | ||
| givenName | String | * | * | First Name | Practitioner -> Name (HumanName -> Family Name) | |
| familyName | String | * | * | Last Name | Practitioner -> Name (HumanName -> Given Name) | |
| languages | GET: {id: String, description: String} PUT: String [] |
* | * | Languages Acceptable Format: ISO 639-1 Download JSON file with spanish language names |
Practitioner -> Communication (CommonLanguage) | |
| biography | String | * | Biography | Practitioner -> Extension | ||
| birthDate | String | * | Date of Birth Acceptable Format: YYYY-MM-DD |
Practitioner -> Bithdate | ||
| gender | String | * | * | Gender Acceptable Values: - male - female - other - unknown |
Practitioner -> Gender | |
| String | * | Practitioner -> Telecom (ContactPoint) | ||||
| phone | String | Phone | Practitioner -> Telecom (ContactPoint) | |||
| street | String | * | Street Address and Number | Practitioner -> Address -> line0 | ||
| city | String | * | City | Practitioner -> Address -> city | ||
| neighborhood | String | * | Locality (Neighbourhood) | Practitioner -> Address -> line1 | ||
| addressDescription | String | * | Address Reference (Description) | Practitioner -> Address -> text | ||
| specializations | GET: {id: String, description: String} PUT: String [] |
* | * | Medical Specializations Acceptable Values: IDs obtained by Specialization Endpoint |
Practitioner -> Qualification (Code) | |
| license | String | * | * | * | Medical License ID (Registro Profesional) | Practitioner -> Qualification Identifier |
The Doctor Resource provides the following endpoints:
Search for Doctors and List Results.
GET /doctors
Access Level: Public
Parameters (Query String):
content:
Consider the following query string:
?content=Guarani,Spanish&content=ALERGIA E INMUNOLOGIA CLINICA&content=Maria
This will search for a doctor that:
speaks either Guarani OR Spanish AND
has a speciality "ALERGIA E INMUNOLOGIA CLINICA" AND
is called "Maria"
count: Number - Number of items to return - defaults to 20
offset: Number - Number of items that are skipped - defaults to 0
Return Value:
{
total: Number // total amount of matched doctors
items: List of Doctors (only public keys)
}
Read a Doctor's public details
GET /doctors/:id
Access Level: Public
Parameters: none
Return Value: Doctor (only public keys)
Read the currently authenticated Doctor
GET /profile/doctor
Access Level: Authorized
Parameters: none
Return Value: Doctor
Update the currently authenticated Doctor
PUT /profile/doctor
Access Level: Authorized
Parameters: Doctor
Return Value: Doctor (updated)