Organization API v1

Organizations represent sets of personnel that exist in the physical world outside of Oracle Health Data Intelligence. Examples of organizations include medical practices (for example, Northland Family Practice) and administrative organizations such as physician-hospital organizations (PHOs). Organizations also have real-world attributes similar to those of personnel, for example, addresses, phone numbers, and locations.

URL: https://cernerdemo.api.us-1.healtheintent.com/organization/v1

Location

A location represents a physical place with a single physical address, for example, a laboratory facility, practice site, hospital, or even a department within a hospital associated with an organization. Currently, personnel organizations and locations are not related in the API, but they will be in the future.

Retrieve a List of Locations


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/organization/v1/locations', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/organization/v1/locations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "9de4edac-64a7-4f3d-a8c2-408c2dfe055b",
      "name": "Demo Facility",
      "telecoms": [
        {
          "system": "PHONE",
          "value": "8675309"
        }
      ],
      "address": {
        "text": "8779 Hillcrest Rd, Bldg#1024, Kansas City, Missouri, 64086, United States of America",
        "lines": [
          "8779 Hillcrest Rd",
          "Bldg#1024"
        ],
        "city": "Kansas City",
        "state": "MO",
        "postalCode": "64138",
        "country": "United States of America"
      },
      "operationalStatus": "ACTIVE",
      "description": "CernerDemo primary demo facility.",
      "managingOrganization": {
        "id": "f89fa3dd-0000-494b-1111-4640ccc081e3"
      },
      "createdAt": "2018-09-18T19:07:33ZZ",
      "updatedAt": "2018-09-18T19:07:33Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.localhealtheintent.com/organization/v1/locations?limit=20&offset=0",
  "lastLink": "https://cernerdemo.api.us-1.localhealtheintent.com/organization/v1/locations?limit=20&offset=0"
}

GET /locations

Returns a list of locations matching the query.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
name	query	string	false	N/A	The name of the location. Filtering by a partial match is allowed.	-
locationId	query	array[string]	false	N/A	The IDs of the locations.	-
operationalStatus	query	string	false	N/A	The current operational status of the location.	ACTIVE, SUSPENDED, INACTIVE
managingOrganizationId	query	array[string]	false	N/A	The IDs of the managing organizations for the locations.	-
offset	query	integer(int32)	false	0	The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset.	-
limit	query	integer(int32)	false	20	The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100.	-
orderBy	query	string	false	name	A comma-separated list of fields by which to sort. The order in which the fields are listed determines the order in which sorting is applied. The directionality applied to each field is indicated by the presence (or absence) of a hyphen (-) prefix. Fields with the hyphen prefix are retrieved in descending order; fields without the prefix are retrieved in ascending order.	-name, name

Response Statuses

Status	Meaning	Description	Schema
200	OK	Collection of Location objects	Locations
400	Bad Request	Bad Request	Error

Create a Location




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/organization/v1/locations', headers: headers, body: {"name":"Demo Facility","operationalStatus":"ACTIVE","description":"CernerDemo primary demo facility.","managingOrganization":{"id":"f89fa3dd-0000-494b-1111-4640ccc081e3"},"telecoms":{"system":"EMAIL","value":"site@example.com"},"address":{"text":"2800 Rockcreek Pkwy, Suite 1, Kansas City, MO, USA, 64117","lines":["2800 Rockcreek Pkwy","Suite 1"],"city":"Kansas City","state":"MO","postalCode":"64117","country":"USA"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/organization/v1/locations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Demo Facility","operationalStatus":"ACTIVE","description":"CernerDemo primary demo facility.","managingOrganization":{"id":"f89fa3dd-0000-494b-1111-4640ccc081e3"},"telecoms":{"system":"EMAIL","value":"site@example.com"},"address":{"text":"2800 Rockcreek Pkwy, Suite 1, Kansas City, MO, USA, 64117","lines":["2800 Rockcreek Pkwy","Suite 1"],"city":"Kansas City","state":"MO","postalCode":"64117","country":"USA"}}

{
  "id": "9de4edac-64a7-4f3d-a8c2-408c2dfe055b3",
  "name": "Demo Facility",
  "telecoms": [
    {
      "system": "EMAIL",
      "value": "site@example.com"
    }
  ],
  "address": {
    "text": "2800 Rockcreek Pkwy, Suite 1, Kansas City, MO, USA, 64117",
    "lines": [
      "2800 Rockcreek Pkwy",
      "Suite 1"
    ],
    "city": "Kansas City",
    "state": "MO",
    "postalCode": "64117",
    "country": "USA"
  },
  "operationalStatus": "ACTIVE",
  "description": "CernerDemo primary demo facility.",
  "managingOrganization": {
    "id": "f89fa3dd-0000-494b-1111-4640ccc081e3"
  },
  "createdAt": "2018-09-18T19:07:33Z",
  "updatedAt": "2018-09-18T19:07:33Z"
}

POST /locations

Creates a location.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
body	body	postLocations	true	N/A	No description	-

Response Statuses

Status	Meaning	Description	Schema
201	Created	Created	Location
400	Bad Request	Bad Request	Error

Retrieve a Single Location by ID


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/organization/v1/locations/f89fa3dd-0000-494b-1111-4640ccc081e3', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/organization/v1/locations/f89fa3dd-0000-494b-1111-4640ccc081e3 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "9de4edac-64a7-4f3d-a8c2-408c2dfe055b3",
  "name": "Demo Facility",
  "telecoms": [
    {
      "system": "EMAIL",
      "value": "site@example.com"
    }
  ],
  "address": {
    "text": "2800 Rockcreek Pkwy, Suite 1, Kansas City, MO, USA, 64117",
    "lines": [
      "2800 Rockcreek Pkwy",
      "Suite 1"
    ],
    "city": "Kansas City",
    "state": "MO",
    "postalCode": "64117",
    "country": "USA"
  },
  "operationalStatus": "ACTIVE",
  "description": "CernerDemo primary demo facility.",
  "managingOrganization": {
    "id": "f89fa3dd-0000-494b-1111-4640ccc081e3"
  },
  "createdAt": "2018-09-18T19:07:33Z",
  "updatedAt": "2018-09-18T19:07:33Z"
}

GET /locations/{locationId}

Returns a location.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
locationId	path	string	true	N/A	The ID of the location.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	Single Location object	Location
404	Not Found	Not Found	Error

Update a Location




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/organization/v1/locations/f89fa3dd-0000-494b-1111-4640ccc081e3', headers: headers, body: {"name":"Demo Facility","operationalStatus":"ACTIVE","description":"CernerDemo primary demo facility.","managingOrganization":{"id":"f89fa3dd-0000-494b-1111-4640ccc081e3"},"telecoms":{"system":"EMAIL","value":"site@example.com"},"address":{"text":"2800 Rockcreek Pkwy, Suite 1, Kansas City, MO, USA, 64117","lines":["2800 Rockcreek Pkwy","Suite 1"],"city":"Kansas City","state":"MO","postalCode":"64117","country":"USA"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/organization/v1/locations/f89fa3dd-0000-494b-1111-4640ccc081e3 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Demo Facility","operationalStatus":"ACTIVE","description":"CernerDemo primary demo facility.","managingOrganization":{"id":"f89fa3dd-0000-494b-1111-4640ccc081e3"},"telecoms":{"system":"EMAIL","value":"site@example.com"},"address":{"text":"2800 Rockcreek Pkwy, Suite 1, Kansas City, MO, USA, 64117","lines":["2800 Rockcreek Pkwy","Suite 1"],"city":"Kansas City","state":"MO","postalCode":"64117","country":"USA"}}

PUT /locations/{locationId}

Updates a location.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
locationId	path	string	true	N/A	The ID of the location.	-
body	body	putLocations	true	N/A	No description	-

Response Statuses

Status	Meaning	Description	Schema
204	No Content	No Content	None
400	Bad Request	Bad Request	Error
404	Not Found	Not Found	Error

Remove a Location


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/organization/v1/locations/f89fa3dd-0000-494b-1111-4640ccc081e3', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/organization/v1/locations/f89fa3dd-0000-494b-1111-4640ccc081e3 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /locations/{locationId}

Removes a location.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
locationId	path	string	true	N/A	The ID of the location.	-

Response Statuses

Status	Meaning	Description	Schema
204	No Content	No Content	None
404	Not Found	Not Found	Error

Organization

A formally or informally recognized group of people or organizations formed for the purpose of achieving a collective action, for example, companies, institutions, corporations, departments, community groups, and healthcare practice groups.

Retrieve a List of Organizations


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/organization/v1/organizations',
  query: {
  'aliasValue' => 'string'
}, headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/organization/v1/organizations?aliasValue=type,string \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "d053f214-64c1-4f8b-96cb-a410ea1a8b66",
      "name": "Organization Name",
      "telecoms": [
        {
          "system": "EMAIL",
          "value": "site@example.com"
        },
        {
          "system": "PHONE",
          "value": "8162010001"
        }
      ],
      "addresses": [
        {
          "text": "2800 Rockcreek Pkwy, Suite 1, Kansas City, MO, USA, 64117",
          "lines": [
            "2800 Rockcreek Pkwy",
            "Suite 1"
          ],
          "city": "Kansas City",
          "state": "MO",
          "postalCode": "64117",
          "country": "USA"
        }
      ],
      "aliases": [
        {
          "type": "SOI",
          "value": "4831952",
          "system": "2.16.840.1.113883.4.6"
        }
      ],
      "sourceIdentifiers": [
        {
          "id": "4831951",
          "dataPartitionId": "8cbbffdc-acfe-11e7-abc4-cec278b6b50c"
        }
      ],
      "isManual": true,
      "createdAt": "2018-08-17T16:23:59Z",
      "updatedAt": "2018-08-21T16:23:59Z"
    },
    {
      "id": "6403119e-f7f0-46e2-9157-381621b167ea",
      "name": "MIPS Organization View",
      "telecoms": [],
      "addresses": [],
      "aliases": [
        {
          "type": "TAX",
          "value": "000011111",
          "system": "2.16.840.1.113883.4.2"
        }
      ],
      "sourceIdentifiers": [],
      "dynamicOrganization": {
        "id": "6403119e-f7f0-46e2-9157-381621b167ea"
      },
      "isManual": false,
      "createdAt": "2018-10-11T20:16:49Z",
      "updatedAt": "2018-10-11T20:16:49Z"
    }
  ],
  "totalResults": 2,
  "firstLink": "https://cernerdemo.api.us-1.localhealtheintent.com/organization/v1/organizations?limit=20&offset=0",
  "lastLink": "https://cernerdemo.api.us-1.localhealtheintent.com/organization/v1/organizations?limit=20&offset=0"
}

