Organization

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.

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

Terminology Bindings

Organization.type
  • Description
    • Indicates the type of Organization.
  • Details: OrganizationType
    System: https://terminology.hl7.org/3.1.0/CodeSystem-organization-type.html

Search for Organization resources that meet the specified query parameters:

GET /Organization?:parameters

Authorization Types

Parameters

Name Required? Type Description
_id This, name, or address token The logical resource ID associated with the resource.
name This, _id, or address string The start of the organization’s name.
address This, id, or, name string The start of either the address line, city, state, postal code, or country of the organization.

Headers

Accept: application/fhir+json
Authorization: <OAuth2 Bearer Token>

Example Search by ID

Request

GET https://fhir-myrecord-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/Organization?_id=HCU.1

Response

Status: 200 OK
{
  "resourceType": "Bundle",
  "id": "de340a64-b768-4d2a-ac8b-dc6496188539",
  "type": "searchset",
  "timestamp": "2021-03-26T19:02:37-04:00",
  "entry": [
    {
      "fullUrl": "https://fhir-myrecord-sc.sandboxcerner.com/r4/3f2aca24-87f3-4eac-a6d7-1f75247e6b43/Organization/HCU.1",
      "resource": {
        "resourceType": "Organization",
        "id": "HCU.1",
        "meta": {
          "lastUpdated": "2021-08-09T15:28:54-04:00"
        },
        "name": "Health Enterprise",
        "active": true,
        "type": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/organization-type",
                "code": "prov",
                "display": "Healthcare Provider"
              }
            ]
          }
        ],
        "identifier": [
          {
            "system": "http://hl7.org/fhir/sid/us-npi",
            "value": "4510000001"
          }
        ],
        "address": [
          {
            "use": "work",
            "text": "53 Valley Stream Parkway,Malvern,PA,19355,United States",
            "line": [
              "53 Valley Stream Parkway"
            ],
            "city": "Malvern",
            "state": "PA",
            "postalCode": "19355",
            "country": "United States",
            "period": {
              "start": "2020-12-04T09:36:34-05:00"
            }
          },
          {
            "use": "work",
            "text": "105 N 9th St,Philadelphia,PA,19100,United States",
            "line": [
              "105 N 9th St"
            ],
            "city": "Philadelphia",
            "state": "PA",
            "postalCode": "19100",
            "country": "United States",
            "period": {
              "start": "2014-04-10T15:20:38-04:00"
            }
          },
          {
            "use": "work",
            "text": "208 Louisiana Ave,Philadelphia,PA,19101,United States",
            "line": [
              "208 Louisiana Ave"
            ],
            "city": "Philadelphia",
            "state": "PA",
            "postalCode": "19101",
            "country": "United States",
            "period": {
              "start": "2014-04-10T15:21:06-04:00"
            }
          },
          {
            "use": "work",
            "text": "51 Valley Stream Parkway,Philadelphia,PA,19101,United States",
            "line": [
              "51 Valley Stream Parkway"
            ],
            "city": "Philadelphia",
            "state": "PA",
            "postalCode": "19101",
            "country": "United States",
            "period": {
              "start": "2014-04-10T15:21:50-04:00"
            }
          },
          {
            "use": "work",
            "text": "PRM Address Street,Philadelphia,PA,19104,United States",
            "line": [
              "PRM Address Street"
            ],
            "city": "Philadelphia",
            "state": "PA",
            "postalCode": "19104",
            "country": "United States",
            "period": {
              "start": "2014-04-10T15:22:16-04:00"
            }
          },
          {
            "use": "old",
            "text": "15 Wells Ln,Louisville,KY,40201,United States",
            "line": [
              "15 Wells Ln"
            ],
            "city": "Louisville",
            "state": "KY",
            "postalCode": "40201",
            "country": "United States",
            "period": {
              "start": "2021-01-08T09:58:45-05:00"
            }
          }
        ],
        "telecom": [
          {
            "system": "phone",
            "value": "+16102196300x9082",
            "use": "work",
            "period": {
              "start": "2020-12-04T09:36:34-05:00"
            }
          },
          {
            "system": "phone",
            "value": "6102196300",
            "use": "work",
            "period": {
              "start": "2014-04-10T15:20:38-04:00"
            }
          },
          {
            "system": "phone",
            "value": "6102196300",
            "use": "work",
            "period": {
              "start": "2014-04-10T15:21:06-04:00"
            }
          },
          {
            "system": "phone",
            "value": "610-219-6300",
            "use": "work",
            "period": {
              "start": "2014-04-10T15:21:50-04:00"
            }
          },
          {
            "system": "phone",
            "value": "610-219-6300",
            "use": "work",
            "period": {
              "start": "2014-04-10T15:22:16-04:00"
            }
          },
          {
            "system": "phone",
            "value": "212-555-9133",
            "use": "old",
            "period": {
              "start": "2021-01-08T09:58:45-05:00"
            }
          }
        ],
        "text": {
          "status": "generated",
          "div": "<div xmlns='http://www.w3.org/1999/xhtml'><b>Organization</b><br /><b>Name</b>:Health Enterprise;<br /><b>Status</b>:Active;<br /><b>Identifier</b>:<br /><b>System</b>:http://hl7.org/fhir/sid/us-npi <b>Value</b>:4510000001 ;<br /><b>Telecom</b>:<br /><b>System</b>:phone <b>Value</b>:+16102196300x9082 ;<br /><b>System</b>:phone <b>Value</b>:6102196300 ;<br /><b>System</b>:phone <b>Value</b>:6102196300 ;<br /><b>System</b>:phone <b>Value</b>:610-219-6300 ;<br /><b>System</b>:phone <b>Value</b>:610-219-6300 ;<br /><b>System</b>:phone <b>Value</b>:212-555-9133 ;<br /><b>Address</b>:<br />53 Valley Stream Parkway,Malvern,PA,19355,United States;<br />105 N 9th St,Philadelphia,PA,19100,United States;<br />208 Louisiana Ave,Philadelphia,PA,19101,United States;<br />51 Valley Stream Parkway,Philadelphia,PA,19101,United States;<br />PRM Address Street,Philadelphia,PA,19104,United States;<br />15 Wells Ln,Louisville,KY,40201,United States;<br /><b>Type</b>:Healthcare Provider;<br /></div>"
        }
      }
    }
  ],
  "link": [
    {
      "relation": "self",
      "url": "https://fhir-myrecord-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/Organization?_id=HCU.1&_format=json"
    }
  ]
}

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.

