Skip to main content

User-Access Brands (Preview)

Overview​

Netsmart CareConnect provides tenant-specific User Access Brands for discovering FHIR API endpoints and organization branding information. Unlike the global Service Base URLs endpoint, User Access Brands requires a specific tenant ID and returns only the brands and endpoints associated with that tenant.

Each CareConnect tenant includes its own User Access Brands Bundle containing organization branding information and FHIR service endpoints. An organization may have multiple tenants in Netsmart CareConnect, so you may need to query multiple tenant-specific endpoints to retrieve complete brand information for an organization.

Supported Profile​

The User Access Brands API implements the User-access Brands and Endpoints specification from SMART App Launch v2.2.0.

Resource Schema​

Returns an HL7 FHIR R4 Bundle (type: collection) containing:

  • Organization Resources - Primary and secondary brand organizations with branding and contact information
  • Endpoint Resources - Tenant-specific FHIR API endpoints with connection details
  • fullUrl References - URN-based identifiers for bundle entries
  • Metadata - Bundle timestamps and resource update information

Example Response​

{
  "resourceType": "Bundle",
  "id": "brands.json",
  "meta": {
    "lastUpdated": "2025-01-15T15:00:53.636620392Z"
  },
  "type": "collection",
  "timestamp": "2025-01-15T15:00:53.636620392Z",
  "entry": [
    {
      "fullUrl": "urn:uuid:example-tenant-org-123",
      "resource": {
        "resourceType": "Organization",
        "id": "example-tenant-org-123",
        "meta": {
          "lastUpdated": "2024-12-23T22:49:32.277634175Z"
        },
        "identifier": [
          {
            "system": "urn:oid:2.16.840.1.113883.3.3569",
            "value": "2.16.840.1.113883.3.3569.example123"
          }
        ],
        "active": true,
        "name": "Example Tenant Healthcare Organization",
        "telecom": [
          {
            "system": "url",
            "value": "https://www.example-tenant.org/"
          }
        ],
        "endpoint": [
          {
            "reference": "Endpoint/example-tenant-endpoint-456"
          }
        ]
      }
    },
    {
      "fullUrl": "urn:uuid:example-tenant-endpoint-456",
      "resource": {
        "resourceType": "Endpoint",
        "id": "example-tenant-endpoint-456",
        "meta": {
          "lastUpdated": "2024-12-23T22:49:26.693903971Z"
        },
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/endpoint-fhir-version",
            "valueCode": "4.0.1"
          }
        ],
        "status": "active",
        "connectionType": {
          "system": "http://terminology.hl7.org/CodeSystem/endpoint-connection-type",
          "code": "hl7-fhir-rest"
        },
        "name": "Netsmart CareConnect Certified Provider Patient Access FHIR v2",
        "contact": [
          {
            "system": "url",
            "value": "https://www.example-tenant.org"
          }
        ],
        "payloadType": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/endpoint-payload-type",
                "code": "none"
              }
            ]
          }
        ],
        "address": "https://fhir.netsmartcloud.com/provider/patient-access/v2/example-tenant-123"
      }
    }
  ]
}

Operations​

Read User Access Brands​

GET /brand/{tenant-id}/brands.json

Retrieves the tenant-specific User Access Brands bundle.

Path Parameters​

ParameterTypeRequiredDescription
tenant-idstringYesThe CareConnect tenant identifier

Supported Formats​

FormatContent-TypeAccept Header
JSONapplication/fhir+jsonapplication/fhir+json
JSONapplication/jsonapplication/json

Examples​

curl -X GET "https://fhir.netsmartcloud.com/brand/example-tenant-123/brands.json" \
  -H "Accept: application/fhir+json"

Both requests return a 200 OK response with the Bundle structure shown in the Example Response above.

Integration Patterns​

Tenant-Specific Discovery Workflow​

  1. Obtain Tenant ID - Get the tenant identifier from your CareConnect configuration
  2. Retrieve User Access Brands - Call the tenant-specific brands endpoint
  3. Extract Endpoints - Parse Endpoint resources from the bundle
  4. Configure Client - Use endpoint addresses for tenant-specific FHIR API calls
  5. Cache Results - Store bundle locally to reduce API calls

Relationships to Other Resources​

User Access Brands connect to:

  • Service Base URLs - Global endpoint discovery at /brand/brands.json
  • CapabilityStatement - Available at each endpoint's /metadata
  • FHIR Resources - Accessible via discovered tenant-specific service base URLs
  • Authentication - OAuth endpoints may be referenced in CapabilityStatement

Error Handling​

For detailed error responses and troubleshooting guidance, contact Netsmart support.

Supported Profiles​