GET /organizations

Retrieves a list of organizations. This list is a combination of all organizations that came from an external source or were created using the API or a configuration tool.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
name	query	string	false	N/A	The name of the organization. Filtering by a partial match is allowed.	-
adminPersonnelId	query	string	false	N/A	The ID of a personnel who is an administrator in the organization.	-
memberPersonnelId	query	string	false	N/A	The ID of a personnel who is a member of the organization.	-
organizationId	query	array[string]	false	N/A	The IDs of the organizations.	-
manualOnly	query	boolean	false	N/A	Indicates whether to retrieve only manually created organizations.	-
aliasValue	query	string	true	N/A	The unique alias to search for. Requires aliasType or aliasSystem.	-
aliasType	query	string	false	N/A	The type of alias to search for. Requires aliasValue. Note: You still can retrieve organizations by NPI and DEA, but you cannot create or update organizations with those alias types.‘	DEA, TAX, SOI, NPI
aliasSystem	query	string	false	N/A	The source of the alias value. This is needed because an alias value that is unique within a given assigning authority (such as Standard Provider Identifier (SPI) or Cerner Millennium) is not guaranteed to be unique across sources; for example, an alias value of 1234 from Cerner Millennium can represent one organization while the alias value of 1234 from Allscripts represents another organization. Requires aliasValue.	-
offset	query	integer(int32)	false	0	The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset.	-
limit	query	integer(int32)	false	20	The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100.	-
orderBy	query	string	false	name	A comma-separated list of fields by which to sort. The order in which the fields are listed determines the order in which sorting is applied. The directionality applied to each field is indicated by the presence (or absence) of a hyphen (-) prefix. Fields with the hyphen prefix are retrieved in descending order; fields without the prefix are retrieved in ascending order.	-name, name

Response Statuses

Status	Meaning	Description	Schema
200	OK	Collection of Organization objects	Organizations
400	Bad Request	Bad Request	Error

Create an Organization




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/organization/v1/organizations', headers: headers, body: {"name":"Rockcreek Clinic","coverageAreaPostalCodes":["90210","61117"],"telecoms":{"system":"EMAIL","value":"site@example.com"},"addresses":{"text":"2800 Rockcreek Pkwy, Suite 1, Kansas City, MO, USA, 64117","lines":["2800 Rockcreek Pkwy","Suite 1"],"city":"Kansas City","state":"MO","postalCode":"64117","country":"USA"},"aliases":{"type":"SOI","value":"4831952","system":"2.16.840.1.113883.4.6"},"sourceIdentifiers":{"id":"4831951","dataPartitionId":"8cbbffdc-acfe-11e7-abc4-cec278b6b50c"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/organization/v1/organizations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Rockcreek Clinic","coverageAreaPostalCodes":["90210","61117"],"telecoms":{"system":"EMAIL","value":"site@example.com"},"addresses":{"text":"2800 Rockcreek Pkwy, Suite 1, Kansas City, MO, USA, 64117","lines":["2800 Rockcreek Pkwy","Suite 1"],"city":"Kansas City","state":"MO","postalCode":"64117","country":"USA"},"aliases":{"type":"SOI","value":"4831952","system":"2.16.840.1.113883.4.6"},"sourceIdentifiers":{"id":"4831951","dataPartitionId":"8cbbffdc-acfe-11e7-abc4-cec278b6b50c"}}

{
  "id": "f89fa3dd-0000-494b-1111-4640ccc081e3",
  "name": "Rockcreek Clinic",
  "telecoms": [
    {
      "system": "EMAIL",
      "value": "site@example.com"
    }
  ],
  "addresses": [
    {
      "text": "2800 Rockcreek Pkwy, Suite 1, Kansas City, MO, USA, 64117",
      "lines": [
        "2800 Rockcreek Pkwy",
        "Suite 1"
      ],
      "city": "Kansas City",
      "state": "MO",
      "postalCode": "64117",
      "country": "USA"
    }
  ],
  "aliases": [
    {
      "type": "SOI",
      "value": "4831952",
      "system": "2.16.840.1.113883.4.6"
    }
  ],
  "sourceIdentifiers": [
    {
      "id": "4831951",
      "dataPartitionId": "8cbbffdc-acfe-11e7-abc4-cec278b6b50c"
    }
  ],
  "coverageAreaPostalCodes": [
    "90210",
    "64117"
  ],
  "dynamicOrganization": {},
  "isManual": true,
  "createdAt": "2018-01-10T15:48:32Z",
  "updatedAt": "2018-05-15T12:23:12Z"
}

POST /organizations

Creates an organization.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
body	body	postOrganizations	true	N/A	No description	-

Response Statuses

Status	Meaning	Description	Schema
201	Created	Created	Organization
400	Bad Request	Bad Request	Error
409	Conflict	Conflict	Error

Retrieve a Single Organization


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/organization/v1/organizations/f89fa3dd-0000-494b-1111-4640ccc081e3', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/organization/v1/organizations/f89fa3dd-0000-494b-1111-4640ccc081e3 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "f89fa3dd-0000-494b-1111-4640ccc081e3",
  "name": "Rockcreek Clinic",
  "telecoms": [
    {
      "system": "EMAIL",
      "value": "site@example.com"
    }
  ],
  "addresses": [
    {
      "text": "2800 Rockcreek Pkwy, Suite 1, Kansas City, MO, USA, 64117",
      "lines": [
        "2800 Rockcreek Pkwy",
        "Suite 1"
      ],
      "city": "Kansas City",
      "state": "MO",
      "postalCode": "64117",
      "country": "USA"
    }
  ],
  "aliases": [
    {
      "type": "SOI",
      "value": "4831952",
      "system": "2.16.840.1.113883.4.6"
    }
  ],
  "sourceIdentifiers": [
    {
      "id": "4831951",
      "dataPartitionId": "8cbbffdc-acfe-11e7-abc4-cec278b6b50c"
    }
  ],
  "coverageAreaPostalCodes": [
    "90210",
    "64117"
  ],
  "dynamicOrganization": {},
  "isManual": true,
  "createdAt": "2018-01-10T15:48:32Z",
  "updatedAt": "2018-05-15T12:23:12Z"
}

GET /organizations/{organizationId}

Retrieves a specific organization by ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
organizationId	path	string	true	N/A	The ID of the organization.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	Single Organization object	Organization
404	Not Found	Not Found	Error

Update an Organization




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/organization/v1/organizations/f89fa3dd-0000-494b-1111-4640ccc081e3', headers: headers, body: {"name":"Rockcreek Clinic","coverageAreaPostalCodes":["90210","61117"],"telecoms":{"system":"EMAIL","value":"site@example.com"},"addresses":{"text":"2800 Rockcreek Pkwy, Suite 1, Kansas City, MO, USA, 64117","lines":["2800 Rockcreek Pkwy","Suite 1"],"city":"Kansas City","state":"MO","postalCode":"64117","country":"USA"},"aliases":{"type":"SOI","value":"4831952","system":"2.16.840.1.113883.4.6"},"sourceIdentifiers":{"id":"4831951","dataPartitionId":"8cbbffdc-acfe-11e7-abc4-cec278b6b50c"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/organization/v1/organizations/f89fa3dd-0000-494b-1111-4640ccc081e3 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Rockcreek Clinic","coverageAreaPostalCodes":["90210","61117"],"telecoms":{"system":"EMAIL","value":"site@example.com"},"addresses":{"text":"2800 Rockcreek Pkwy, Suite 1, Kansas City, MO, USA, 64117","lines":["2800 Rockcreek Pkwy","Suite 1"],"city":"Kansas City","state":"MO","postalCode":"64117","country":"USA"},"aliases":{"type":"SOI","value":"4831952","system":"2.16.840.1.113883.4.6"},"sourceIdentifiers":{"id":"4831951","dataPartitionId":"8cbbffdc-acfe-11e7-abc4-cec278b6b50c"}}

PUT /organizations/{organizationId}

Updates an organization.

Note: If your organization uses an external system to create organizations, you cannot edit or delete organizations using this API. If you send a request to update or delete an organization using the API in this case, a 400 response (Bad Request) is returned.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
organizationId	path	string	true	N/A	The ID of the organization.	-
body	body	putOrganizations	true	N/A	No description	-

Response Statuses

Status	Meaning	Description	Schema
204	No Content	No Content	None
400	Bad Request	Bad Request	Error
404	Not Found	Not Found	Error
409	Conflict	Conflict	Error

Remove an Organization


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/organization/v1/organizations/f89fa3dd-0000-494b-1111-4640ccc081e3', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/organization/v1/organizations/f89fa3dd-0000-494b-1111-4640ccc081e3 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /organizations/{organizationId}

Removes an organization.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
organizationId	path	string	true	N/A	The ID of the organization.	-

Response Statuses

Status	Meaning	Description	Schema
204	No Content	No Content	None
404	Not Found	Not Found	Error

Retrieve a List of Organization Administrators


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/organization/v1/organizations/f89fa3dd-0000-494b-1111-4640ccc081e3/admins', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/organization/v1/organizations/f89fa3dd-0000-494b-1111-4640ccc081e3/admins \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "f89fa3dd-0000-494b-1111-4640ccc081e3",
      "name": "Dr. Jason Smith"
    },
    {
      "id": "hgjfut83-0000-h9g2-1111-4640cjd97de3",
      "name": "Jason Brown Jr."
    }
  ],
  "totalResults": 2,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/organization/v1/organizations/aaa111bb-2222-cccc-3333-ddd444eee555/members&offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/organization/v1/organizations/aaa111bb-2222-cccc-3333-ddd444eee555/members&offset=0&limit=20"
}

GET /organizations/{organizationId}/admins

Retrieves a list of organization administrators.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
adminPersonnelName	query	string	false	N/A	The name of the organization administrator. Filtering by a partial match is allowed.	-
offset	query	integer(int32)	false	0	The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset.	-
limit	query	integer(int32)	false	20	The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100.	-
organizationId	path	string	true	N/A	The ID of the organization.	-
orderBy	query	string	false	name	A comma-separated list of fields by which to sort. The order in which the fields are listed determines the order in which sorting is applied. The directionality applied to each field is indicated by the presence (or absence) of a hyphen (-) prefix. Fields with the hyphen prefix are retrieved in descending order; fields without the prefix are retrieved in ascending order.	-name, name

Response Statuses

Status	Meaning	Description	Schema
200	OK	Collection of Organization Personnel objects.	OrganizationPersonnels
400	Bad Request	Bad Request	Error
404	Not Found	Not Found	Error

Add an Organization Administrator


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/organization/v1/organizations/f89fa3dd-0000-494b-1111-4640ccc081e3/admins/80ec2484-7805-4ef5-bd47-4e9bf5cc8fbb', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/organization/v1/organizations/f89fa3dd-0000-494b-1111-4640ccc081e3/admins/80ec2484-7805-4ef5-bd47-4e9bf5cc8fbb \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

PUT /organizations/{organizationId}/admins/{organizationPersonnelId}

Adds a personnel as an administrator of the organization.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
organizationId	path	string	true	N/A	The ID of the organization.	-
organizationPersonnelId	path	string	true	N/A	The ID of the personnel being added to or removed from an organization.	-

Response Statuses

Status	Meaning	Description	Schema
204	No Content	No Content	None
400	Bad Request	Bad Request	Error
404	Not Found	Not Found	Error

Remove an Organization Administrator


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/organization/v1/organizations/f89fa3dd-0000-494b-1111-4640ccc081e3/admins/80ec2484-7805-4ef5-bd47-4e9bf5cc8fbb', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/organization/v1/organizations/f89fa3dd-0000-494b-1111-4640ccc081e3/admins/80ec2484-7805-4ef5-bd47-4e9bf5cc8fbb \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /organizations/{organizationId}/admins/{organizationPersonnelId}

Removes a personnel from the list of organization administrators.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
organizationId	path	string	true	N/A	The ID of the organization.	-
organizationPersonnelId	path	string	true	N/A	The ID of the personnel being added to or removed from an organization.	-

Response Statuses

Status	Meaning	Description	Schema
204	No Content	No Content	None
400	Bad Request	Bad Request	Error
404	Not Found	Not Found	Error

Retrieve a List of Organization Members


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/organization/v1/organizations/f89fa3dd-0000-494b-1111-4640ccc081e3/members', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/organization/v1/organizations/f89fa3dd-0000-494b-1111-4640ccc081e3/members \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "f89fa3dd-0000-494b-1111-4640ccc081e3",
      "name": "Dr. Jason Smith"
    },
    {
      "id": "hgjfut83-0000-h9g2-1111-4640cjd97de3",
      "name": "Jason Brown Jr."
    }
  ],
  "totalResults": 2,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/organization/v1/organizations/aaa111bb-2222-cccc-3333-ddd444eee555/members&offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/organization/v1/organizations/aaa111bb-2222-cccc-3333-ddd444eee555/members&offset=0&limit=20"
}

GET /organizations/{organizationId}/members

Retrieves a list of organization members.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
memberPersonnelName	query	string	false	N/A	The name of the organization member. Filtering by a partial match is allowed.	-
offset	query	integer(int32)	false	0	The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset.	-
limit	query	integer(int32)	false	20	The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100.	-
organizationId	path	string	true	N/A	The ID of the organization.	-
orderBy	query	string	false	name	A comma-separated list of fields by which to sort. The order in which the fields are listed determines the order in which sorting is applied. The directionality applied to each field is indicated by the presence (or absence) of a hyphen (-) prefix. Fields with the hyphen prefix are retrieved in descending order; fields without the prefix are retrieved in ascending order.	-name, name

Response Statuses

Status	Meaning	Description	Schema
200	OK	Collection of Organization Personnel objects.	OrganizationPersonnels
400	Bad Request	Bad Request	Error
404	Not Found	Not Found	Error

Add an Organization Member


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/organization/v1/organizations/f89fa3dd-0000-494b-1111-4640ccc081e3/members/80ec2484-7805-4ef5-bd47-4e9bf5cc8fbb', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/organization/v1/organizations/f89fa3dd-0000-494b-1111-4640ccc081e3/members/80ec2484-7805-4ef5-bd47-4e9bf5cc8fbb \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

PUT /organizations/{organizationId}/members/{organizationPersonnelId}

Add a personnel as a member of the organization.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
organizationId	path	string	true	N/A	The ID of the organization.	-
organizationPersonnelId	path	string	true	N/A	The ID of the personnel being added to or removed from an organization.	-

Response Statuses

Status	Meaning	Description	Schema
204	No Content	No Content	None
400	Bad Request	Bad Request	Error
404	Not Found	Not Found	Error

Remove an Organization Member


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/organization/v1/organizations/f89fa3dd-0000-494b-1111-4640ccc081e3/members/80ec2484-7805-4ef5-bd47-4e9bf5cc8fbb', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/organization/v1/organizations/f89fa3dd-0000-494b-1111-4640ccc081e3/members/80ec2484-7805-4ef5-bd47-4e9bf5cc8fbb \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /organizations/{organizationId}/members/{organizationPersonnelId}

Removes a personnel from the list of organization members.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
organizationId	path	string	true	N/A	The ID of the organization.	-
organizationPersonnelId	path	string	true	N/A	The ID of the personnel being added to or removed from an organization.	-

Response Statuses

Status	Meaning	Description	Schema
204	No Content	No Content	None
400	Bad Request	Bad Request	Error
404	Not Found	Not Found	Error

Retrieve a List of Organization Groups With an Organization


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/organization/v1/organizations/07be5d1b-8dff-45ce-8f78-7715a5a8755a/organization-groups', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/organization/v1/organizations/07be5d1b-8dff-45ce-8f78-7715a5a8755a/organization-groups \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "1f0a4724-af06-480d-a12b-80e36b60e7e9",
      "name": "Region"
    },
    {
      "id": "bfc11975-dd14-42ae-b7d6-0b06d075cb15",
      "name": "MIPS Group Practice"
    }
  ],
  "totalResults": 2,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/organization/v1/organizations/07be5d1b-8dff-45ce-8f78-7715a5a8755a/organization-groups?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/organization/v1/organizations/07be5d1b-8dff-45ce-8f78-7715a5a8755a/organization-groups?offset=0&limit=20"
}

GET /organizations/{organizationId}/organization-groups

Retrieves a list of the organization groups that include the organization.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
organizationGroupName	query	string	false	N/A	The name of the organization group. Filtering by a partial match is allowed.	-
organizationId	path	string	true	N/A	The ID of the organization.	-
offset	query	integer(int32)	false	0	The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset.	-
limit	query	integer(int32)	false	20	The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100.	-
orderBy	query	string	false	name	A comma-separated list of fields by which to sort. The order in which the fields are listed determines the order in which sorting is applied. The directionality applied to each field is indicated by the presence (or absence) of a hyphen (-) prefix. Fields with the hyphen prefix are retrieved in descending order; fields without the prefix are retrieved in ascending order.	-name, name

Response Statuses

Status	Meaning	Description	Schema
200	OK	A collection of organization groups that include the organization.	OrganizationOrganizationGroups
400	Bad Request	Bad Request	Error
404	Not Found	Not Found	Error

Retrieve a List of Dynamic Organizations With an Organization


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/organization/v1/organizations/07be5d1b-8dff-45ce-8f78-7715a5a8755a/dynamic-organizations', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/organization/v1/organizations/07be5d1b-8dff-45ce-8f78-7715a5a8755a/dynamic-organizations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "f79f290c-8cca-41ab-8373-9efe95d3e307",
      "name": "Analytics Documentation Administrators"
    },
    {
      "id": "3fe9c85d-ae99-49fb-adf8-697b81cdfe4a",
      "name": "Calvert Scoring Organization - Admin"
    }
  ],
  "totalResults": 2,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/organization/v1/organizations/07be5d1b-8dff-45ce-8f78-7715a5a8755a/dynamic-organizations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/organization/v1/organizations/07be5d1b-8dff-45ce-8f78-7715a5a8755a/dynamic-organizations?offset=0&limit=20"
}

GET /organizations/{organizationId}/dynamic-organizations

Retrieves a list of the dynamic organizations that include the organization as an admin or a member.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
dynamicOrganizationName	query	string	false	N/A	The name of the dynamic organization. Filtering by a partial match is allowed.	-
organizationId	path	string	true	N/A	The ID of the organization.	-
offset	query	integer(int32)	false	0	The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset.	-
limit	query	integer(int32)	false	20	The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100.	-
orderBy	query	string	false	name	A comma-separated list of fields by which to sort. The order in which the fields are listed determines the order in which sorting is applied. The directionality applied to each field is indicated by the presence (or absence) of a hyphen (-) prefix. Fields with the hyphen prefix are retrieved in descending order; fields without the prefix are retrieved in ascending order.	-name, name

Response Statuses

Status	Meaning	Description	Schema
200	OK	A collection of dynamic organizations that include the organization.	OrganizationDynamicOrganizations
400	Bad Request	Bad Request	Error
404	Not Found	Not Found	Error

Organization Group

Organization groups are sets of organizations that are grouped for a common purpose. For example, organizations can be grouped to apply a consistent scoring methodology across organizations of the same type, filter a report to a certain set of organizations, or display a group of organizations together in applications.

