Organization REST Endpoints

Sort by

Task Path Method

Description

Organization

This topic describes information for the Organization resource.

Overview

Note:

The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

The Organization resource describes a grouping of people or business entities relevant to the healthcare process. Organizations include hospitals, employers, insurance companies, physicians' offices, rehabilitation facilities, laboratories, and so on.

Profile Support

This resource supports the US Core Organization Profile from the HL7 FHIR US Core Implementation Guide STU 6.1.0.

Note:

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

Returned Fields

Element	Type
Organization	DomainResource
Organization.identifier	Identifier
Organization.identifier.system	uri
Organization.identifier.value	string
Organization.active	boolean
Organization.name	string
Organization.telecom	ContactPoint
Organization.address	Address

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}