NAV
Ruby Shell

Maestro API v1

Maestro combines Cerner and Lumeris technology and services to help health systems manage complex value-based arrangements (including Medicare Advantage and provider-sponsored health plans) to control costs and improve outcomes. This collaboration is designed to reduce complexities, improve clinical and financial outcomes, and mitigate operational risk during the transition to value-based care. Maestro offers technology and services to drive provider engagement, provide care management services, enable risk score accuracy and completeness, execute value-based contracts, and provide additional operational support.

The Maestro API supports the management of providers who participate in the health plan and the data that is used to evaluate individual and organizational performance from a clinical and financial value-based perspective.

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

Hierarchy Organizations

A hierarchy organization is the abstraction for tracking the subset of all the organizations that represent nodes in the defined organization hierarchy.

Retrieve a List of Organization Hierarchy Organizations

Example Request:


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/maestro/v1/hierarchy-organizations', headers: headers)

print JSON.pretty_generate(result)



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

Example response

{
  "items": [
    {
      "id": "g89fa3dd-0000-494b-1111-4640ccc081e3"
    },
    {
      "id": "k89fa3dd-0000-494b-1111-4640dcc081e8"
    }
  ],
  "totalResults": 2,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/maestro/v1/hierarchy-organizations/?offset=0&limit=100",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/maestro/v1/hierarchy-organizations/?offset=0&limit=100"
}

GET /hierarchy-organizations

Retrieves a list of organizations from the organization hierarchy.

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. -

Response Statuses

Status Meaning Description Schema
200 OK A collection of organizations HierarchyOrganizations
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Hierarchy Branch Configurations

A hierarchy branch configuration represents the organized structure of hierarchy levels, relative node positioning, and other related attributes that all branches of a defined hierarchy must follow. As the number and relative names of hierarchy levels can change over time, the configuration represents the structural contract to which all branches for a given period of time align when they are created. This allows for retrospective analytics across different effective periods as well as some level of structural validation at the point when a branch is posted or updated to the service.

Create a Hierarchy Branch Configuration

Example Request:




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/maestro/v1/hierarchy-branch-configurations', headers: headers, body: {"name":"Initial hierarchy branch configuration.","description":"Initial configuration representing the current design and structure of provider hierarchy branches.","designatedPcpLevel":2,"levels":[{"name":"Market","depth":1},{"name":"Physician Group","depth":2},{"name":"Subgroup","depth":3}]}.to_json )

print JSON.pretty_generate(result)





# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/maestro/v1/hierarchy-branch-configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Initial hierarchy branch configuration.","description":"Initial configuration representing the current design and structure of provider hierarchy branches.","designatedPcpLevel":2,"levels":[{"name":"Market","depth":1},{"name":"Physician Group","depth":2},{"name":"Subgroup","depth":3}]}

Example response

{
  "id": "g89fa3dd-0000-494b-1111-4640ccc03333",
  "name": "Hierarchy branch configuration A",
  "description": "Description for hierarchy branch configuration A",
  "designatedPcpLevel": 2,
  "levels": [
    {
      "name": "Market",
      "depth": 1
    },
    {
      "name": "Physician Group",
      "depth": 2
    },
    {
      "name": "Subgroup",
      "depth": 3
    }
  ],
  "createdAt": "2018-09-04T14:10:35.000Z",
  "updatedAt": "2018-09-04T14:10:35.000Z"
}

POST /hierarchy-branch-configurations

Creates a hierarchy branch configuration.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Created BranchConfig
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Response Headers

Status Header Type Format Description
201 Location string The URL of the created hierarchy branch configuration.

Retrieve a List of Hierarchy Branch Configurations

Example Request:


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/maestro/v1/hierarchy-branch-configurations', headers: headers)

print JSON.pretty_generate(result)



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

Example response

{
  "items": [
    {
      "id": "g89fa3dd-0000-494b-1111-4640ccc03333",
      "name": "Hierarchy branch configuration A",
      "description": "Description for hierarchy branch configuration A",
      "designatedPcpLevel": 2,
      "levels": [
        {
          "name": "Market",
          "depth": 1
        },
        {
          "name": "Physician Group",
          "depth": 2
        },
        {
          "name": "Subgroup",
          "depth": 3
        }
      ],
      "updatedAt": "2018-03-02T20:39:35Z",
      "createdAt": "2018-03-02T20:39:35Z"
    },
    {
      "id": "g89fa3dd-0000-494b-1111-4640ccc04444",
      "name": "Hierarchy branch configuration B",
      "designatedPcpLevel": 3,
      "levels": [
        {
          "name": "Payer",
          "depth": 1
        },
        {
          "name": "Market",
          "depth": 2
        },
        {
          "name": "Physician Group",
          "depth": 3
        },
        {
          "name": "Subgroup",
          "depth": 4
        }
      ],
      "updatedAt": "2018-03-02T20:39:35Z",
      "createdAt": "2018-03-02T20:39:35Z"
    }
  ],
  "totalResults": 2,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/maestro/v1/hierarchy-branch-configurations/?offset=0&limit=100",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/maestro/v1/hierarchy-branch-configurations/?offset=0&limit=100"
}