Retrieve a List of Organization Groups


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/organization/v1/organization-groups',
  query: {
  'aliasValue' => 'string'
}, headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/organization/v1/organization-groups?aliasValue=type,string \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "1f0a4724-af06-480d-a12b-80e36b60e7e9",
      "name": "Region",
      "aliases": [
        {
          "type": "SOGI",
          "value": "283719",
          "system": "2.16.120.1.463719.9.9"
        }
      ]
    },
    {
      "id": "9f7c5e6d-340e-4b52-80d1-aebcc47def8c",
      "name": "Group Practice",
      "aliases": [
        {
          "type": "SOGI",
          "value": "6500789",
          "system": "2.16.840.1.145632.2.1"
        }
      ]
    }
  ],
  "totalResults": 2,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/organization/v1/organization-groups?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/organization/v1/organization-groups?offset=0&limit=20"
}

GET /organization-groups

Retrieves a list of organization groups.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
name	query	string	false	N/A	The name of the organization group. Filtering by a partial match is allowed. All organization groups whose names contain the query string are retrieved.	-
organizationGroupId	query	array[string]	false	N/A	The IDs of the organization groups.	-
aliasValue	query	string	true	N/A	The unique alias for which to search. Requires the aliasType or aliasSystem parameter.	-
aliasType	query	string	false	N/A	The type of alias for which to search. Requires the aliasValue parameter. Standard organization group identifiers (SOGIs) are the aliases that uniquely define organization groups, and `SOGI` is the only aliasType value that is used for organization groups.	SOGI
aliasSystem	query	string	false	N/A	The source of the alias value. Requires the aliasValue parameter. The aliasSystem parameter is needed because an alias value that is unique in a given assigning authority (such as a Standard Provider Identifier (SPI) or Cerner Millennium ID) is not guaranteed to be unique across sources. For example, an alias value of 1234 from Cerner Millennium can represent one organization group while the alias value of 1234 from Allscripts represents another organization group.	-
offset	query	integer(int32)	false	0	The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset.	-
limit	query	integer(int32)	false	20	The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100.	-
orderBy	query	string	false	name	A comma-separated list of fields by which to sort. The order in which the fields are listed determines the order in which sorting is applied. The directionality applied to each field is indicated by the presence (or absence) of a hyphen (-) prefix. Fields with the hyphen prefix are retrieved in descending order; fields without the prefix are retrieved in ascending order.	name, -name

Response Statuses

Status	Meaning	Description	Schema
200	OK	Collection of Organization Group objects	OrganizationGroups
400	Bad Request	Bad Request	Error

Create an Organization Group




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/organization/v1/organization-groups', headers: headers, body: {"name":"Region","aliases":{"type":"SOGI","value":"7348734","system":"2.16.230.1.759204.2.3"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/organization/v1/organization-groups \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Region","aliases":{"type":"SOGI","value":"7348734","system":"2.16.230.1.759204.2.3"}}

{
  "id": "1f0a4724-af06-480d-a12b-80e36b60e7e9",
  "name": "Region",
  "createdAt": "2018-01-10T15:48:32Z",
  "updatedAt": "2018-05-15T12:23:12Z",
  "aliases": [
    {
      "type": "SOGI",
      "value": "7348734",
      "system": "2.16.230.1.759204.2.3"
    }
  ]
}

POST /organization-groups

Creates an organization group.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
body	body	postOrganizationGroups	true	N/A	No description	-

Response Statuses

Status	Meaning	Description	Schema
201	Created	Created	OrganizationGroup
400	Bad Request	Bad Request	Error
409	Conflict	Conflict	Error

Retrieve a Single Organization Group


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/organization/v1/organization-groups/1f0a4724-af06-480d-a12b-80e36b60e7e9', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/organization/v1/organization-groups/1f0a4724-af06-480d-a12b-80e36b60e7e9 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "1f0a4724-af06-480d-a12b-80e36b60e7e9",
  "name": "Region",
  "createdAt": "2018-01-10T15:48:32Z",
  "updatedAt": "2018-05-15T12:23:12Z",
  "aliases": [
    {
      "type": "SOGI",
      "value": "7348734",
      "system": "2.16.230.1.759204.2.3"
    }
  ]
}

GET /organization-groups/{organizationGroupId}

Retrieves a specific organization group by ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
organizationGroupId	path	string	true	N/A	The ID of the organization group.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	Single Organization Group object	OrganizationGroup
404	Not Found	Not Found	Error

Update an Organization Group




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/organization/v1/organization-groups/1f0a4724-af06-480d-a12b-80e36b60e7e9', headers: headers, body: {"name":"Region","aliases":{"type":"SOGI","value":"7348734","system":"2.16.230.1.759204.2.3"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/organization/v1/organization-groups/1f0a4724-af06-480d-a12b-80e36b60e7e9 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Region","aliases":{"type":"SOGI","value":"7348734","system":"2.16.230.1.759204.2.3"}}

PUT /organization-groups/{organizationGroupId}

Updates an organization group.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
organizationGroupId	path	string	true	N/A	The ID of the organization group.	-
body	body	putOrganizationGroups	true	N/A	No description	-

Response Statuses

Status	Meaning	Description	Schema
204	No Content	No Content	None
400	Bad Request	Bad Request	Error
404	Not Found	Not Found	Error
409	Conflict	Conflict	Error

Remove an Organization Group


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/organization/v1/organization-groups/1f0a4724-af06-480d-a12b-80e36b60e7e9', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/organization/v1/organization-groups/1f0a4724-af06-480d-a12b-80e36b60e7e9 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /organization-groups/{organizationGroupId}

Removes an organization group.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
organizationGroupId	path	string	true	N/A	The ID of the organization group.	-

Response Statuses

Status	Meaning	Description	Schema
204	No Content	No Content	None
404	Not Found	Not Found	Error

Retrieve a List of Organization Group Organizations


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/organization/v1/organization-groups/bfc11975-dd14-42ae-b7d6-0b06d075cb15/organizations', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/organization/v1/organization-groups/bfc11975-dd14-42ae-b7d6-0b06d075cb15/organizations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "231737f5-b772-46de-a1b9-2739db6f92d5",
      "name": "Northland Physician Practice"
    },
    {
      "id": "07be5d1b-8dff-45ce-8f78-7715a5a8755a",
      "name": "Parker Reed Memorial Hospital"
    },
    {
      "id": "ebbe3b79-4095-4c2b-a414-7aa42fd8280b",
      "name": "Test"
    }
  ],
  "totalResults": 3,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/organization/v1/organization-groups/bfc11975-dd14-42ae-b7d6-0b06d075cb15/organizations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/organization/v1/organization-groups/bfc11975-dd14-42ae-b7d6-0b06d075cb15/organizations?offset=0&limit=20"
}

GET /organization-groups/{organizationGroupId}/organizations

Retrieves a list of the organizations in an organization group.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
offset	query	integer(int32)	false	0	The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset.	-
limit	query	integer(int32)	false	20	The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100.	-
organizationGroupId	path	string	true	N/A	The ID of the organization group.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	Collection of organizations in an organization group	OrganizationGroupOrganizations
400	Bad Request	Bad Request	Error
404	Not Found	Not Found	Error

Add an Organization to an Organization Group


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/organization/v1/organization-groups/bfc11975-dd14-42ae-b7d6-0b06d075cb15/organizations/ebbe3b79-4095-4c2b-a414-7aa42fd8280b', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/organization/v1/organization-groups/bfc11975-dd14-42ae-b7d6-0b06d075cb15/organizations/ebbe3b79-4095-4c2b-a414-7aa42fd8280b \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

PUT /organization-groups/{organizationGroupId}/organizations/{organizationId}

Adds an organization to an organization group.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
organizationId	path	string	true	N/A	The ID of the organization to be added to the group.	-
organizationGroupId	path	string	true	N/A	The ID of the organization group.	-

Response Statuses

Status	Meaning	Description	Schema
204	No Content	No Content	None
400	Bad Request	Bad Request	Error
404	Not Found	Not Found	Error

Remove an Organization From an Organization Group


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/organization/v1/organization-groups/bfc11975-dd14-42ae-b7d6-0b06d075cb15/organizations/ebbe3b79-4095-4c2b-a414-7aa42fd8280b', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/organization/v1/organization-groups/bfc11975-dd14-42ae-b7d6-0b06d075cb15/organizations/ebbe3b79-4095-4c2b-a414-7aa42fd8280b \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /organization-groups/{organizationGroupId}/organizations/{organizationId}

Removes an organization from an organization group.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
organizationId	path	string	true	N/A	The ID of the organization to be removed from the group.	-
organizationGroupId	path	string	true	N/A	The ID of the organization group.	-

Response Statuses

Status	Meaning	Description	Schema
204	No Content	No Content	None
400	Bad Request	Bad Request	Error
404	Not Found	Not Found	Error

Personnel

A personnel entity can be a member or administrator of an organization, and some personnel may be both members and administrators of the same organization. Organization members typically are personnel who provide healthcare services to patients and whose financial performance and quality metrics contribute to the overall performance of the organization. Administrators are personnel who monitor and manage the activities and performance of their organizations.

Retrieve a List of Organizations by Personnel


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/organization/v1/personnel/00484898-3aa7-4080-8745-27b974b62887/organizations', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/organization/v1/personnel/00484898-3aa7-4080-8745-27b974b62887/organizations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "8b18d817-4a2d-47cb-b1ad-be1b744d20c0",
      "name": "Baseline West Medical Center"
    },
    {
      "id": "42404366-fd30-46f7-8746-709ea2d74155",
      "name": "Baseline West Primary Care Clinic"
    }
  ],
  "totalResults": 2,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/organization/v1/personnel/00484898-3aa7-4080-8745-27b974b62887/organization&offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/organization/v1/personnel/00484898-3aa7-4080-8745-27b974b62887/organization&offset=0&limit=20"
}

GET /personnel/{personnelId}/organizations