Errors

The common errors and OperationOutcomes may be returned.

Retrieve by ID

List an individual Organization resource by its id:

GET /Organization/:id

Authorization Types

Headers

Accept: application/fhir+json
Authorization: <OAuth2 Bearer Token>

Example

Request

GET https://fhir-myrecord-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/Organization/HCU.1

Response

Status: 200 OK
{
  "resourceType": "Organization",
  "id": "HCU.1",
  "meta": {
    "lastUpdated": "2021-08-09T15:28:54-04:00"
  },
  "name": "Health Enterprise",
  "active": true,
  "type": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/organization-type",
          "code": "prov",
          "display": "Healthcare Provider"
        }
      ]
    }
  ],
  "identifier": [
    {
      "system": "http://hl7.org/fhir/sid/us-npi",
      "value": "4510000001"
    }
  ],
  "address": [
    {
      "use": "work",
      "text": "53 Valley Stream Parkway,Malvern,PA,19355,United States",
      "line": [
        "53 Valley Stream Parkway"
      ],
      "city": "Malvern",
      "state": "PA",
      "postalCode": "19355",
      "country": "United States",
      "period": {
        "start": "2020-12-04T09:36:34-05:00"
      }
    },
    {
      "use": "work",
      "text": "105 N 9th St,Philadelphia,PA,19100,United States",
      "line": [
        "105 N 9th St"
      ],
      "city": "Philadelphia",
      "state": "PA",
      "postalCode": "19100",
      "country": "United States",
      "period": {
        "start": "2014-04-10T15:20:38-04:00"
      }
    },
    {
      "use": "work",
      "text": "208 Louisiana Ave,Philadelphia,PA,19101,United States",
      "line": [
        "208 Louisiana Ave"
      ],
      "city": "Philadelphia",
      "state": "PA",
      "postalCode": "19101",
      "country": "United States",
      "period": {
        "start": "2014-04-10T15:21:06-04:00"
      }
    },
    {
      "use": "work",
      "text": "51 Valley Stream Parkway,Philadelphia,PA,19101,United States",
      "line": [
        "51 Valley Stream Parkway"
      ],
      "city": "Philadelphia",
      "state": "PA",
      "postalCode": "19101",
      "country": "United States",
      "period": {
        "start": "2014-04-10T15:21:50-04:00"
      }
    },
    {
      "use": "work",
      "text": "PRM Address Street,Philadelphia,PA,19104,United States",
      "line": [
        "PRM Address Street"
      ],
      "city": "Philadelphia",
      "state": "PA",
      "postalCode": "19104",
      "country": "United States",
      "period": {
        "start": "2014-04-10T15:22:16-04:00"
      }
    },
    {
      "use": "old",
      "text": "15 Wells Ln,Louisville,KY,40201,United States",
      "line": [
        "15 Wells Ln"
      ],
      "city": "Louisville",
      "state": "KY",
      "postalCode": "40201",
      "country": "United States",
      "period": {
        "start": "2021-01-08T09:58:45-05:00"
      }
    }
  ],
  "telecom": [
    {
      "system": "phone",
      "value": "+16102196300x9082",
      "use": "work",
      "period": {
        "start": "2020-12-04T09:36:34-05:00"
      }
    },
    {
      "system": "phone",
      "value": "6102196300",
      "use": "work",
      "period": {
        "start": "2014-04-10T15:20:38-04:00"
      }
    },
    {
      "system": "phone",
      "value": "6102196300",
      "use": "work",
      "period": {
        "start": "2014-04-10T15:21:06-04:00"
      }
    },
    {
      "system": "phone",
      "value": "610-219-6300",
      "use": "work",
      "period": {
        "start": "2014-04-10T15:21:50-04:00"
      }
    },
    {
      "system": "phone",
      "value": "610-219-6300",
      "use": "work",
      "period": {
        "start": "2014-04-10T15:22:16-04:00"
      }
    },
    {
      "system": "phone",
      "value": "212-555-9133",
      "use": "old",
      "period": {
        "start": "2021-01-08T09:58:45-05:00"
      }
    }
  ],
  "text": {
    "status": "generated",
    "div": "<div xmlns="http://www.w3.org/1999/xhtml"><b>Organization</b><br /><b>Name</b>:Health Enterprise;<br /><b>Status</b>:Active;<br /><b>Identifier</b>:<br /><b>System</b>:http://hl7.org/fhir/sid/us-npi <b>Value</b>:4510000001 ;<br /><b>Telecom</b>:<br /><b>System</b>:phone <b>Value</b>:+16102196300x9082 ;<br /><b>System</b>:phone <b>Value</b>:6102196300 ;<br /><b>System</b>:phone <b>Value</b>:6102196300 ;<br /><b>System</b>:phone <b>Value</b>:610-219-6300 ;<br /><b>System</b>:phone <b>Value</b>:610-219-6300 ;<br /><b>System</b>:phone <b>Value</b>:212-555-9133 ;<br /><b>Address</b>:<br />53 Valley Stream Parkway,Malvern,PA,19355,United States;<br />105 N 9th St,Philadelphia,PA,19100,United States;<br />208 Louisiana Ave,Philadelphia,PA,19101,United States;<br />51 Valley Stream Parkway,Philadelphia,PA,19101,United States;<br />PRM Address Street,Philadelphia,PA,19104,United States;<br />15 Wells Ln,Louisville,KY,40201,United States;<br /><b>Type</b>:Healthcare Provider;<br /></div>"
  }
}

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.