GET /hierarchy-branch-configurations

Retrieves a list of hierarchy branch configurations.

Parameters

Parameter In Type Required Default Description Accepted Values
orderBy query string false -updatedAt A comma-separated list of fields by which to sort. name, -name, updatedAt, -updatedAt
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. -
ids query array[string] false N/A The hierarchy branch configuration ID or IDs to filter by. -
name query string false N/A The name of the hierarchy branch configuration. -
designatedPcpLevel query integer(int32) false N/A The designated primary care physician (PCP) level of the hierarchy branch configuration. -

Response Statuses

Status Meaning Description Schema
200 OK A collection of hierarchy branch configurations BranchConfigs
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Retrieve a Single Hierarchy Branch Configuration

Example Request:


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/maestro/v1/hierarchy-branch-configurations/1424e81d-8cea-4d6b-b140-d6630b684a58', headers: headers)

print JSON.pretty_generate(result)



# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/maestro/v1/hierarchy-branch-configurations/1424e81d-8cea-4d6b-b140-d6630b684a58 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "g89fa3dd-0000-494b-1111-4640ccc03333",
  "name": "Hierarchy branch configuration A",
  "description": "Description for hierarchy branch configuration A",
  "designatedPcpLevel": 2,
  "levels": [
    {
      "name": "Market",
      "depth": 1
    },
    {
      "name": "Physician Group",
      "depth": 2
    },
    {
      "name": "Subgroup",
      "depth": 3
    }
  ],
  "createdAt": "2018-09-04T14:10:35.000Z",
  "updatedAt": "2018-09-04T14:10:35.000Z"
}

GET /hierarchy-branch-configurations/{id}

Retrieves a hierarchy branch configuration by its resource ID.

Parameters

Parameter In Type Required Default Description Accepted Values
id path string true N/A The ID of the hierarchy branch configuration. -

Response Statuses

Status Meaning Description Schema
200 OK A hierarchy branch configuration object BranchConfig
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Update a Hierarchy Branch Configuration

Example Request:




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/maestro/v1/hierarchy-branch-configurations/1424e81d-8cea-4d6b-b140-d6630b684a58', headers: headers, body: {"name":"Initial hierarchy branch configuration.","description":"Initial configuration representing the current design and structure of provider hierarchy branches.","designatedPcpLevel":2,"levels":[{"name":"Market","depth":1},{"name":"Physician Group","depth":2},{"name":"Subgroup","depth":3}]}.to_json )

print JSON.pretty_generate(result)





# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/maestro/v1/hierarchy-branch-configurations/1424e81d-8cea-4d6b-b140-d6630b684a58 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Initial hierarchy branch configuration.","description":"Initial configuration representing the current design and structure of provider hierarchy branches.","designatedPcpLevel":2,"levels":[{"name":"Market","depth":1},{"name":"Physician Group","depth":2},{"name":"Subgroup","depth":3}]}

PUT /hierarchy-branch-configurations/{id}

Updates a hierarchy branch configuration.

Parameters

Parameter In Type Required Default Description Accepted Values
id path string true N/A The ID of the hierarchy branch configuration. -
body body putHierarchyBranchConfigurations true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content No Content None
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Remove a Hierarchy Branch Configuration

Example Request:


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/maestro/v1/hierarchy-branch-configurations/1424e81d-8cea-4d6b-b140-d6630b684a58', headers: headers)

print JSON.pretty_generate(result)



# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/maestro/v1/hierarchy-branch-configurations/1424e81d-8cea-4d6b-b140-d6630b684a58 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /hierarchy-branch-configurations/{id}

Removes a hierarchy branch configuration by its resource ID.

Parameters

Parameter In Type Required Default Description Accepted Values
id path string true N/A The ID of the hierarchy branch configuration. -

Response Statuses

Status Meaning Description Schema
204 No Content No Content None
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Hierarchy Branches

A hierarchy branch defines the set of specific organization nodes and their relative position that describe how these organizations roll up through the configured hierarchy levels. The branch includes a reference to a hierarchy branch configuration, which provides the structure and level naming applicable to the branch. Because the structure of the hierarchy can change over time, a hierarchy branch includes an effective period that indicates the range of time for which the organization relationships are valid. Hierarchy branch nodes at depth 1 are the root. Nodes at a higher depth are leaf nodes.

Create a Hierarchy Branch

Example Request:




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/maestro/v1/hierarchy-branches', headers: headers, body: {"name":"Initial hierarchy branch","status":"ACTIVE","effectivePeriod":{"start":"2018-02-20","end":"2019-02-21"},"branchConfiguration":{"id":"1234a0b6e3d9e4b7bae9bd3b7d82a965"},"nodes":[{"depth":1,"organization":{"id":"aaad37ee-09d2-11e8-9dc2-587234aecbf0"}},{"depth":2,"organization":{"id":"bbbd37ee-09d2-11e8-9dc2-587234aecbf0"}}]}.to_json )

print JSON.pretty_generate(result)





# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/maestro/v1/hierarchy-branches \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Initial hierarchy branch","status":"ACTIVE","effectivePeriod":{"start":"2018-02-20","end":"2019-02-21"},"branchConfiguration":{"id":"1234a0b6e3d9e4b7bae9bd3b7d82a965"},"nodes":[{"depth":1,"organization":{"id":"aaad37ee-09d2-11e8-9dc2-587234aecbf0"}},{"depth":2,"organization":{"id":"bbbd37ee-09d2-11e8-9dc2-587234aecbf0"}}]}

POST /hierarchy-branches

Creates a hierarchy branch.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Created HierarchyBranch
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
503 Service Unavailable Service Unavailable Error

Response Headers

Status Header Type Format Description
201 Location string The URL of the created hierarchy branch.

Retrieve a List of Hierarchy Branches

Example Request:


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/maestro/v1/hierarchy-branches', headers: headers)

print JSON.pretty_generate(result)



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

Example response

{
  "items": [
    {
      "id": "11e8a0b6e3d9e4b7bae9bd3b7d82a964",
      "name": "mybranch",
      "branchConfiguration": {
        "id": "1234a0b6e3d9e4b7bae9bd3b7d82a964"
      },
      "effectivePeriod": {
        "start": "2018-02-20",
        "end": "2019-02-21"
      },
      "nodes": [
        {
          "depth": 1,
          "organization": {
            "id": "aaad37ee-09d2-11e8-9dc2-587234aecbf0"
          }
        },
        {
          "depth": 2,
          "organization": {
            "id": "bbbd37ee-09d2-11e8-9dc2-587234aecbf0"
          }
        }
      ],
      "status": "ACTIVE",
      "updatedAt": "2018-03-02T20:39:35Z",
      "createdAt": "2018-03-02T20:39:35Z"
    },
    {
      "id": "11e8a0b6e3d9e4b7bae9bd3b7d82a965",
      "name": "mybranch2",
      "branchConfiguration": {
        "id": "1234a0b6e3d9e4b7bae9bd3b7d82a965"
      },
      "effectivePeriod": {
        "start": "2018-02-20",
        "end": "2019-02-21"
      },
      "nodes": [
        {
          "depth": 1,
          "organization": {
            "id": "aaad37ee-09d2-11e8-9dc2-587234aecbf1"
          }
        },
        {
          "depth": 2,
          "organization": {
            "id": "bbbd37ee-09d2-11e8-9dc2-587234aecbf2"
          }
        }
      ],
      "status": "ACTIVE",
      "updatedAt": "2018-03-02T20:39:35Z",
      "createdAt": "2018-03-02T20:39:35Z"
    }
  ],
  "totalResults": 2,
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/maestro/v1/hierarchy-branches/?offset=0&limit=100",
  "lastLink": "https://cernerdemo.api.us.healtheintent.com/maestro/v1/hierarchy-branches/?offset=0&limit=100"
}

GET /hierarchy-branches

Retrieves a list of hierarchy branches.

Parameters

Parameter In Type Required Default Description Accepted Values
orderBy query string false -updatedAt A comma-separated list of fields by which to sort. name, -name, updatedAt, -updatedAt
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. -
ids query array[string] false N/A The hierarchy branch ID or IDs to filter by. -
name query string false N/A The name of the hierarchy branch. -
effectiveDate query string false N/A The date the hierarchy branch is effective on. -
status query string false N/A The status of the hierarchy branch. ACTIVE, INACTIVE
branchConfigurationId query string false N/A The branch configuration ID. -
organizationIds query array[string] false N/A The organization ID or IDs to filter by. -