Retrieves a list of organizations that include a given personnel as an administrator or member.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
personnelId	path	string	true	N/A	The ID of the personnel.	-
offset	query	integer(int32)	false	0	The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset.	-
limit	query	integer(int32)	false	20	The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100.	-
orderBy	query	string	false	name	A comma-separated list of fields by which to sort. The order in which the fields are listed determines the order in which sorting is applied. The directionality applied to each field is indicated by the presence (or absence) of a hyphen (-) prefix. Fields with the hyphen prefix are retrieved in descending order; fields without the prefix are retrieved in ascending order.	-name, name

Response Statuses

Status	Meaning	Description	Schema
200	OK	A collection of organizations that include the personnel as an administrator or member.	PersonnelOrganizations
400	Bad Request	Bad Request	Error
404	Not Found	Not Found	Error

Dynamic Organization

Dynamic organizations are combinations of organizations and personnel groups and not real-world organizations. The join type determines the combination. Like organizations, dynamic organizations have members and administrators; however, they do not have addresses. For example, a physician-hospital organization (PHO) might be represented in Health Data Intelligence as a dynamic organization because a medical group administrator wants to view the medical group’s employed providers in a single organization.

Dynamic organizations are considered dynamic and not static because when an included entity is updated, the dynamic organization also is updated. The system creates or updates the dynamic organization and generates the organization immediately, but the processing of the generated organization may be delayed up to two minutes. The created or updated member and administrator lists are not available until the processing is complete. The generated organization can be traced back to the dynamic organization using the dynamic organization ID to allow for further modifications such as adding a new personnel group to the dynamic organization.

Terminology

Join Types

Join types are the methods by which administrators and members are added to a dynamic organization.

Administrator Join Types

Administrators can be added to a dynamic organization in the following ways:

Join Type	Definition
Union	If the union join type is used to add administrators, all administrators of the specified organizations and all members of the specified personnel groups are added as administrators of the resulting organization.
Intersection	If the intersection join type is used to add administrators, only personnel who are both administrators of the specified organizations and members of the specified personnel groups are added as administrators of the resulting organization.

Member Join Types

Members can be added to a dynamic organization in the following ways:

Join Type	Definition
Union	If the union join type is used to add members, all members of the specified organizations and all members of the specified personnel groups are added as members of the resulting organization.
Intersection	If the intersection join type is used to add members, only personnel who are both members of the specified organizations and members of the specified personnel groups are added as members of the resulting organization.

Retrieve a List of Dynamic Organizations


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/organization/v1/dynamic-organizations', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/organization/v1/dynamic-organizations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "f79f290c-8cca-41ab-8373-9efe95d3e307",
      "name": "Analytics Documentation Administrators",
      "adminJoinType": "INTERSECTION",
      "memberJoinType": "UNION",
      "aliases": [
        {
          "type": "SOI",
          "value": "4831952",
          "system": "2.16.840.1.113883.4.6"
        }
      ],
      "organization": {
        "id": "f79f290c-8cca-41ab-8373-9efe95d3e307"
      },
      "createdAt": "2019-03-19T16:50:12Z",
      "updatedAt": "2019-03-19T17:08:25Z"
    },
    {
      "id": "3fe9c85d-ae99-49fb-adf8-697b81cdfe4a",
      "name": "Calvert Scoring Organization - Admin",
      "adminJoinType": "UNION",
      "memberJoinType": "UNION",
      "aliases": [],
      "organization": {
        "id": "3fe9c85d-ae99-49fb-adf8-697b81cdfe4a"
      },
      "createdAt": "2018-09-14T19:19:15Z",
      "updatedAt": "2018-09-14T19:24:05Z"
    }
  ],
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/organization/v1/dynamic-organizations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/organization/v1/dynamic-organizations?offset=0&limit=20",
  "totalResults": 2
}

GET /dynamic-organizations

Retrieves a list of dynamic organizations.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
name	query	string	false	N/A	The name of the dynamic organization. Filtering by a partial match is allowed. All dynamic organizations whose names contain the query string are retrieved.	-
offset	query	integer(int32)	false	0	The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset.	-
limit	query	integer(int32)	false	20	The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100.	-
orderBy	query	string	false	name	A comma-separated list of fields by which to sort. The order in which the fields are listed determines the order in which sorting is applied. The directionality applied to each field is indicated by the presence (or absence) of a hyphen (-) prefix. Fields with the hyphen prefix are retrieved in descending order; fields without the prefix are retrieved in ascending order.	name, -name

Response Statuses

Status	Meaning	Description	Schema
200	OK	Collection of Dynamic Organization objects	DynamicOrganizations
400	Bad Request	Bad Request	Error

Create a Dynamic Organization




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/organization/v1/dynamic-organizations', headers: headers, body: {"name":"Analytics Documentation Administrators","aliases":[{"type":"SOI","value":"4831952","system":"2.16.840.1.113883.4.6"}],"adminJoinType":"INTERSECTION","memberJoinType":"UNION"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/organization/v1/dynamic-organizations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Analytics Documentation Administrators","aliases":[{"type":"SOI","value":"4831952","system":"2.16.840.1.113883.4.6"}],"adminJoinType":"INTERSECTION","memberJoinType":"UNION"}

{
  "id": "f79f290c-8cca-41ab-8373-9efe95d3e307",
  "name": "Analytics Documentation Administrators",
  "aliases": [
    {
      "type": "SOI",
      "value": "4831952",
      "system": "2.16.840.1.113883.4.6"
    }
  ],
  "adminJoinType": "INTERSECTION",
  "memberJoinType": "UNION",
  "organization": {
    "id": "f89fa3dd-0000-494b-1111-4640ccc081e3"
  },
  "createdAt": "2019-03-19T16:50:12Z",
  "updatedAt": "2019-03-19T17:08:25Z"
}

POST /dynamic-organizations

Creates a dynamic organization.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
body	body	postDynamicOrganizations	true	N/A	No description	-

Response Statuses

Status	Meaning	Description	Schema
201	Created	Created	DynamicOrganization
400	Bad Request	Bad Request	Error
409	Conflict	Conflict. The requested dynamic organization could not be successfully published due to a conflicting entity. The following reasons are possible, among others: - `duplicateAlias` The aliases are already present for the given tenant.	Error

Retrieve a Single Dynamic Organization


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/organization/v1/dynamic-organizations/f79f290c-8cca-41ab-8373-9efe95d3e307', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/organization/v1/dynamic-organizations/f79f290c-8cca-41ab-8373-9efe95d3e307 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "id": "f79f290c-8cca-41ab-8373-9efe95d3e307",
  "name": "Analytics Documentation Administrators",
  "aliases": [
    {
      "type": "SOI",
      "value": "4831952",
      "system": "2.16.840.1.113883.4.6"
    }
  ],
  "adminJoinType": "INTERSECTION",
  "memberJoinType": "UNION",
  "organization": {
    "id": "f89fa3dd-0000-494b-1111-4640ccc081e3"
  },
  "createdAt": "2019-03-19T16:50:12Z",
  "updatedAt": "2019-03-19T17:08:25Z"
}

GET /dynamic-organizations/{dynamicOrganizationId}

Retrieves a specific dynamic organization by ID.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
dynamicOrganizationId	path	string	true	N/A	The ID of the dynamic organization.	-

Response Statuses

Status	Meaning	Description	Schema
200	OK	Single Dynamic Organization object	DynamicOrganization
404	Not Found	Not Found	Error

Update a Dynamic Organization




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/organization/v1/dynamic-organizations/f79f290c-8cca-41ab-8373-9efe95d3e307', headers: headers, body: {"name":"Analytics Documentation Administrators","aliases":[{"type":"SOI","value":"4831952","system":"2.16.840.1.113883.4.6"}],"adminJoinType":"INTERSECTION","memberJoinType":"UNION"}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/organization/v1/dynamic-organizations/f79f290c-8cca-41ab-8373-9efe95d3e307 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Analytics Documentation Administrators","aliases":[{"type":"SOI","value":"4831952","system":"2.16.840.1.113883.4.6"}],"adminJoinType":"INTERSECTION","memberJoinType":"UNION"}

PUT /dynamic-organizations/{dynamicOrganizationId}

Updates a dynamic organization.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
dynamicOrganizationId	path	string	true	N/A	The ID of the dynamic organization.	-
body	body	putDynamicOrganizations	true	N/A	No description	-

Response Statuses

Status	Meaning	Description	Schema
204	No Content	No Content	None
400	Bad Request	Bad Request	Error
404	Not Found	Not Found	Error
409	Conflict	Conflict. The requested dynamic organization could not be successfully published due to a conflicting entity. The following reasons are possible, among others: - `duplicateAlias` The aliases are already present for the given tenant.	Error

Remove a Dynamic Organization


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/organization/v1/dynamic-organizations/f79f290c-8cca-41ab-8373-9efe95d3e307', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/organization/v1/dynamic-organizations/f79f290c-8cca-41ab-8373-9efe95d3e307 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /dynamic-organizations/{dynamicOrganizationId}

Removes a dynamic organization.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
dynamicOrganizationId	path	string	true	N/A	The ID of the dynamic organization.	-

Response Statuses

Status	Meaning	Description	Schema
204	No Content	No Content	None
404	Not Found	Not Found	Error

Retrieve a List of Administrator Personnel Groups for a Dynamic Organization


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/organization/v1/dynamic-organizations/f79f290c-8cca-41ab-8373-9efe95d3e307/admin-personnel-groups', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/organization/v1/dynamic-organizations/f79f290c-8cca-41ab-8373-9efe95d3e307/admin-personnel-groups \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "157b88a2-3ced-41e4-adfd-c1406f2faeb8",
      "name": "Analytics Documentation Personnel"
    }
  ],
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/organization/v1/dynamic-organizations/f79f290c-8cca-41ab-8373-9efe95d3e307/admin-personnel-groups?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/organization/v1/dynamic-organizations/f79f290c-8cca-41ab-8373-9efe95d3e307/admin-personnel-groups?offset=0&limit=20",
  "totalResults": 1
}

GET /dynamic-organizations/{dynamicOrganizationId}/admin-personnel-groups

