PatientImage API

Overview

The CareConnect PatientImage API enables applications to retrieve patient photos from the CareRecord. This API provides access to patient images stored within Netsmart's healthcare systems.

Use Cases:

• Retrieving patient photos for identification purposes
• Displaying patient images in healthcare applications
• Supporting patient verification workflows

Relationships:

• References Patient resources by ID
• Provides binary image data for patient identification

Supported CareRecords:

• GEHRIMED
• Homecare
• myAvatar
• myEvolv
• myUnity
• TIER

Resource Schema

The PatientImage API returns binary image data (typically JPEG or PNG format) for the specified patient.

Response Format:

• Content-Type: image/jpeg or image/png
• Binary image data
• HTTP status codes for success/error conditions

Operations

Read

Retrieve a patient image by patient ID.

Parameters

Name	Type	Description
id	string	REQUIRED The ID of the patient. This is a path parameter in the PatientImage HTTP request.

Examples

Authentication Request

Production

curl -X POST https://oauth.netsmartcloud.com/token \
  -H "Accept: application/json" \
  -H "Content-Type: application/x-form-urlencoded" \
  -d grant_type=client_credentials \
  -d client_id={client-id} \
  -d client_secret={client-secret} \
  -d scope=CCD

Preview

curl -X POST https://oauthtest.netsmartcloud.com/token \
  -H "Accept: application/json" \
  -H "Content-Type: application/x-form-urlencoded" \
  -d grant_type=client_credentials \
  -d client_id={client-id} \
  -d client_secret={client-secret} \
  -d scope=CCD

Patient Image Request

Production

curl -X GET 'https://fhir.netsmartcloud.com/v4/PatientImage/patient-12345' \
    -H "Authorization: Bearer {access-token}" \
    -H "Accept: */*"

Preview

curl -X GET 'https://fhirtest.netsmartcloud.com/v4/PatientImage/patient-12345' \
    -H "Authorization: Bearer {access-token}" \
    -H "Accept: */*"

Response Example

Successful Response:

• HTTP Status: 200 OK
• Content-Type: image/jpeg (or image/png)
• Body: Binary image data

Error Response:

• HTTP Status: 404 Not Found (if patient or image not found)
• HTTP Status: 401 Unauthorized (if authentication fails)

Integration Patterns

Common Workflows

1. Patient Identification: Retrieve patient photo for visual verification during check-in
2. Healthcare Application Display: Show patient images in EMR systems or mobile apps
3. Identity Verification: Use patient photos for security and identification purposes

Related Resources

• Patient: The patient whose image is being retrieved
• Authentication: Requires valid OAuth 2.0 token with CCD scope

Error Handling

Common Error Scenarios:

HTTP Status	Error Condition	Description
401	Unauthorized	Invalid or expired access token
403	Forbidden	Insufficient permissions for patient access
404	Not Found	Patient ID not found or no image available
500	Internal Server Error	Server-side processing error

Troubleshooting:

• Verify patient ID exists in the system
• Ensure OAuth token has CCD scope
• Check that patient has an associated image
• Contact Netsmart support for persistent issues

API Specifications

Authentication: OAuth 2.0 Client Credentials flow Scope Required: CCD Response Format: Binary image data (JPEG/PNG) Rate Limiting: Standard API rate limits apply