Get All Contacts

GET {{url}}/{{tenantName}}/{{instanceName}}/patients/{{patientId}}/contacts/?pdtRecordId=a76221fe-74ef-4915-8d24-31832144a457&active=false

Description

This endpoint retrieves the contacts associated with a specific patient. By making a GET request to this endpoint, you can retrieve a list of contacts related to the provided patient ID. Contacts may include information such as emergency contacts, primary care providers, or any other relevant individuals associated with the patient.

Parameters

The endpoint requires the following parameters:

• {{url}}: The base URL of the API.
• {{tenantName}}: The name of the tenant or organization.
• {{instanceName}}: The name of the specific instance within the tenant.
• {{patientId}}: The unique identifier of the patient for whom you want to retrieve the contacts.

Request Headers

The following headers must be included in the request:

• Authorization: A token or credentials to authenticate the request.
• Content-Type: The format of the request payload, typically set to application/json.

Response

The response to a successful request will include a list of contacts associated with the provided patient ID. Each contact may contain various fields, such as name, phone number, email, relationship, and additional details.

Error Handling

If an error occurs, the response will include an appropriate HTTP status code along with an error message or code to indicate the specific issue encountered. Common error codes include 400 for bad requests, 401 for unauthorized access, and 404 for not found.

Authorization

Proper authorization credentials must be provided in the request headers to access this endpoint. Consult the API documentation or contact the system administrator to obtain the necessary authorization details.

Request Params