Miscellaneous
Retrieve patient demographics from an external system
When using Awell Care to operate your care flows, you want to make it a breeze for your care team to create patients in Awell. The Patient Demographic Query (PDQ) integration allows your care team to retrieve patient demographic data from your system right within Awell.
The integration is based on the IHE ITI PDQm Profile although the full specification has not been implemented yet (see below).
There are two actors in this integration:
The Patient Demographics Supplier may act as a proxy to an existing information system. This way, the Patient Demographics Consumer can choose a technology stack and a query/response profile that best fits.
At Awell, we use MirthConnect as an integration engine that can connect Awell to any other health information system. This allows us to exchange clinical and administrative data in a format of your choice (HL7, FHIR, XML, JSON...).
This integration is triggered when a member of your care team presses the "Import patient" button in Awell Care when creating a patient in Awell. Instead of filling out patient demograhpics like name, email address and date of birth manually, a user can import patient demograhpics based on an identifier they entered according to the code system and code configured in the integration settings.
A request will be made by Awell to solicit information about patients whose demographics data match data provided in the query parameters on the request message. The request can be made either using a GET
or a POST
request. Which HTTP verb or method that will be used is defined in the integration settings in the Awell app.
The request represents a parameterized search from Awell to the Patient Demographics Supplier. We currently only support searching on the identifier
parameter. The coding system and code that will be used for the search is configured in the integrations settings in the Awell app.
01
01
In Belgium the Social Beneficiary Identifier is also known as the INSZ number (Identificatienummer voor de Sociale Zekerheid in Dutch, or Numéro d'identification de sécurité sociale in French). It is also referred to as the "rijksregisternummer". It is a unique identifier assigned to every citizen and resident in Belgium.
When the request is received by the Patient Demographics Supplier, it processes the request and returns a response in the form of demographics information for the matching patient(s). The request can yield 0, 1, or N matching patient records, therefore we expect that the response is an array of patient records. Additionally, the response format needs to be JSON ('Content-Type': 'application/json'
).
01
We currently expect the response format and the patient record to be in a format defined by Awell. Please reach out to us if you'd like to return a native FHIR response instead.
Each patient record can have the following fields (all optional):
Field | Type | Description |
---|---|---|
patient_code | string | A value that can uniquely identify the patient in your system. It can be the identifier used for the search. |
first_name | string | First name of the patient |
last_name | string | Last name of the patient |
birth_date | string | Birth date as a ISO8601 string |
string | The email address of the patient | |
phone | string | Landline number of the patient as an E.164 string |
mobile_phone | string | Mobile number of the patient as an E.164 string |
national_registry_number | string | National registry number of the patient (social security number in Belgium) |
sex | number | 0 (not known) | 1 (male) | 2 (female) |
address.street | string | Street address of the patient |
address.city | string | City where the patient lives |
address.zip | string | ZIP code of the patient |
address.state | string | State where the patient lives |
address.country | string | Country wher the patient lives |
The request succeeded. This is applicable in the following cases:
total
with a value of 0 indicating no results were found. No entry attributes are provided in the result.Used when the request contains bad syntax or cannot be fulfilled.
The server failed to fulfil an apparently valid request.
The PDQ integration can be enabled and configured in the Awell app. Click here to learn more about setting up the integration in Awell.
Awell processes the response and will show feedback to the user in Awell Care: