Organization REST Endpoints

Sort by

Task Path Method

Description

Organization

This topic describes information for the Organization resource.

Overview

The Organization resource describes a healthcare entity.

Soarian Clinicals supports a read-only Application Programming Interface (API). This API accepts GET and POST based search and GET based read interactions. The response represents the most current information about the patient that is charted in Soarian Clinicals at the time of the query.

Note:

The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.

Error: The common errors and OperationOutcomes may be returned.

The search results include the following fields if they contain values:

• Organization Id
• Identifier
• Active
• Type
• Name
• Contact
• Address

Terminology Bindings

• Organization.type

  Description: Indicates the type of Organization.

  Details: OrganizationType

  System: https://terminology.hl7.org/3.1.0/CodeSystem-organization-type.html

Organization

The operations from the Organization category.

Get a list of organizations

Method: get

Path: /Organization

Get an organization by ID

Method: get

Path: /Organization/{ID}