Retrieves a list of the administrator personnel groups for a dynamic organization.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
adminPersonnelGroupName	query	string	false	N/A	The name of the administrator personnel group. Filtering by a partial match is allowed.	-
dynamicOrganizationId	path	string	true	N/A	The ID of the dynamic organization.	-
offset	query	integer(int32)	false	0	The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset.	-
limit	query	integer(int32)	false	20	The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100.	-
orderBy	query	string	false	name	A comma-separated list of fields by which to sort. The order in which the fields are listed determines the order in which sorting is applied. The directionality applied to each field is indicated by the presence (or absence) of a hyphen (-) prefix. Fields with the hyphen prefix are retrieved in descending order; fields without the prefix are retrieved in ascending order.	-name, name

Response Statuses

Status	Meaning	Description	Schema
200	OK	Collection of summaries of administrator personnel groups	DynamicOrganizationAdminGroups
400	Bad Request	Bad Request	Error
404	Not Found	Not Found	Error

Add an Administrator Personnel Group to a Dynamic Organization


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/organization/v1/dynamic-organizations/f79f290c-8cca-41ab-8373-9efe95d3e307/admin-personnel-groups/cc6cf6aa-9b45-43f9-952f-97b2cc0b57c3', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/organization/v1/dynamic-organizations/f79f290c-8cca-41ab-8373-9efe95d3e307/admin-personnel-groups/cc6cf6aa-9b45-43f9-952f-97b2cc0b57c3 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

PUT /dynamic-organizations/{dynamicOrganizationId}/admin-personnel-groups/{personnelGroupId}

Adds an administrator personnel group to a dynamic organization. The personnel group to be added cannot be generated from a personnel group view.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
personnelGroupId	path	string	true	N/A	The ID of the personnel group to be added to the dynamic organization.	-
dynamicOrganizationId	path	string	true	N/A	The ID of the dynamic organization.	-

Response Statuses

Status	Meaning	Description	Schema
204	No Content	No Content	None
400	Bad Request	Bad Request	Error
404	Not Found	Not Found	Error
409	Conflict	Conflict. The requested personnel group could not be successfully published due to a conflicting entity. The following reasons are possible, among others: - `invalidPersonnelGroup` The personnel group is a personnel group view and cannot be published.	Error

Remove an Administrator Personnel Group From a Dynamic Organization


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/organization/v1/dynamic-organizations/f79f290c-8cca-41ab-8373-9efe95d3e307/admin-personnel-groups/157b88a2-3ced-41e4-adfd-c1406f2faeb8', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/organization/v1/dynamic-organizations/f79f290c-8cca-41ab-8373-9efe95d3e307/admin-personnel-groups/157b88a2-3ced-41e4-adfd-c1406f2faeb8 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /dynamic-organizations/{dynamicOrganizationId}/admin-personnel-groups/{personnelGroupId}

Removes an administrator personnel group from a dynamic organization.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
personnelGroupId	path	string	true	N/A	The ID of the personnel group to be deleted from the dynamic organization.	-
dynamicOrganizationId	path	string	true	N/A	The ID of the dynamic organization.	-

Response Statuses

Status	Meaning	Description	Schema
204	No Content	No Content	None
400	Bad Request	Bad Request	Error
404	Not Found	Not Found	Error

Retrieve a List of Administrator Organizations for a Dynamic Organization


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/organization/v1/dynamic-organizations/f79f290c-8cca-41ab-8373-9efe95d3e307/admin-organizations', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/organization/v1/dynamic-organizations/f79f290c-8cca-41ab-8373-9efe95d3e307/admin-organizations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "3c03a11b-648d-45ea-92c6-e12071e945d0",
      "name": "Walden Analytical Consultants"
    }
  ],
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/organization/v1/dynamic-organizations/f79f290c-8cca-41ab-8373-9efe95d3e307/admin-organizations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/organization/v1/dynamic-organizations/f79f290c-8cca-41ab-8373-9efe95d3e307/admin-organizations?offset=0&limit=20",
  "totalResults": 1
}

GET /dynamic-organizations/{dynamicOrganizationId}/admin-organizations

Retrieves a list of the administrator organizations for a dynamic organization.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
adminOrganizationName	query	string	false	N/A	The name of the administrator organization. Filtering by a partial match is allowed.	-
dynamicOrganizationId	path	string	true	N/A	The ID of the dynamic organization.	-
offset	query	integer(int32)	false	0	The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset.	-
limit	query	integer(int32)	false	20	The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100.	-
orderBy	query	string	false	name	A comma-separated list of fields by which to sort. The order in which the fields are listed determines the order in which sorting is applied. The directionality applied to each field is indicated by the presence (or absence) of a hyphen (-) prefix. Fields with the hyphen prefix are retrieved in descending order; fields without the prefix are retrieved in ascending order.	-name, name

Response Statuses

Status	Meaning	Description	Schema
200	OK	Collection of summaries of administrator organizations	DynamicOrganizationAdminOrganizations
400	Bad Request	Bad Request	Error
404	Not Found	Not Found	Error

Add an Administrator Organization to a Dynamic Organization


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/organization/v1/dynamic-organizations/f79f290c-8cca-41ab-8373-9efe95d3e307/admin-organizations/02f5c5b6-49e1-4f0f-981d-71397485da64', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/organization/v1/dynamic-organizations/f79f290c-8cca-41ab-8373-9efe95d3e307/admin-organizations/02f5c5b6-49e1-4f0f-981d-71397485da64 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

PUT /dynamic-organizations/{dynamicOrganizationId}/admin-organizations/{organizationId}

Adds an administrator organization to the dynamic organization. The organization to be added cannot be generated from a dynamic organization.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
organizationId	path	string	true	N/A	The ID of the organization to be added to the dynamic organization.	-
dynamicOrganizationId	path	string	true	N/A	The ID of the dynamic organization.	-

Response Statuses

Status	Meaning	Description	Schema
204	No Content	No Content	None
400	Bad Request	Bad Request	Error
404	Not Found	Not Found	Error
409	Conflict	Conflict. The requested organization could not be successfully published due to a conflicting entity. The following reasons are possible, among others: - `invalidOrganization` The organization is generated from a dynamic organization and cannot be published.	Error

Remove an Administrator Organization from a Dynamic Organization


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/organization/v1/dynamic-organizations/f79f290c-8cca-41ab-8373-9efe95d3e307/admin-organizations/3c03a11b-648d-45ea-92c6-e12071e945d0', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/organization/v1/dynamic-organizations/f79f290c-8cca-41ab-8373-9efe95d3e307/admin-organizations/3c03a11b-648d-45ea-92c6-e12071e945d0 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /dynamic-organizations/{dynamicOrganizationId}/admin-organizations/{organizationId}

Removes an administrator organization from the dynamic organization.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
organizationId	path	string	true	N/A	The ID of the organization to be deleted from the dynamic organization.	-
dynamicOrganizationId	path	string	true	N/A	The ID of the dynamic organization.	-

Response Statuses

Status	Meaning	Description	Schema
204	No Content	No Content	None
400	Bad Request	Bad Request	Error
404	Not Found	Not Found	Error

Retrieve a List of Member Personnel Groups for a Dynamic Organization


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/organization/v1/dynamic-organizations/f79f290c-8cca-41ab-8373-9efe95d3e307/member-personnel-groups', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/organization/v1/dynamic-organizations/f79f290c-8cca-41ab-8373-9efe95d3e307/member-personnel-groups \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "157b88a2-3ced-41e4-adfd-c1406f2faeb8",
      "name": "Analytics Documentation Personnel"
    }
  ],
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/organization/v1/dynamic-organizations/f79f290c-8cca-41ab-8373-9efe95d3e307/member-personnel-groups?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/organization/v1/dynamic-organizations/f79f290c-8cca-41ab-8373-9efe95d3e307/member-personnel-groups?offset=0&limit=20",
  "totalResults": 1
}

GET /dynamic-organizations/{dynamicOrganizationId}/member-personnel-groups

Retrieves a list of the member personnel groups for a dynamic organization.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
memberPersonnelGroupName	query	string	false	N/A	The name of the member personnel group. Filtering by a partial match is allowed.	-
dynamicOrganizationId	path	string	true	N/A	The ID of the dynamic organization.	-
offset	query	integer(int32)	false	0	The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset.	-
limit	query	integer(int32)	false	20	The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100.	-
orderBy	query	string	false	name	A comma-separated list of fields by which to sort. The order in which the fields are listed determines the order in which sorting is applied. The directionality applied to each field is indicated by the presence (or absence) of a hyphen (-) prefix. Fields with the hyphen prefix are retrieved in descending order; fields without the prefix are retrieved in ascending order.	-name, name

Response Statuses

Status	Meaning	Description	Schema
200	OK	Collection of summaries of member personnel groups	DynamicOrganizationMemberGroups
400	Bad Request	Bad Request	Error
404	Not Found	Not Found	Error

Add a Member Personnel Group to a Dynamic Organization


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/organization/v1/dynamic-organizations/f79f290c-8cca-41ab-8373-9efe95d3e307/member-personnel-groups/cc6cf6aa-9b45-43f9-952f-97b2cc0b57c3', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/organization/v1/dynamic-organizations/f79f290c-8cca-41ab-8373-9efe95d3e307/member-personnel-groups/cc6cf6aa-9b45-43f9-952f-97b2cc0b57c3 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

PUT /dynamic-organizations/{dynamicOrganizationId}/member-personnel-groups/{personnelGroupId}

Adds a member personnel group to a dynamic organization. The personnel group to be added cannot be generated from a personnel group view.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
personnelGroupId	path	string	true	N/A	The ID of the personnel group to be added to the dynamic organization.	-
dynamicOrganizationId	path	string	true	N/A	The ID of the dynamic organization.	-

Response Statuses

Status	Meaning	Description	Schema
204	No Content	No Content	None
400	Bad Request	Bad Request	Error
404	Not Found	Not Found	Error
409	Conflict	Conflict. The requested personnel group could not be successfully published due to a conflicting entity. The following reasons are possible, among others: - `invalidPersonnelGroup` The personnel group is a personnel group view and cannot be published.	Error

