Skip to main content

Organization

Overview​

The Organization resource represents formally or informally recognized groupings of people or organizations formed for collective action. This includes healthcare facilities, insurance companies, departments, practice groups, and other healthcare-related organizations.

Important: Always validate Organization resource support and available operations by retrieving the current CapabilityStatement from /metadata before implementing integrations.

Resource Schema​

The Organization resource follows the HL7 FHIR R4 Organization specification.

Key elements include:

  • identifier - Identifies this organization across multiple systems
  • active - Whether the organization's record is still in active use
  • type - Kind of organization (provider, payer, government, etc.)
  • name - Name used for the organization
  • alias - Alternative names the organization is known as
  • telecom - Contact details for the organization
  • address - Address(es) for the organization
  • partOf - The organization of which this organization forms a part
  • contact - Contact for the organization for a certain purpose
  • endpoint - Technical endpoints providing access to services

Example Organization Resource​

{
  "resourceType": "Organization",
  "id": "12345",
  "identifier": [{
    "use": "official",
    "type": {
      "coding": [{
        "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
        "code": "NPI",
        "display": "National Provider Identifier"
      }]
    },
    "system": "http://hl7.org/fhir/sid/us-npi",
    "value": "1234567890"
  }],
  "active": true,
  "type": [{
    "coding": [{
      "system": "http://terminology.hl7.org/CodeSystem/organization-type",
      "code": "prov",
      "display": "Healthcare Provider"
    }]
  }],
  "name": "Sunrise Health Medical Center",
  "alias": ["Sunrise Medical", "SHMC"],
  "telecom": [{
    "system": "phone",
    "value": "+1-555-123-4567",
    "use": "work"
  }, {
    "system": "email",
    "value": "info@sunrisehealth.org",
    "use": "work"
  }],
  "address": [{
    "use": "work",
    "type": "both",
    "line": ["123 Healthcare Drive"],
    "city": "Medical City",
    "state": "CA",
    "postalCode": "12345",
    "country": "US"
  }]
}

Supported Profiles​

This API supports the following FHIR profiles:

Operations​

The Certified API Organization resource supports the following standard operations. However, support varies by the targeted CareRecord or solution.

CareRecord / SolutionCreateReadUpdateSearch
GEHRIMED-Yes-Yes
myAvatar-Yes-Yes
myEvolv-Yes-Yes
myUnity-Yes-Yes
info

Not all Netsmart solutions support Organization search. See supported operations table above and consult your target solution's documentation for more information.

This operation retrieves a list of resources by these query parameters.

Standard Parameters​

NameTypeDescription
addressstringA server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode and/or text
address-citystringA city specified in an address
address-postalcodestringA postal code specified in an address
address-statestringA state specified in an address
identifiertokenAny identifier for the organization (not the accreditation issuer's identifier)
namestringA portion of the organization's name or alias
typetokenA code for the type of organization

Search Examples​

Via POST​

The POST method is recommended as it keeps health information out of the URL.

Search by Name
curl -X POST https://fhir.netsmartcloud.com/v4/Organization/_search \
    -H "Authorization: {Bearer Token}" \
    -H "Accept: application/fhir+json" \
    -H "Content-Type: application/x-form-urlencoded" \
    -d "name=sunrise health"

Via GET​

Search by Name
curl -X GET https://fhir.netsmartcloud.com/v4/Organization?name=sunrise%20health \
    -H "Authorization: {Bearer Token}" \
    -H "Accept: application/fhir+json"

Error Handling​

For information about error responses when working with Organization resources, see Common Errors.

Common Organization-related errors include:

  • Invalid organization identifiers or NPI numbers
  • Unsupported organization types
  • Malformed address or contact information
  • Invalid references to parent organizations

Integration Patterns​

Provider Directory​

Search for healthcare organizations:

# Find organizations by name
curl -X GET "https://fhir.netsmartcloud.com/v4/Organization?name=sunrise" \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/fhir+json"

Find organizations by location:

# Search by city and state
curl -X GET "https://fhir.netsmartcloud.com/v4/Organization?address-city=Medical City&address-state=CA" \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/fhir+json"

Insurance Networks​

Identify payer organizations:

# Find insurance organizations
curl -X GET "https://fhir.netsmartcloud.com/v4/Organization?type=ins" \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/fhir+json"

Organizational Hierarchy​

Track organizational relationships:

# Get organization with parent organization
curl -X GET "https://fhir.netsmartcloud.com/v4/Organization/12345?_include=Organization:partof" \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/fhir+json"

Relationships to Other Resources​

The Organization resource connects to many other resources in healthcare workflows:

  • Practitioner - Healthcare providers employed by organizations
  • PractitionerRole - Roles practitioners have within organizations
  • Location - Physical locations managed by organizations
  • Patient - Patients receiving care from organizations
  • Encounter - Clinical encounters at organizations
  • Coverage - Insurance coverage provided by payer organizations
  • Device - Medical devices manufactured by organizations

Support​

For questions about Organization resource implementation or provider directory integration, contact Netsmart support through your designated support channels.