Response Statuses

Status Meaning Description Schema
200 OK A collection of hierarchy branches HierarchyBranches
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Retrieve a Single Hierarchy Branch

Example Request:


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/maestro/v1/hierarchy-branches/1424e81d-8cea-4d6b-b140-d6630b684a58', headers: headers)

print JSON.pretty_generate(result)



# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/maestro/v1/hierarchy-branches/1424e81d-8cea-4d6b-b140-d6630b684a58 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "11e8a0b6e3d9e4b7bae9bd3b7d82a964",
  "name": "mybranch",
  "branchConfiguration": {
    "id": "1234a0b6e3d9e4b7bae9bd3b7d82a964"
  },
  "effectivePeriod": {
    "start": "2018-02-20",
    "end": "2019-02-21"
  },
  "nodes": [
    {
      "depth": 1,
      "organization": {
        "id": "aaad37ee-09d2-11e8-9dc2-587234aecbf0"
      }
    },
    {
      "depth": 2,
      "organization": {
        "id": "bbbd37ee-09d2-11e8-9dc2-587234aecbf0"
      }
    }
  ],
  "status": "ACTIVE",
  "updatedAt": "2018-03-02T20:39:35Z",
  "createdAt": "2018-03-02T20:39:35Z"
}

GET /hierarchy-branches/{id}

Retrieves a hierarchy branch by its resource ID.

Parameters

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

Response Statuses

Status Meaning Description Schema
200 OK A hierarchy branch object HierarchyBranch
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Update a Hierarchy Branch

Example Request:




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/maestro/v1/hierarchy-branches/1424e81d-8cea-4d6b-b140-d6630b684a58', headers: headers, body: {"name":"Initial hierarchy branch","status":"ACTIVE","effectivePeriod":{"start":"2018-02-20","end":"2019-02-21"},"branchConfiguration":{"id":"1234a0b6e3d9e4b7bae9bd3b7d82a965"},"nodes":[{"depth":1,"organization":{"id":"aaad37ee-09d2-11e8-9dc2-587234aecbf0"}},{"depth":2,"organization":{"id":"bbbd37ee-09d2-11e8-9dc2-587234aecbf0"}}]}.to_json )

print JSON.pretty_generate(result)





# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/maestro/v1/hierarchy-branches/1424e81d-8cea-4d6b-b140-d6630b684a58 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Initial hierarchy branch","status":"ACTIVE","effectivePeriod":{"start":"2018-02-20","end":"2019-02-21"},"branchConfiguration":{"id":"1234a0b6e3d9e4b7bae9bd3b7d82a965"},"nodes":[{"depth":1,"organization":{"id":"aaad37ee-09d2-11e8-9dc2-587234aecbf0"}},{"depth":2,"organization":{"id":"bbbd37ee-09d2-11e8-9dc2-587234aecbf0"}}]}

PUT /hierarchy-branches/{id}

Updates a hierarchy branch.

Parameters

Parameter In Type Required Default Description Accepted Values
id path string true N/A The ID of the hierarchy branch. -
body body putHierarchyBranches true N/A No description -

Response Statuses

Status Meaning Description Schema
204 No Content No Content None
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Remove a Hierarchy Branch

Example Request:


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/maestro/v1/hierarchy-branches/1424e81d-8cea-4d6b-b140-d6630b684a58', headers: headers)

print JSON.pretty_generate(result)



# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/maestro/v1/hierarchy-branches/1424e81d-8cea-4d6b-b140-d6630b684a58 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /hierarchy-branches/{id}

Removes a hierarchy branch by its resource ID.

Parameters

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

Response Statuses

Status Meaning Description Schema
204 No Content No Content None
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Schema Definitions

HierarchyOrganizations

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

HierarchyOrganization

Name Type Required Description Accepted Values
items [Organization] false Hierarchy Organizations -

Organization

Name Type Required Description Accepted Values
id string true The unique ID of the 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. -

postHierarchyBranchConfigurations