Remove a Member Personnel Group from a Dynamic Organization


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/organization/v1/dynamic-organizations/f79f290c-8cca-41ab-8373-9efe95d3e307/member-personnel-groups/157b88a2-3ced-41e4-adfd-c1406f2faeb8', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/organization/v1/dynamic-organizations/f79f290c-8cca-41ab-8373-9efe95d3e307/member-personnel-groups/157b88a2-3ced-41e4-adfd-c1406f2faeb8 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /dynamic-organizations/{dynamicOrganizationId}/member-personnel-groups/{personnelGroupId}

Removes a member personnel group from a dynamic organization.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
personnelGroupId	path	string	true	N/A	The ID of the personnel group to be deleted from the dynamic organization.	-
dynamicOrganizationId	path	string	true	N/A	The ID of the dynamic organization.	-

Response Statuses

Status	Meaning	Description	Schema
204	No Content	No Content	None
400	Bad Request	Bad Request	Error
404	Not Found	Not Found	Error

Retrieve a List of Member Organizations for a Dynamic Organization


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/organization/v1/dynamic-organizations/f79f290c-8cca-41ab-8373-9efe95d3e307/member-organizations', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/organization/v1/dynamic-organizations/f79f290c-8cca-41ab-8373-9efe95d3e307/member-organizations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

{
  "items": [
    {
      "id": "3c03a11b-648d-45ea-92c6-e12071e945d0",
      "name": "Walden Analytical Consultants"
    }
  ],
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/organization/v1/dynamic-organizations/f79f290c-8cca-41ab-8373-9efe95d3e307/member-organizations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/organization/v1/dynamic-organizations/f79f290c-8cca-41ab-8373-9efe95d3e307/member-organizations?offset=0&limit=20",
  "totalResults": 1
}

GET /dynamic-organizations/{dynamicOrganizationId}/member-organizations

Retrieves a list of the member organizations for a dynamic organization.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
memberOrganizationName	query	string	false	N/A	The name of the member organization. Filtering by a partial match is allowed.	-
dynamicOrganizationId	path	string	true	N/A	The ID of the dynamic organization.	-
offset	query	integer(int32)	false	0	The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset.	-
limit	query	integer(int32)	false	20	The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100.	-
orderBy	query	string	false	name	A comma-separated list of fields by which to sort. The order in which the fields are listed determines the order in which sorting is applied. The directionality applied to each field is indicated by the presence (or absence) of a hyphen (-) prefix. Fields with the hyphen prefix are retrieved in descending order; fields without the prefix are retrieved in ascending order.	-name, name

Response Statuses

Status	Meaning	Description	Schema
200	OK	Collection of summaries of member organizations	DynamicOrganizationMemberOrganizations
400	Bad Request	Bad Request	Error
404	Not Found	Not Found	Error

Add a Member Organization to a Dynamic Organization


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/organization/v1/dynamic-organizations/f79f290c-8cca-41ab-8373-9efe95d3e307/member-organizations/02f5c5b6-49e1-4f0f-981d-71397485da64', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/organization/v1/dynamic-organizations/f79f290c-8cca-41ab-8373-9efe95d3e307/member-organizations/02f5c5b6-49e1-4f0f-981d-71397485da64 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

PUT /dynamic-organizations/{dynamicOrganizationId}/member-organizations/{organizationId}

Adds a member organization to a dynamic organization. The organization to be added cannot be generated from a dynamic organization.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
organizationId	path	string	true	N/A	The ID of the organization to be added to the dynamic organization.	-
dynamicOrganizationId	path	string	true	N/A	The ID of the dynamic organization.	-

Response Statuses

Status	Meaning	Description	Schema
204	No Content	No Content	None
400	Bad Request	Bad Request	Error
404	Not Found	Not Found	Error
409	Conflict	Conflict. The requested organization could not be successfully published due to a conflicting entity. The following reasons are possible, among others: - `invalidOrganization` The organization is generated from a dynamic organization and cannot be published.	Error

Remove a Member Organization from a Dynamic Organization


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/organization/v1/dynamic-organizations/f79f290c-8cca-41ab-8373-9efe95d3e307/member-organizations/3c03a11b-648d-45ea-92c6-e12071e945d0', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/organization/v1/dynamic-organizations/f79f290c-8cca-41ab-8373-9efe95d3e307/member-organizations/3c03a11b-648d-45ea-92c6-e12071e945d0 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /dynamic-organizations/{dynamicOrganizationId}/member-organizations/{organizationId}

Removes a member organization from a dynamic organization.

Parameters

Parameter	In	Type	Required	Default	Description	Accepted Values
organizationId	path	string	true	N/A	The ID of the organization to be deleted from the dynamic organization.	-
dynamicOrganizationId	path	string	true	N/A	The ID of the dynamic organization.	-

Response Statuses

Status	Meaning	Description	Schema
204	No Content	No Content	None
400	Bad Request	Bad Request	Error
404	Not Found	Not Found	Error

Schema Definitions

Locations

Name	Type	Required	Description	Accepted Values
items	[Location]	true	An array containing the current page of results.	-
firstLink	string	true	The first page of results.	-
lastLink	string	true	The last page of results.	-
prevLink	string	false	The previous page of results.	-
nextLink	string	false	The next page of results.	-
totalResults	integer(int32)	true	The total number of results for the specified parameters.	-

Location

Name	Type	Required	Description	Accepted Values
id	string	false	The unique ID of the location.	-
name	string	false	The name of the location.	-
telecoms	[Telecom]	false	Contact details related to the location.	-
address	Address	false	The address of the location.	-
operationalStatus	string	false	The current operational status of the location.	ACTIVE, SUSPENDED, INACTIVE
description	string	false	Additional details about the location that can be displayed as further information to identify the location beyond its name.	-
managingOrganization	OrganizationReference	false	The unique ID of the organization that is responsible for the provisioning and upkeep of the location.	-
createdAt	string(date-time)	false	The date and time when this location was created, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.	-
updatedAt	string(date-time)	false	The date and time of the most recent update to this location, in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.	-

Telecom

Name	Type	Required	Description	Accepted Values
system	string	true	The type of telecom system being used	PHONE, EMAIL, URL, OTHER
value	string	true	The value of the telecom.	-

Address

Name	Type	Required	Description	Accepted Values
text	string	false	The formatted display text of the address.	-
lines	[string]	false	The street component of the address.	-
city	string	false	The city of the address.	-
state	string	false	The state of the address.	-
postalCode	string	false	The postal code of the address.	-
country	string	false	The country of the address.	-

OrganizationReference

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the organization that is responsible for the provisioning and upkeep of the location.	-

Organizations

Name	Type	Required	Description	Accepted Values
items	[Organization]	true	An array containing the current page of results.	-
firstLink	string	true	The first page of results.	-
lastLink	string	true	The last page of results.	-
prevLink	string	false	The previous page of results.	-
nextLink	string	false	The next page of results.	-
totalResults	integer(int32)	true	The total number of results for the specified parameters.	-

Organization

Name	Type	Required	Description	Accepted Values
id	string	false	The unique ID of the organization.	-
name	string	false	The name of the organization.	-
telecoms	[Telecom]	false	The contact details of the organization.	-
addresses	[OrganizationAddress]	false	The addresses of the organization.	-
aliases	[Alias]	false	The aliases that identify the organization across systems.	-
sourceIdentifiers	[SourceIdentifier]	false	The IDs that link the organization to an external source.	-
coverageAreaPostalCodes	[string]	false	The postal codes that indicate the area covered by the organization.	-
dynamicOrganization	Reference	false	The dynamic organization that defines this organization. This attribute is populated for organizations that are generated from a dynamic organization.	-
isManual	boolean	false	Indicates whether this organization was created manually.	-
createdAt	string(date-time)	false	The date and time when the organization was created, in ISO 8601 format with a precision of YYYY-MM-DDThh:mm:ssZ.	-
updatedAt	string(date-time)	false	The date and time when the organization was most recently updated, in ISO 8601 format with a precision of YYYY-MM-DDThh:mm:ssZ.	-

OrganizationAddress

Name	Type	Required	Description	Accepted Values
postalCode	string	false	The region defined by the postal service for this address.	-
country	string	false	The nation specified for this address.	-
text	string	false	The formatted display text of the address.	-
city	string	false	The city of the address.	-
state	string	false	The state of the address.	-
lines	[string]	false	The street component of the address	-

Alias

Name	Type	Required	Description	Accepted Values
type	string	true	The type of alias. aliasValue is required and must be provided in combination with any aliasType. Organizations can be retrieved by NPI and DEA alias types but cannot be created or updated with those alias types.	DEA, TAX, SOI, NPI, SOGI
value	string	true	The unique ID of the alias.	-
system	string	true	The source of the alias. This is needed because an alias value that is unique within a given system is not guaranteed to be unique across systems.	-

SourceIdentifier

Name	Type	Required	Description	Accepted Values
id	string	true	An ID that uniquely identifies the organization in a data partition.	-
dataPartitionId	string	true	The data partition ID should match the Health Data Intelligence partition ID for the data source.	-

Reference

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the referenced entity.	-

OrganizationPersonnels

Name	Type	Required	Description	Accepted Values
items	[OrganizationPersonnel]	true	An array containing the current page of results.	-
firstLink	string	true	The first page of results.	-
lastLink	string	true	The last page of results.	-
prevLink	string	false	The previous page of results.	-
nextLink	string	false	The next page of results.	-
totalResults	integer(int32)	true	The total number of results for the specified parameters.	-

OrganizationPersonnel

Name	Type	Required	Description	Accepted Values
id	string	false	The ID of the personnel.	-
name	string	false	The name of the personnel.	-

OrganizationOrganizationGroups

Name	Type	Required	Description	Accepted Values
items	[OrganizationOrganizationGroup]	true	An array containing the current page of results.	-
firstLink	string	true	The first page of results.	-
lastLink	string	true	The last page of results.	-
prevLink	string	false	The previous page of results.	-
nextLink	string	false	The next page of results.	-
totalResults	integer(int32)	true	The total number of results for the specified parameters.	-

