Skip to main content

Service Base URLs

Overview​

Netsmart CareConnect provides Service Base URLs for discovering FHIR API endpoints across multiple Netsmart solutions including GEHRIMED, myAvatar, myEvolv, myUnity, and TheraOffice. This endpoint returns a standardized bundle containing organization branding information and FHIR service endpoints.

Supported Profile​

The Service Base URLs 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 - Healthcare organizations with branding and contact information
  • Endpoint Resources - 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-org-123",
      "resource": {
        "resourceType": "Organization",
        "id": "example-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 Healthcare Organization",
        "telecom": [
          {
            "system": "url",
            "value": "https://www.example-healthcare.org/"
          }
        ],
        "endpoint": [
          {
            "reference": "Endpoint/example-endpoint-456"
          }
        ]
      }
    },
    {
      "fullUrl": "urn:uuid:example-endpoint-456",
      "resource": {
        "resourceType": "Endpoint",
        "id": "example-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-healthcare.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-id"
      }
    }
  ]
}

Operations​

Read Service Base URLs​

GET /brand/brands.json

Retrieves the complete Service Base URLs bundle.

Supported Formats​

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

Examples​

curl -X GET "https://fhir.netsmartcloud.com/brand/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​

Service Discovery Workflow​

  1. Retrieve Service Base URLs - Call the brands endpoint
  2. Extract Endpoints - Parse Endpoint resources from bundle
  3. Configure Client - Use endpoint addresses for FHIR API calls
  4. Cache Results - Store bundle locally to reduce API calls

Service Base URLs connect to:

  • CapabilityStatement - Available at each endpoint's /metadata
  • FHIR Resources - Accessible via discovered service base URLs
  • Authentication - OAuth endpoints may be referenced in CapabilityStatement

Supported Profiles​