Access Professional Directory v2
The FHIR Directory API gives you access to our entire directory of professionals (doctors, pharmacists, midwives, ...) or care structures (e.g., the emergency department of Strasbourg Hospital, EHPAD, ...).
The resource Practitioner
corresponds to the Healthcare Professionals.
The resource Organization
corresponds to the care structures.
Access Control
You have to use the Access Token of an authenticated user with the PRACTITIONER_READ
and/or ORGANIZATION_READ
permissions in the scope
to access the FHIR Patient API. For user authentication, take a look at the Connect Users Guide.
Practitioner Search
A Practitioner
has several key fields:
name
: the name of the doctor, minimum 2 characters needed for this search. This search is based on the beginning of the word.identifier
: the physician's identifiers, including his or her RPPS, search on exact value only.qualification
: the qualifications obtained by training and certification, search on exact value only.address
: physicians' work addresses. This search is done word by word based on the beginning of the word.telecom
: contains the secure health messaging telecoms (MSS, Apycript) through which the doctor can be reached. Attention, you will have to go
through the clinical exchange API to exchange with professionals via these channels, they require specific mail configurations. This search is on
exact value only.
Examples of search on Practitioner :
- Search by RPPS :
GET /Practitioner?identifier=http://lifen.fr/fhir/Identifier/practitioner-rpps|10000383181
(optional system, only value required) - Search by National Identifier :
GET /Practitioner?identifier=urn:oid:1.2.250.1.71.4.2.1|810000383181
(optional system, only value required) - Search by email :
GET /Practitioner?telecom=charlotte.fernet.aphp@medical75.apicrypt.org
- Search by address :
GET /Practitioner?address=100 BOULEVARD DU GENERAL LECLERC
To learn more about the definitions of the other fields, you can look at the definition of the fields here : FHIR Practitioner DSTU3
Care structure
An Organization
has several key fields too :
name
: the name of the care structure, minimum 2 characters needed for this search. This search is based on the beginning of the word.identifier
: Identifies this organization across multiple systems, search on exact value only.address
: organization place. This search is done word by word based on the beginning of the word.part-of
: The organization of which this organization forms a part. This search is based on the exact FHIR reference of the structure (ex:
Organization/234234
)
To learn more about the definitions of the other fields, you can look at the definition of the fields here : FHIR Organization DSTU3
Updated about 2 years ago