OrganizationOrganizationGroup

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the organization group.	-
name	string	true	The name of the organization group.	-

OrganizationGroups

Name	Type	Required	Description	Accepted Values
items	[OrganizationGroup]	true	An array containing the current page of results.	-
firstLink	string	true	The first page of results.	-
lastLink	string	true	The last page of results.	-
prevLink	string	false	The previous page of results.	-
nextLink	string	false	The next page of results.	-
totalResults	integer(int32)	true	The total number of results for the specified parameters.	-

OrganizationGroup

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the organization group.	-
name	string	true	The name of the organization group.	-
createdAt	string(date-time)	false	The date and time when the organization group was created, in ISO 8601 format with a precision of YYYY-MM-DDThh:mm:ssZ.	-
updatedAt	string(date-time)	false	The date and time when the organization group was most recently updated, in ISO 8601 format with a precision of YYYY-MM-DDThh:mm:ssZ.	-
aliases	[Alias]	false	The aliases that identify the organization group across systems. SOGIs are the aliases that uniquely define organization groups, and `SOGI` is the only aliasType value that is used for organization groups.	-

OrganizationGroupOrganizations

Name	Type	Required	Description	Accepted Values
items	[OrganizationGroupOrganization]	true	An array containing the current page of results.	-
firstLink	string	true	The first page of results.	-
lastLink	string	true	The last page of results.	-
prevLink	string	false	The previous page of results.	-
nextLink	string	false	The next page of results.	-
totalResults	integer(int32)	true	The total number of results for the specified parameters.	-

OrganizationGroupOrganization

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the organization.	-
name	string	true	The name of the organization.	-

OrganizationDynamicOrganizations

Name	Type	Required	Description	Accepted Values
items	[OrganizationDynamicOrganization]	true	An array containing the current page of results.	-
firstLink	string	true	The first page of results.	-
lastLink	string	true	The last page of results.	-
prevLink	string	false	The previous page of results.	-
nextLink	string	false	The next page of results.	-
totalResults	integer(int32)	true	The total number of results for the specified parameters.	-

OrganizationDynamicOrganization

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the dynamic organization.	-
name	string	true	The name of the dynamic organization.	-

PersonnelOrganizations

Name	Type	Required	Description	Accepted Values
items	[PersonnelOrganization]	true	An array containing the current page of results.	-
firstLink	string	true	The first page of results.	-
lastLink	string	true	The last page of results.	-
prevLink	string	false	The previous page of results.	-
nextLink	string	false	The next page of results.	-
totalResults	integer(int32)	true	The total number of results for the specified parameters.	-

PersonnelOrganization

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the organization.	-
name	string	true	The name of the organization.	-

DynamicOrganizations

Name	Type	Required	Description	Accepted Values
items	[DynamicOrganization]	true	An array containing the current page of results.	-
firstLink	string	true	The first page of results.	-
lastLink	string	true	The last page of results.	-
prevLink	string	false	The previous page of results.	-
nextLink	string	false	The next page of results.	-
totalResults	integer(int32)	true	The total number of results for the specified parameters.	-

DynamicOrganization

Name	Type	Required	Description	Accepted Values
id	string	true	The unique ID of the dynamic organization.	-
name	string	true	The name of the dynamic organization and the resulting organization.	-
aliases	[Alias]	false	The aliases that identify the organization across systems.	-
adminJoinType	string	true	The method by which organization administrators and personnel group members are added.	UNION, INTERSECTION
memberJoinType	string	true	The method by which organization members and personnel group members are added.	UNION, INTERSECTION
organization	Reference	true	The generated organization.	-
createdAt	string(date)	true	The date and time when the dynamic organization was created.	-
updatedAt	string(date)	true	The date and time when the dynamic organization definition was last updated.	-

DynamicOrganizationAdminGroups

Name	Type	Required	Description	Accepted Values
items	[DynamicOrganizationAdminGroup]	true	An array containing the current page of results.	-
firstLink	string	true	The first page of results.	-
lastLink	string	true	The last page of results.	-
prevLink	string	false	The previous page of results.	-
nextLink	string	false	The next page of results.	-
totalResults	integer(int32)	true	The total number of results for the specified parameters.	-

DynamicOrganizationAdminGroup

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the personnel group from which administrator IDs are retrieved.	-
name	string	true	The name of the administrator personnel group.	-

DynamicOrganizationAdminOrganizations

Name	Type	Required	Description	Accepted Values
items	[DynamicOrganizationAdminOrganization]	true	An array containing the current page of results.	-
firstLink	string	true	The first page of results.	-
lastLink	string	true	The last page of results.	-
prevLink	string	false	The previous page of results.	-
nextLink	string	false	The next page of results.	-
totalResults	integer(int32)	true	The total number of results for the specified parameters.	-

DynamicOrganizationAdminOrganization

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the organization from which administrator IDs are retrieved.	-
name	string	true	The name of the administrator organization.	-

DynamicOrganizationMemberGroups

Name	Type	Required	Description	Accepted Values
items	[DynamicOrganizationMemberGroup]	true	An array containing the current page of results.	-
firstLink	string	true	The first page of results.	-
lastLink	string	true	The last page of results.	-
prevLink	string	false	The previous page of results.	-
nextLink	string	false	The next page of results.	-
totalResults	integer(int32)	true	The total number of results for the specified parameters.	-

DynamicOrganizationMemberGroup

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the personnel group from which member IDs are retrieved.	-
name	string	true	The name of the member personnel group.	-

DynamicOrganizationMemberOrganizations

Name	Type	Required	Description	Accepted Values
items	[DynamicOrganizationMemberOrganization]	true	An array containing the current page of results.	-
firstLink	string	true	The first page of results.	-
lastLink	string	true	The last page of results.	-
prevLink	string	false	The previous page of results.	-
nextLink	string	false	The next page of results.	-
totalResults	integer(int32)	true	The total number of results for the specified parameters.	-

DynamicOrganizationMemberOrganization

Name	Type	Required	Description	Accepted Values
id	string	true	The ID of the organization from which member IDs are retrieved.	-
name	string	true	The name of the member organization.	-

Error

Name	Type	Required	Description	Accepted Values
code	integer(int32)	true	The HTTP response status code that represents the error.	-
message	string	true	A human-readable description of the error.	-
errorDetails	[ErrorDetail]	false	A list of additional error details.	-

ErrorDetail

Name	Type	Required	Description	Accepted Values
domain	string	false	A subsystem or context where an error occurred.	-
reason	string	false	A codified value that represents the specific error that caused the current error status.	-
message	string	false	A human-readable description of an error.	-
locationType	string	false	The location or type of the field that caused an error.	query, header, path, formData, body
location	string	false	The name of the field that caused an error.	-

postLocations

Name	Type	Required	Description	Accepted Values
name	string	true	The name of the location.	-
operationalStatus	string	true	The current operational status of the location	ACTIVE, SUSPENDED, INACTIVE
description	string	false	Additional details about the location that can be displayed as further information to identify the location beyond its name	-
managingOrganization	object	false	No description	-
» id	string	true	The unique ID of the organization that is responsible for the provisioning and upkeep of the location.	-
telecoms	[Telecom]	false	Contact details related to the location	-
address	Address	false	The address of the location	-

putLocations

Name	Type	Required	Description	Accepted Values
name	string	true	The name of the location.	-
operationalStatus	string	true	The current operational status of the location	ACTIVE, SUSPENDED, INACTIVE
description	string	false	Additional details about the location that can be displayed as further information to identify the location beyond its name	-
managingOrganization	object	false	No description	-
» id	string	true	The unique ID of the organization that is responsible for the provisioning and upkeep of the location.	-
telecoms	[Telecom]	false	Contact details related to the location	-
address	Address	false	The address of the location	-

postOrganizations

Name	Type	Required	Description	Accepted Values
name	string	true	The name of the organization.	-
coverageAreaPostalCodes	[string]	false	The postal codes indicating the area covered by the organization.	-
telecoms	[Telecom]	false	The contact details of the organization.	-
addresses	[OrganizationAddress]	false	The addresses of the organization.	-
aliases	[Alias]	false	The aliases of the organization across systems.	-
sourceIdentifiers	[SourceIdentifier]	false	The IDs linking the organization to an external source.	-

putOrganizations

Name	Type	Required	Description	Accepted Values
name	string	true	The name of the organization.	-
coverageAreaPostalCodes	[string]	false	The postal codes indicating the area covered by the organization.	-
telecoms	[Telecom]	false	The contact details of the organization.	-
addresses	[OrganizationAddress]	false	The addresses of the organization.	-
aliases	[Alias]	false	The aliases of the organization across systems.	-
sourceIdentifiers	[SourceIdentifier]	false	The IDs linking the organization to an external source.	-

postOrganizationGroups

Name	Type	Required	Description	Accepted Values
name	string	true	The name of the organization group.	-
aliases	[Alias]	false	The aliases of the organization group across systems.	-

putOrganizationGroups

Name	Type	Required	Description	Accepted Values
name	string	true	The name of the organization group.	-
aliases	[Alias]	false	The aliases of the organization group across systems.	-

postDynamicOrganizations

Name	Type	Required	Description	Accepted Values
name	string	true	The name of the dynamic organization and the resulting organization.	-
aliases	[Alias]	false	A list of aliases of the dynamic organization.	-
adminJoinType	string	true	The method by which organization administrators and personnel group members are added to the dynamic organization as administrators.	UNION, INTERSECTION
memberJoinType	string	true	The method by which organization members and personnel group members are added to the dynamic organization as members.	UNION, INTERSECTION

putDynamicOrganizations

Name	Type	Required	Description	Accepted Values
name	string	true	The name of the dynamic organization and the resulting organization.	-
aliases	[Alias]	false	A list of aliases of the dynamic organization.	-
adminJoinType	string	true	The method by which organization administrators and personnel group members are added to the dynamic organization as administrators.	UNION, INTERSECTION
memberJoinType	string	true	The method by which organization members and personnel group members are added to the dynamic organization as members.	UNION, INTERSECTION