Get Contact by ID

GET {{url}}/{{tenantName}}/{{instanceName}}/patients/{{patientId}}/contacts/{{contactId}}

Description

This endpoint retrieves a specific contact associated with a particular patient. By making a GET request to this endpoint, you can retrieve detailed information about a specific contact based on the provided patient ID and contact ID.

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 associated with the contact.
• {{contactId}}: The unique identifier of the contact you wish to retrieve.

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 the detailed information of the requested contact associated with the provided patient ID and contact ID.

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