Name Type Required Description Accepted Values
name string true The name of the hierarchy branch configuration. -
description string false The description of the hierarchy branch configuration. -
designatedPcpLevel string false An integer designating the depth of a level that is the configured primary care provider (PCP) level for a given organization hierarchy. This means that patient encounters with providers who share this hierarchy organization with the patient’s attributed PCP can also be considered as PCP encounters based on the shared parent hierarchy level. -
levels [object] true The levels associated with the hierarchy branch configuration. -
» name string true The name of the hierarchy level. -
» depth integer(int32) true A numeric value representing the depth of a level in an organization hierarchy branch. -

BranchConfig

Name Type Required Description Accepted Values
id string true The unique ID of the hierarchy branch configuration. -
name string true The name of the hierarchy branch configuration. -
description string false The description of the hierarchy branch configuration. -
designatedPcpLevel integer(int32) false An integer designating the depth of a level that is the configured PCP level for a given organization hierarchy. This means that patient encounters with providers who share this hierarchy organization with the patient’s attributed PCP can also be considered as PCP encounters based on the shared parent hierarchy level. -
levels Level true The levels associated with the hierarchy branch configuration. -
createdAt string false The date and time the hierarchy branch configuration was created. -
updatedAt string false The date and time the hierarchy branch configuration was last updated. -

Level

Name Type Required Description Accepted Values
name string true The name of the hierarchy level. -
depth integer(int32) true A numeric value representing the depth of a level in an organization hierarchy branch. -

BranchConfigs

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

putHierarchyBranchConfigurations

Name Type Required Description Accepted Values
name string true The name of the hierarchy branch configuration. -
description string false The description of the hierarchy branch configuration. -
designatedPcpLevel string false An integer designating the depth of a level that is the configured primary care provider (PCP) level for a given organization hierarchy. This means that patient encounters with providers who share this hierarchy organization with the patient’s attributed PCP can also be considered as PCP encounters based on the shared parent hierarchy level. -
levels [object] true The levels associated with the hierarchy branch configuration. -
» name string true The name of the hierarchy level. -
» depth integer(int32) true A numeric value representing the depth of a level in an organization hierarchy branch. -

postHierarchyBranches

Name Type Required Description Accepted Values
name string true The name of the hierarchy branch. -
status string true The status of the hierarchy branch. ACTIVE, INACTIVE
effectivePeriod object false The effective period of the hierarchy branch. -
» start string true The start of the effective period. -
» end string false The end of the effective period. -
branchConfiguration object true The branch configuration that is being used to describe the hierarchy branch. -
» id string true The ID of the branch configuration. -
nodes [object] true The nodes associated with the hierarchy branch. -
» depth integer(int32) true A numeric value representing the depth of the node in a hierarchy branch. -
» organization object true The organization that the node represents. -
»» id string true The unique ID of the organization. -

HierarchyBranch

Name Type Required Description Accepted Values
id string true The unique ID of the hierarchy branch. -
name string true The name of the hierarchy branch. -
branchConfiguration Configuration true The branch configuration that is being used to describe the hierarchy branch. -
effectivePeriod EffectivePeriod false The effective period of the hierarchy branch. -
nodes Node true The nodes associated with the hierarchy branch. -
status string true The status of the hierarchy branch. ACTIVE, INACTIVE
updatedAt string true The hierarchy branch updated time. -
createdAt string true The hierarchy branch created time. -

Configuration

Name Type Required Description Accepted Values
id string true The ID of the hierarchy branch configuration. -

EffectivePeriod

Name Type Required Description Accepted Values
start string(date-time) true The start date of the period. In International Organization for Standardization (ISO) 8601 formatting with precision ranging from YYYY to YYYY-MM-DDThh:mm:ss.SSSZ. -
end string(date-time) false The end date of the period. In ISO 8601 formatting with precision ranging from YYYY to YYYY-MM-DDThh:mm:ss.SSSZ. -

Node

Name Type Required Description Accepted Values
depth integer(int32) true A numeric value representing the depth of the node in a hierarchy branch. -
organization Organization true The organization that the node represents. -

HierarchyBranches

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

putHierarchyBranches

Name Type Required Description Accepted Values
name string true The name of the hierarchy branch. -
status string true The status of the hierarchy branch. ACTIVE, INACTIVE
effectivePeriod object false The effective period of the hierarchy branch. -
» start string true The start of the effective period. -
» end string false The end of the effective period. -
branchConfiguration object true The branch configuration that is being used to describe the hierarchy branch. -
» id string true The ID of the branch configuration. -
nodes [object] true The nodes associated with the hierarchy branch. -
» depth integer(int32) true A numeric value representing the depth of the node in a hierarchy branch. -
» organization object true The organization that the node represents. -
»» id string true The unique ID of the organization. -
Ruby Shell