Organization

A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.

Response Description

Sample Response

{

"resourceType": "Organization",

"id": "DEV--QUEST",

"meta": {

       "lastUpdated": "2022-11-22T12:00:00-05:00",

 "profile": [

 "http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization"

     ]

    },

"text": {

       "status": "generated",

 "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><span>Quest</span><table><tbody><tr><td>Name:</td><td>Quest</td></tr><tr><td>Phone #:</td><td></td></tr><tr><td>Email:</td><td>solomon.staggs@gmail.com</td></tr><tr><td>Address:</td><td>2070 TEST PARK<br/>LOS ANGELES, CA  90067</td></tr></tbody></table></div>"

   },

"identifier": [

       {

 "system": "http://hl7.org/fhir/sid/us-npi",

 "value": "28950238590"

    }

   ],

"active": true,

"name": "Quest",

"telecom": [

 {

     "system": "email",

 "value": "solomon.staggs@gmail.com"

    }

   ],

"address": [

       {

 "line": [

   "2070 TEST PARK"

     ],

 "city": "LOS ANGELES",

       "state": "CA",

     "postalCode": "90067",

     "country": "US",

     "period": {

     "start": "2022-09-21",

     "end": "2022-09-21"

    }

  }

]

}

Organization.id

The logical ID of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Organization.meta

Metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Organization.text

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative.

Organization.identifier

Identifier for the organization that is used to identify the organization across multiple disparate systems.

Organization.identifier.system

The namespace for the identifier value.

Organization.identifier.value

The value that is unique.

Organization.identifier:NPI

Identifier for the organization that is used to identify the organization by NPI.

Organization.active

Whether the organization's record is still in active use.

Organization.name

A name associated with the organization.

Organization.telecom

A contact detail for the organization.

Organization.address

An address for the organization.

Organization.address.line

Street name, number, direction & P.O. Box etc.

Organization.address.city

Name of city, town etc.

Organization.address.state

Sub-unit of country (abbreviations ok).

Organization.address.postalCode

US Zip Codes.

Organization.address.country

Country (e.g. can be ISO 3166 2 or 3 letter code)

Search

URL Syntax

Two HTTP methods are supported for searching: GET and POST. It is recommended to use HTTP POST.

Visit the FHIR Sandbox to try requests.

HTTP GET - searching

https://sandbox.pai.healthcare/preview/fhir/Organization?{query string}

HTTP GET - return single record

https://sandbox.pai.healthcare/preview/fhir/Organization/{resource id}

HTTP POST - searching

https://sandbox.pai.healthcare/preview/fhir/Organization/_search

•Set the Content-Type header to application/x-www-urlencoded

•The body of the request is a similar query string used in the GET type of request detailed above.

Error Handling

If no records are returned or invalid search parameters are provided, then an HTTP 400 Bad Request is returned.

The body of the response will be an OperationOutcome.

Supported Search Parameters

_id

name

address