NAV
Ruby Shell

Specialty API v1

The Specialty API enables systems to interact with and define the specialties and taxonomies of specialties that service providers can practice in a health care system. The Specialty API is especially useful for referral management, orders processing, and scheduling systems.

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

Specialties

A specialty is a specialized medical practice offered by a clinician or provider based on their training or clinical focus. See the following examples:

Create a Specialty

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/specialty/v1/specialties', headers: headers, body: {"name":"Allergy & Immunology","description":"An allergist-immunologist is trained in the evaluation, physical and laboratory diagnosis, and management of disorders involving the immune system","taxonomy":{"id":"cc46c4c2deac11e7a3d646705f8c9e77"},"status":"ACTIVE","aliases":[{"system":"CMS","value":"03"},{"system":"NUCC","value":"207K00000X"}],"createdBy":{"id":"11e91f884c18d5d4805aeb96e2647bb9"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/specialty/v1/specialties \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Allergy & Immunology","description":"An allergist-immunologist is trained in the evaluation, physical and laboratory diagnosis, and management of disorders involving the immune system","taxonomy":{"id":"cc46c4c2deac11e7a3d646705f8c9e77"},"status":"ACTIVE","aliases":[{"system":"CMS","value":"03"},{"system":"NUCC","value":"207K00000X"}],"createdBy":{"id":"11e91f884c18d5d4805aeb96e2647bb9"}}

POST /specialties

Creates a specialty.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Created None
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
409 Conflict Conflict Error

Response Headers

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

Retrieve a List of Specialties

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/specialty/v1/specialties', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "items": [
    {
      "id": "92dfef3035df11e8bb469f2d0284914c",
      "name": "Allergy & Immunology",
      "description": "An allergist-immunologist is trained in the evaluation, physical and laboratory diagnosis, and management of disorders involving the immune system.",
      "children": [
        {
          "id": "92dfef3135df11e8bb469f2d0284914c",
          "name": "Allergy"
        },
        {
          "id": "ff647c8e35e411e8bb469f2d0284914c",
          "name": "Clinical & Laboratory Immunology"
        }
      ],
      "taxonomy": {
        "id": "2d33c102f21e11e7a3d646705f8c9e77",
        "name": "NUCC Taxonomy"
      },
      "status": "ACTIVE",
      "createdBy": {
        "id": "11eb7db03c768b35b94afb16b9681d89"
      },
      "updatedBy": {
        "id": "11eb7db03c768b35b94afb16b9681d89"
      },
      "updatedAt": "2018-04-21T16:14:53Z",
      "createdAt": "2018-04-21T16:14:53Z"
    },
    {
      "id": "ff647cb635e411e8bb469f2d0284914c",
      "name": "Family Medicine",
      "description": "Family Medicine is the medical specialty that is concerned with the total health care of the individual and the family. It integrates the biological, clinical, and behavioral sciences and is not limited by age, sex, organ system, or disease.",
      "taxonomy": {
        "id": "2d33c102f21e11e7a3d646705f8c9e77",
        "name": "NUCC Taxonomy"
      },
      "status": "ACTIVE",
      "aliases": [
        {
          "system": "NUCC",
          "value": "207Q00000X"
        }
      ],
      "updatedAt": "2018-04-21T16:14:53Z",
      "createdAt": "2018-04-21T16:14:53Z",
      "createdBy": {
        "id": "11eb7db03c768b35b94afb16b9681d89"
      },
      "updatedBy": {
        "id": "11eb7db03c768b35b94afb16b9681d89"
      }
    },
    {
      "id": "ff647cb635e411e8bb469f2d0284914c",
      "name": "Neurocritical Care",
      "description": "The subspecialty of Neurocritical Care is devoted to the comprehensive, multisystem care of critically ill neurological patients. Like other intensivists, a neurointensivist generally assumes the primary role of coordinating the neurological and medical care of their patients in the ICU. They may also provide consultative services for these patients as requested in the health system.",
      "parent": {
        "id": "ff647cc035e411e8bb469f2d0284914c",
        "name": "Neurology"
      },
      "taxonomy": {
        "id": "92dfef1235df11e8bb469f2d0284914c",
        "name": "NUCC Taxonomy"
      },
      "status": "ACTIVE",
      "aliases": [
        {
          "system": "NUCC",
          "value": "2084A2900X"
        },
        {
          "system": "CMS",
          "value": "13"
        }
      ],
      "updatedAt": "2018-04-21T16:14:53Z",
      "createdAt": "2018-04-21T16:14:53Z",
      "createdBy": {
        "id": "11eb7db03c768b35b94afb16b9681d89"
      },
      "updatedBy": {
        "id": "11eb7db03c768b35b94afb16b9681d89"
      }
    }
  ],
  "totalResults": 2,
  "firstLink": "http://cernerdemo.api.us.healtheintent.com/specialty/v1/specialties?offset=0&limit=20",
  "lastLink": "http://cernerdemo.api.us.healtheintent.com/specialty/v1/specialties?offset=0&limit=20"
}

GET /specialties

Retrieves a list of specialties.

Parameters

Parameter In Type Required Default Description Accepted Values
ids query array[string] false N/A Filters by specialty IDs. If you specify this parameter, the API ignores the other parameters. You can specify a maximum of 100 IDs. -
name query string false N/A The name or partial name of the specialty. -
parentId query string false N/A The ID of the parent of the specialty. -
status query string false N/A The status of the specialty. ACTIVE, INACTIVE
taxonomyId query string false N/A The ID of the taxonomy of the specialty. -
aliasSystem query string false N/A The authority responsible for assigning the specialty ID. If aliasSystem is specified, aliasValue is required. -
aliasValue query string false N/A The value or ID of the specialty in the context of the assigning authority. If aliasValue is specified, aliasSystem is required. -
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 Sorts results by a given value in ascending or descending alphabetic order; to specify descending, prefix the value with a hyphen (-). name, -name, updatedAt, -updatedAt

Response Statuses

Status Meaning Description Schema
200 OK Collection of Specialty objects Specialties
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Remove a Specialty

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/specialty/v1/specialties/f9ed82acf21c11e7a3d646705f8c9e77', headers: headers)

print JSON.pretty_generate(result)


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

DELETE /specialties/{specialtyId}

Removes a specialty by ID.

Parameters

Parameter In Type Required Default Description Accepted Values
specialtyId path string 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

Update a Specialty

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/specialty/v1/specialties/f9ed82acf21c11e7a3d646705f8c9e77', headers: headers, body: {"name":"Allergy & Immunology","description":"An allergist-immunologist is trained in the evaluation, physical and laboratory diagnosis, and management of disorders involving the immune system","status":"ACTIVE","aliases":[{"system":"CMS","value":"03"},{"system":"NUCC","value":"207K00000X"}],"updatedBy":{"id":"11e91f884c18d5d4805aeb96e2647bb9"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/specialty/v1/specialties/f9ed82acf21c11e7a3d646705f8c9e77 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Allergy & Immunology","description":"An allergist-immunologist is trained in the evaluation, physical and laboratory diagnosis, and management of disorders involving the immune system","status":"ACTIVE","aliases":[{"system":"CMS","value":"03"},{"system":"NUCC","value":"207K00000X"}],"updatedBy":{"id":"11e91f884c18d5d4805aeb96e2647bb9"}}

PUT /specialties/{specialtyId}

Updates a specialty.

Parameters

Parameter In Type Required Default Description Accepted Values
specialtyId path string true N/A No description -
body body putSpecialties 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
409 Conflict Conflict Error

Retrieve a Single Specialty

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/specialty/v1/specialties/f9ed82acf21c11e7a3d646705f8c9e77', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "id": "f9ed82acf21c11e7a3d646705f8c9e77",
  "name": "Allergy & Immunology",
  "description": "An allergist-immunologist is trained in the evaluation, physical and laboratory diagnosis, and management of disorders involving the immune system.",
  "parent": {
    "id": "11e85d0cc3f0f83c9d27b1575fbb44c4",
    "name": "Asthma, Allergy & Immunology"
  },
  "children": [
    {
      "id": "92dfef3135df11e8bb469f2d0284914c",
      "name": "Allergy"
    },
    {
      "id": "ff647c8e35e411e8bb469f2d0284914c",
      "name": "Clinical & Laboratory Immunology"
    }
  ],
  "taxonomy": {
    "id": "cc46c4c2deac11e7a3d646705f8c9e77",
    "name": "CMS Taxonomy"
  },
  "aliases": [
    {
      "system": "CMS",
      "value": "03"
    },
    {
      "system": "NUCC",
      "value": "207K00000X"
    }
  ],
  "createdAt": "2018-04-21T16:14:53Z",
  "updatedAt": "2018-04-21T16:14:53Z",
  "createdBy": {
    "id": "0205CF25-7F14-484B-A598-471BCA84A9BE"
  },
  "updatedBy": {
    "id": "0205CF25-7F14-484B-A598-471BCA84A9BE"
  }
}

GET /specialties/{specialtyId}

Retrieves a single specialty by ID.

Parameters

Parameter In Type Required Default Description Accepted Values
specialtyId path string true N/A No description -

Response Statuses

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

Taxonomies

Taxonomies are hierarchies of specialties and subspecialties that provide context for a curated list of specialties and can be associated with health care services and providers in HealtheIntent. Taxonomies are derived from the Centers for Medicare & Medicaid Services (CMS) Healthcare Provider Taxonomy Code Set. See the following examples:

Create a Taxonomy

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/specialty/v1/taxonomies', headers: headers, body: {"name":"CMS Taxonomy","description":"CMS Healthcare Provider Taxonomy Code Set","version":"20.1","createdBy":{"id":"11e91f884c18d5d4805aeb96e2647bb9"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/specialty/v1/taxonomies \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"CMS Taxonomy","description":"CMS Healthcare Provider Taxonomy Code Set","version":"20.1","createdBy":{"id":"11e91f884c18d5d4805aeb96e2647bb9"}}

POST /taxonomies

Creates a taxonomy.

Parameters

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

Response Statuses

Status Meaning Description Schema
201 Created Created None
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
409 Conflict Conflict Error

Response Headers

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

Retrieve a List of Taxonomies

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/specialty/v1/taxonomies', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "items": [
    {
      "id": "cc46c4c2deac11e7a3d646705f8c9e77",
      "name": "CMS Taxonomy",
      "description": "CMS Health Care Provider Taxonomy Code Set",
      "version": "20.1",
      "createdAt": "2018-04-21T16:14:53Z",
      "updatedAt": "2018-04-21T16:14:53Z",
      "createdBy": {
        "id": "11eb7db03c768b35b94afb16b9681d89"
      },
      "updatedBy": {
        "id": "11eb7db03c768b35b94afb16b9681d89"
      }
    },
    {
      "id": "533cfba4dead11e7a3d646705f8c9e77",
      "name": "NUCC Taxonomy",
      "description": "NUCC Health Care Provider Taxonomy",
      "version": "20.1",
      "createdAt": "2018-04-21T16:14:53Z",
      "updatedAt": "2018-04-21T16:14:53Z",
      "createdBy": {
        "id": "11eb7db03c768b35b94afb16b9681d89"
      },
      "updatedBy": {
        "id": "11eb7db03c768b35b94afb16b9681d89"
      }
    }
  ],
  "totalResults": 2,
  "firstLink": "http://cernerdemo.api.us.healtheintent.com/specialty/v1/taxonomies?offset=0&limit=20",
  "lastLink": "http://cernerdemo.api.us.healtheintent.com/specialty/v1/taxonomies?offset=0&limit=20"
}

GET /taxonomies

Retrieves a list of taxonomies.

Parameters

Parameter In Type Required Default Description Accepted Values
ids query array[string] false N/A Filters by taxonomy IDs. If you specify this parameter, the API ignores the other parameters. You can specify a maximum of 100 IDs. -
name query string false N/A The name of the taxonomy. You can filter by a partial match. -
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 Sorts results by a given value in ascending or descending alphabetic order; to specify descending, prefix the value with a hyphen (-). name, -name, updatedAt, -updatedAt

Response Statuses

Status Meaning Description Schema
200 OK Collection of Taxonomy objects Taxonomies
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Remove a Taxonomy

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/specialty/v1/taxonomies/cc46c4c2deac11e7a3d646705f8c9e77', headers: headers)

print JSON.pretty_generate(result)


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

DELETE /taxonomies/{taxonomyId}

Removes a taxonomy by ID.

Parameters

Parameter In Type Required Default Description Accepted Values
taxonomyId path string 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

Update a Taxonomy

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/specialty/v1/taxonomies/cc46c4c2deac11e7a3d646705f8c9e77', headers: headers, body: {"name":"CMS Taxonomy","description":"CMS Healthcare Provider Taxonomy Code Set","version":"20.1","updatedBy":{"id":"11e91f884c18d5d4805aeb96e2647bb9"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/specialty/v1/taxonomies/cc46c4c2deac11e7a3d646705f8c9e77 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"CMS Taxonomy","description":"CMS Healthcare Provider Taxonomy Code Set","version":"20.1","updatedBy":{"id":"11e91f884c18d5d4805aeb96e2647bb9"}}

PUT /taxonomies/{taxonomyId}

Updates a taxonomy.

Parameters

Parameter In Type Required Default Description Accepted Values
taxonomyId path string true N/A No description -
body body putTaxonomies 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
409 Conflict Conflict Error

Retrieve a Single Taxonomy

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/specialty/v1/taxonomies/cc46c4c2deac11e7a3d646705f8c9e77', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "id": "cc46c4c2deac11e7a3d646705f8c9e77",
  "name": "CMS Taxonomy",
  "description": "CMS Healthcare Provider Taxonomy Code Set",
  "version": "20.1",
  "createdAt": "2018-04-21T16:14:53Z",
  "updatedAt": "2018-04-21T16:14:53Z",
  "createdBy": {
    "id": "0205CF25-7F14-484B-A598-471BCA84A9BE"
  },
  "updatedBy": {
    "id": "0205CF25-7F14-484B-A598-471BCA84A9BE"
  }
}

GET /taxonomies/{taxonomyId}

Retrieves a single taxonomy by ID.

Parameters

Parameter In Type Required Default Description Accepted Values
taxonomyId path string true N/A No description -

Response Statuses

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

Standard Taxonomies

Standard taxonomy is an industry standard definition that is officially maintained and managed by an external governance body. These definitions are available as reference data for all HealtheIntent tenants. This standard content is available in a read-only format until it is copied to a tenant instance. The copy endpoints enable you to easily establish the references to the standard specialties when creating the tenant-specific specialties.

Retrieve a List of Standard Taxonomies

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/specialty/v1/standard-taxonomies', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "items": [
    {
      "id": "cc46c4c2deac11e7a3d646705f8c9e77",
      "name": "CMS Taxonomy",
      "description": "CMS Health Care Provider Taxonomy Code Set",
      "version": "20.1",
      "createdAt": "2018-04-21T16:14:53Z",
      "updatedAt": "2018-04-21T16:14:53Z"
    },
    {
      "id": "533cfba4dead11e7a3d646705f8c9e78",
      "name": "NUCC Taxonomy",
      "description": "NUCC Health Care Provider Taxonomy",
      "version": "20.1",
      "createdAt": "2018-04-21T16:14:53Z",
      "updatedAt": "2018-04-21T16:14:53Z"
    }
  ],
  "totalResults": 2,
  "firstLink": "http://cernerdemo.api.us.healtheintent.com/specialty/v1/standard-taxonomies?offset=0&limit=20",
  "lastLink": "http://cernerdemo.api.us.healtheintent.com/specialty/v1/standard-taxonomies?offset=0&limit=20"
}

GET /standard-taxonomies

Retrieves a list of standard taxonomies.

Parameters

Parameter In Type Required Default Description Accepted Values
ids query array[string] false N/A Filters by taxonomy IDs. If you specify this parameter, the API ignores the other parameters. You can specify a maximum of 100 IDs. -
name query string false N/A The name of the taxonomy. You can filter by a partial match. -
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 Sorts results by a given value in ascending or descending alphabetic order. To sort results in descending order, prefix the value with a hyphen (-). name, -name, updatedAt, -updatedAt

Response Statuses

Status Meaning Description Schema
200 OK Collection of standard taxonomy objects StandardTaxonomies
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Retrieve a Single Standard Taxonomy

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/specialty/v1/standard-taxonomies/cc46c4c2deac11e7a3d646705f8c9e77', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "id": "cc46c4c2deac11e7a3d646705f8c9e77",
  "name": "CMS Taxonomy",
  "description": "CMS Healthcare Provider Taxonomy Code Set",
  "version": "20.1",
  "createdAt": "2018-04-21T16:14:53Z",
  "updatedAt": "2018-04-21T16:14:53Z"
}

GET /standard-taxonomies/{taxonomyId}

Retrieves a single standard taxonomy by its ID.

Parameters

Parameter In Type Required Default Description Accepted Values
taxonomyId path string true N/A No description -

Response Statuses

Status Meaning Description Schema
200 OK A standard taxonomy object StandardTaxonomy
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Copy a Standard Taxonomy

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/specialty/v1/standard-taxonomies/{taxonomyId}/actions/copy', headers: headers, body: {"name":"BHN Quality Taxonomy - Production","description":"BHN Quality Healthcare Provider Taxonomy Code Set - Production","version":"20.1","includeSpecialties":[{"id":"de46c4c2deace1e7a3d246705e8c9e74","alias":{"system":"NUCC","value":"207Q00000X"}}],"excludeSpecialties":[],"retainHierarchy":"true","createdBy":{"id":"11e91f884c18d5d4805aeb96e2647bb9"}}.to_json )

print JSON.pretty_generate(result)




# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/specialty/v1/standard-taxonomies/{taxonomyId}/actions/copy \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"BHN Quality Taxonomy - Production","description":"BHN Quality Healthcare Provider Taxonomy Code Set - Production","version":"20.1","includeSpecialties":[{"id":"de46c4c2deace1e7a3d246705e8c9e74","alias":{"system":"NUCC","value":"207Q00000X"}}],"excludeSpecialties":[],"retainHierarchy":"true","createdBy":{"id":"11e91f884c18d5d4805aeb96e2647bb9"}}

Example response

{
  "items": [
    {
      "id": "92dfef3035df11e8bb469f2d0284914c",
      "name": "Allergy & Immunology",
      "description": "An allergist-immunologist is trained in the evaluation, physical and laboratory diagnosis, and management of disorders involving the immune system.",
      "children": [
        {
          "id": "92dfef3135df11e8bb469f2d02849141",
          "name": "Allergy",
          "description": "An allergist trained in the immune system reacts abnormally to a foreign substance.",
          "children": [
            {
              "id": "92dfef3135df11e8bb469f2d02849142",
              "name": "Asthma",
              "description": "An allergist trained in the immune system reacts abnormally to a foreign substance that is related to Asthma.",
              "status": "ACTIVE",
              "updatedAt": "2018-04-21T16:14:53Z",
              "createdAt": "2018-04-21T16:14:53Z",
              "createdBy": {
                "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
              },
              "updatedBy": {
                "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
              }
            }
          ],
          "aliases": [
            {
              "system": "NUCC",
              "value": "207KA0200X"
            }
          ],
          "status": "ACTIVE",
          "updatedAt": "2018-04-21T16:14:53Z",
          "createdAt": "2018-04-21T16:14:53Z",
          "createdBy": {
            "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
          },
          "updatedBy": {
            "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
          }
        },
        {
          "id": "ff647c8e35e411e8bb469f2d02849143",
          "name": "Clinical & Laboratory Immunology",
          "status": "ACTIVE",
          "aliases": [
            {
              "system": "NUCC",
              "value": "207KI0005X"
            }
          ],
          "updatedAt": "2018-04-21T16:14:53Z",
          "createdAt": "2018-04-21T16:14:53Z",
          "createdBy": {
            "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
          },
          "updatedBy": {
            "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
          }
        }
      ],
      "taxonomy": {
        "id": "2d33c102f21e11e7a3d646705f8c9e71",
        "name": "Memorial Health Specialty Taxonomy"
      },
      "status": "ACTIVE",
      "aliases": [
        {
          "system": "NUCC",
          "value": "207K00000X"
        }
      ],
      "updatedAt": "2018-04-21T16:14:53Z",
      "createdAt": "2018-04-21T16:14:53Z",
      "createdBy": {
        "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
      },
      "updatedBy": {
        "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
      }
    },
    {
      "id": "ff647cb635e411e8bb469f2d0284914c",
      "name": "Family Medicine",
      "description": "Family Medicine is the medical specialty that is concerned with the total health care of the individual and the family. It integrates the biological, clinical, and behavioral sciences and is not limited by age, sex, organ system, or disease.",
      "taxonomy": {
        "id": "2d33c102f21e11e7a3d646705f8c9e71",
        "name": "Memorial Health Specialty Taxonomy"
      },
      "status": "ACTIVE",
      "aliases": [
        {
          "system": "NUCC",
          "value": "207Q00000X"
        }
      ],
      "updatedAt": "2018-04-21T16:14:53Z",
      "createdAt": "2018-04-21T16:14:53Z",
      "createdBy": {
        "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
      },
      "updatedBy": {
        "id": "f89fa3dd-57a8-494b-b157-4640ccc081e3"
      }
    }
  ]
}

POST /standard-taxonomies/{taxonomyId}/actions/copy

Copies a standard taxonomy definition to a tenant-specific definition. This copies the taxonomy along with all the specialties that belong to that taxonomy. If the specialties included in the list break the standard hierarchy tree structure, they are treated as independent specialties and represented outside of the hierarchy group.

Parameters

Parameter In Type Required Default Description Accepted Values
taxonomyId path string true N/A No description -
body body postStandardTaxonomiesTaxonomyidActionsCopy true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created Created HierarchySpecialtyList
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
409 Conflict Conflict Error

Response Headers

Status Header Type Format Description
201 Location string The URL of the new tenant-scoped standard taxonomy.

Hierarchy Specialties

Hierarchy specialties support the implementation of navigational and related workflows where it is necessary to understand the hierarchical relationships between specialties and subspecialties.

Retrieve a List of Hierarchy Specialties

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

print JSON.pretty_generate(result)


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

Example response

{
  "items": [
    {
      "id": "92dfef3035df11e8bb469f2d0284914c",
      "name": "Allergy & Immunology",
      "description": "An allergist-immunologist is trained in the evaluation, physical and laboratory diagnosis, and management of disorders involving the immune system.",
      "children": [
        {
          "id": "92dfef3135df11e8bb469f2d02849141",
          "name": "Allergy",
          "description": "An allergist trained in the immune system reacts abnormally to a foreign substance.",
          "children": [
            {
              "id": "92dfef3135df11e8bb469f2d02849142",
              "name": "Asthma",
              "description": "An allergist trained in the immune system reacts abnormally to a foreign substance that is related to Asthma.",
              "status": "ACTIVE",
              "updatedAt": "2018-04-21T16:14:53Z",
              "createdAt": "2018-04-21T16:14:53Z",
              "createdBy": {
                "id": "11eb7db03c768b35b94afb16b9681d89"
              },
              "updatedBy": {
                "id": "11eb7db03c768b35b94afb16b9681d89"
              }
            }
          ],
          "aliases": [
            {
              "system": "NUCC",
              "value": "207KA0200X"
            }
          ],
          "status": "ACTIVE",
          "updatedAt": "2018-04-21T16:14:53Z",
          "createdAt": "2018-04-21T16:14:53Z",
          "createdBy": {
            "id": "11eb7db03c768b35b94afb16b9681d89"
          },
          "updatedBy": {
            "id": "11eb7db03c768b35b94afb16b9681d89"
          }
        },
        {
          "id": "ff647c8e35e411e8bb469f2d02849143",
          "name": "Clinical & Laboratory Immunology",
          "status": "ACTIVE",
          "aliases": [
            {
              "system": "NUCC",
              "value": "207KI0005X"
            }
          ],
          "updatedAt": "2018-04-21T16:14:53Z",
          "createdAt": "2018-04-21T16:14:53Z",
          "createdBy": {
            "id": "11eb7db03c768b35b94afb16b9681d89"
          },
          "updatedBy": {
            "id": "11eb7db03c768b35b94afb16b9681d89"
          }
        }
      ],
      "taxonomy": {
        "id": "2d33c102f21e11e7a3d646705f8c9e71",
        "name": "Memorial Health Specialty Taxonomy"
      },
      "status": "ACTIVE",
      "aliases": [
        {
          "system": "NUCC",
          "value": "207K00000X"
        }
      ],
      "updatedAt": "2018-04-21T16:14:53Z",
      "createdAt": "2018-04-21T16:14:53Z",
      "createdBy": {
        "id": "11eb7db03c768b35b94afb16b9681d89"
      },
      "updatedBy": {
        "id": "11eb7db03c768b35b94afb16b9681d89"
      }
    },
    {
      "id": "ff647cb635e411e8bb469f2d0284914c",
      "name": "Family Medicine",
      "description": "Family Medicine is the medical specialty that is concerned with the total health care of the individual and the family. It integrates the biological, clinical, and behavioral sciences and is not limited by age, sex, organ system, or disease.",
      "taxonomy": {
        "id": "2d33c102f21e11e7a3d646705f8c9e71",
        "name": "Memorial Health Specialty Taxonomy"
      },
      "status": "ACTIVE",
      "aliases": [
        {
          "system": "NUCC",
          "value": "207Q00000X"
        }
      ],
      "updatedAt": "2018-04-21T16:14:53Z",
      "createdAt": "2018-04-21T16:14:53Z",
      "createdBy": {
        "id": "11eb7db03c768b35b94afb16b9681d89"
      },
      "updatedBy": {
        "id": "11eb7db03c768b35b94afb16b9681d89"
      }
    }
  ],
  "totalResults": 2,
  "firstLink": "http://cernerdemo.api.us.healtheintent.com/specialty/v1/hierarchy-specialties?offset=0&limit=20",
  "lastLink": "http://cernerdemo.api.us.healtheintent.com/specialty/v1/hierarchy-specialties?offset=0&limit=20"
}

GET /hierarchy-specialties

Retrieves a list of hierarchy specialties. You can search by name to retrieve each matched specialty and all its ancestors back to the root or top level. This allows you to locate subsets of specialties when their specific location in the hierarchy is unknown. You can search by ID to retrieve the specialty and all its descendants below it in the hierarchy. This allows you to explore all of the subspecialties that are available under a specific parent specialty.

Parameters

Parameter In Type Required Default Description Accepted Values
id query array[string] false N/A The ID of the specialty. If you specify both an id and a name, the name is ignored. -
name query string false N/A The name or partial name of the specialty. -
status query string false N/A The status of the specialty. ACTIVE, INACTIVE
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 Sorts results by a given value in ascending or descending alphabetic order. To sort results in descending order, prefix the value with a hyphen (-). name, -name

Response Statuses

Status Meaning Description Schema
200 OK Collection of hierarchy specialty objects HierarchySpecialties
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Retrieve a Single Hierarchy Specialty

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/specialty/v1/hierarchy-specialties/f9ed82acf21c11e7a3d646705f8c9e77', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "id": "f9ed82acf21c11e7a3d646705f8c9e77",
  "name": "Allergy & Immunology",
  "description": "An allergist-immunologist is trained in the evaluation, physical and laboratory diagnosis, and management of disorders involving the immune system.",
  "children": [
    {
      "id": "ff647cb635e411e8bb469f2d0284914c",
      "name": "Family Medicine",
      "description": "Family Medicine is the medical specialty that is concerned with the total health care of the individual and the family. It integrates the biological, clinical, and behavioral sciences and is not limited by age, sex, organ system, or disease.",
      "taxonomy": {
        "id": "2d33c102f21e11e7a3d646705f8c9e71",
        "name": "Memorial Health Specialty Taxonomy"
      },
      "status": "ACTIVE",
      "aliases": [
        {
          "system": "NUCC",
          "value": "207Q00000X"
        }
      ],
      "updatedAt": "2018-04-21T16:14:53Z",
      "createdAt": "2018-04-21T16:14:53Z",
      "createdBy": {
        "id": "11eb7db03c768b35b94afb16b9681d89"
      },
      "updatedBy": {
        "id": "11eb7db03c768b35b94afb16b9681d89"
      }
    }
  ],
  "taxonomy": {
    "id": "cc46c4c2deac11e7a3d646705f8c9e77",
    "name": "CMS Taxonomy"
  },
  "aliases": [
    {
      "system": "CMS",
      "value": "03"
    },
    {
      "system": "NUCC",
      "value": "207K00000X"
    }
  ],
  "createdAt": "2018-04-21T16:14:53Z",
  "updatedAt": "2018-04-21T16:14:53Z",
  "createdBy": {
    "id": "0205CF25-7F14-484B-A598-471BCA84A9BE"
  },
  "updatedBy": {
    "id": "0205CF25-7F14-484B-A598-471BCA84A9BE"
  }
}

GET /hierarchy-specialties/{specialtyId}

Retrieves a single hierarchy specialty by its ID.

Parameters

Parameter In Type Required Default Description Accepted Values
specialtyId path string true N/A No description -

Response Statuses

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

Standard Specialties

Standard specialty is an industry standard definition that is officially maintained and managed by an external governance body. These definitions are available as reference data for all HealtheIntent tenants. This standard content is available in a read-only format until it is copied to a tenant instance. The copy endpoints enable you to easily establish the references to the standard specialties when creating the tenant-specific specialties.

Retrieve a List of Standard Specialties

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/specialty/v1/standard-specialties', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "items": [
    {
      "id": "92dfef3035df11e8bb469f2d0284914c",
      "name": "Allergy & Immunology",
      "description": "An allergist-immunologist is trained in the evaluation, physical and laboratory diagnosis, and management of disorders involving the immune system.",
      "children": [
        {
          "id": "92dfef3135df11e8bb469f2d0284914c",
          "name": "Allergy"
        },
        {
          "id": "ff647c8e35e411e8bb469f2d0284914c",
          "name": "Clinical & Laboratory Immunology"
        }
      ],
      "taxonomy": {
        "id": "2d33c102f21e11e7a3d646705f8c9e77",
        "name": "NUCC Taxonomy"
      },
      "status": "ACTIVE",
      "updatedAt": "2018-04-21T16:14:53Z",
      "createdAt": "2018-04-21T16:14:53Z"
    },
    {
      "id": "ff647cb635e411e8bb469f2d0284914c",
      "name": "Family Medicine",
      "description": "Family Medicine is the medical specialty that is concerned with the total health care of the individual and the family. It integrates the biological, clinical, and behavioral sciences and is not limited by age, sex, organ system, or disease.",
      "taxonomy": {
        "id": "2d33c102f21e11e7a3d646705f8c9e77",
        "name": "NUCC Taxonomy"
      },
      "status": "ACTIVE",
      "aliases": [
        {
          "system": "NUCC",
          "value": "207Q00000X"
        }
      ],
      "updatedAt": "2018-04-21T16:14:53Z",
      "createdAt": "2018-04-21T16:14:53Z"
    },
    {
      "id": "ff647cb635e411e8bb469f2d0284914c",
      "name": "Neurocritical Care",
      "description": "The subspecialty of Neurocritical Care is devoted to the comprehensive, multisystem care of critically ill neurological patients. Like other intensivists, a neurointensivist generally assumes the primary role of coordinating the neurological and medical care of their patients in the ICU. They may also provide consultative services for these patients as requested in the health system.",
      "parent": {
        "id": "ff647cc035e411e8bb469f2d0284914c",
        "name": "Neurology"
      },
      "taxonomy": {
        "id": "92dfef1235df11e8bb469f2d0284914c",
        "name": "NUCC Taxonomy"
      },
      "status": "ACTIVE",
      "aliases": [
        {
          "system": "NUCC",
          "value": "2084A2900X"
        },
        {
          "system": "CMS",
          "value": "13"
        }
      ],
      "updatedAt": "2018-04-21T16:14:53Z",
      "createdAt": "2018-04-21T16:14:53Z"
    }
  ],
  "totalResults": 2,
  "firstLink": "http://cernerdemo.api.us.healtheintent.com/specialty/v1/standard-specialties?offset=0&limit=20",
  "lastLink": "http://cernerdemo.api.us.healtheintent.com/specialty/v1/standard-specialties?offset=0&limit=20"
}

GET /standard-specialties

Retrieves a list of specialties.

Parameters

Parameter In Type Required Default Description Accepted Values
ids query array[string] false N/A Filters by specialty IDs. If you specify this parameter, the API ignores the other parameters. You can specify a maximum of 100 IDs. -
name query string false N/A The name or partial name of the specialty. -
parentId query string false N/A The ID of the parent of the specialty. -
status query string false N/A The status of the specialty. ACTIVE, INACTIVE
taxonomyId query string false N/A The ID of the taxonomy of the specialty. -
aliasSystem query string false N/A The authority responsible for assigning the specialty ID. If aliasSystem is specified, aliasValue is required. -
aliasValue query string false N/A The value or ID of the specialty in the context of the assigning authority. If aliasValue is specified, aliasSystem is required. -
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 Sorts results by a given value in ascending or descending alphabetic order. To sort results in descending order, prefix the value with a hyphen (-). name, -name, updatedAt, -updatedAt

Response Statuses

Status Meaning Description Schema
200 OK Collection of standard specialties StandardSpecialties
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Retrieve a Single Standard Specialty

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/specialty/v1/standard-specialties/f9ed82acf21c11e7a3d646705f8c9e77', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "id": "f9ed82acf21c11e7a3d646705f8c9e77",
  "name": "Allergy & Immunology",
  "description": "An allergist-immunologist is trained in the evaluation, physical and laboratory diagnosis, and management of disorders involving the immune system.",
  "parent": {
    "id": "11e85d0cc3f0f83c9d27b1575fbb44c4",
    "name": "Asthma, Allergy & Immunology"
  },
  "children": [
    {
      "id": "92dfef3135df11e8bb469f2d0284914c",
      "name": "Allergy"
    },
    {
      "id": "ff647c8e35e411e8bb469f2d0284914c",
      "name": "Clinical & Laboratory Immunology"
    }
  ],
  "taxonomy": {
    "id": "cc46c4c2deac11e7a3d646705f8c9e77",
    "name": "CMS Taxonomy"
  },
  "aliases": [
    {
      "system": "CMS",
      "value": "03"
    },
    {
      "system": "NUCC",
      "value": "207K00000X"
    }
  ],
  "createdAt": "2018-04-21T16:14:53Z",
  "updatedAt": "2018-04-21T16:14:53Z"
}

GET /standard-specialties/{specialtyId}

Retrieves a single specialty by its ID.

Parameters

Parameter In Type Required Default Description Accepted Values
specialtyId path string true N/A No description -

Response Statuses

Status Meaning Description Schema
200 OK A Standard Specialty object StandardSpecialty
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Schema Definitions

postTaxonomies

Name Type Required Description Accepted Values
name string true The name of the taxonomy. -
description string false The description of the taxonomy -
version string false The version of the taxonomy. -
createdBy object false The individual who is creating the new record. -
» id string true The ID of the individual creating the new record. -

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

Taxonomies

Name Type Required Description Accepted Values
items [Taxonomy] 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. -

Taxonomy

Name Type Required Description Accepted Values
id string true The unique ID of the taxonomy. -
name string true The formatted display text of the taxonomy. -
description string false The description of the taxonomy definition. -
version string false The version of the taxonomy. -
createdAt string true The date and time when the taxonomy was created, in International Organization for Standardization (ISO) 8601 format (YYYY-MM-DDThh:mm:ssZ). -
updatedAt string true The date and time when the taxonomy was most recently updated, in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). -
createdBy Reference false The ID of the individual who entered the record into the system. -
updatedBy Reference false The ID of the individual who updated the record. -

Reference

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

putTaxonomies

Name Type Required Description Accepted Values
name string true The name of the taxonomy. -
description string false The description of the taxonomy -
version string false The version of the taxonomy. -
updatedBy object false The individual who is updating the new record. -
» id string true The ID of the individual updating the record. -

StandardTaxonomies

Name Type Required Description Accepted Values
items [StandardTaxonomy] 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. -

StandardTaxonomy

Name Type Required Description Accepted Values
id string true The unique ID of the taxonomy. -
name string true The formatted display text of the taxonomy. -
description string false The description of the taxonomy definition. -
version string true The version of the taxonomy. -
createdAt string true The date and time when the taxonomy was created, in International Organization for Standardization (ISO) 8601 format (YYYY-MM-DDThh:mm:ssZ). -
updatedAt string true The date and time when the taxonomy was most recently updated, in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). -

postStandardTaxonomiesTaxonomyidActionsCopy

Name Type Required Description Accepted Values
name string true The name of the standard taxonomy. -
description string false The description of the standard taxonomy. -
version string false The version of the taxonomy copy. If the version is not valued, this is the latest version of the standard taxonomy. -
includeSpecialties [object] false A list of included specialties associated with the standard taxonomy. This list must contain either a specialty ID or an alias. If both are provided, the ID takes precedence over the alias. If the identification of the specialty fails, that specialty is ignored and not copied. When included specialties are provided, the excluded specialties must be empty. -
» id string false The ID of the included specialty. -
» alias object false The alias of the included specialty. -
»» system string true The authority responsible for assigning the ID. -
»» value string true The value or ID within the context of the assigning authority. -
excludeSpecialties [object] false A list of excluded specialties associated with the standard taxonomy. This list must contain either a specialty ID or an alias. If both are provided, the ID takes precedence over the alias. If the identification of the specialty fails, that specialty is ignored and not copied. When excluded specialties are provided, the included specialties must be empty. -
» id string false The ID of the excluded specialty. -
» alias object false The alias of the excluded specialty. -
»» system string true The authority responsible for assigning the ID. -
»» value string true The value or ID within the context of the assigning authority. -
retainHierarchy boolean false A Boolean value that indicates whether the hierarchical relationship of the standard taxonomy is retained. The default value is true. -
createdBy object false No description -
» id string true The individual who entered the specialties in the system. -

HierarchySpecialtyList

Name Type Required Description Accepted Values
items [HierarchySpecialty] false A list of copied specialties associated with the standard taxonomy. -

HierarchySpecialty

Name Type Required Description Accepted Values
id string true The unique ID of the specialty. -
name string true The name of the specialty. -
description string false The description of the specialty definition. -
children [SubSpecialtyLevel1] false The list of subspecialties associated with this specialty. -
status string true The status of the specialty. ACTIVE, INACTIVE
taxonomy TaxonomyIdName true The taxonomy of the specialty. -
aliases [Alias] false The list of specialty aliases. -
createdAt string true The date and time when the specialty was created, in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). -
updatedAt string true The date and time when the specialty was most recently updated, in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). -
createdBy Reference false The ID of the individual who entered the record into the system. -
updatedBy Reference false The ID of the individual who updated the record. -

SubSpecialtyLevel1

Name Type Required Description Accepted Values
id string true The unique ID of the specialty. -
name string true The name of the specialty. -
description string false The description of the specialty definition. -
children [SubSpecialtyLevel2] false The list of subspecialties associated with this specialty. -
status string true The status of the specialty. ACTIVE, INACTIVE
taxonomy TaxonomyIdName true The taxonomy of the specialty. -
aliases [Alias] false The list of specialty aliases. -
createdAt string true The date and time when the specialty was created, in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). -
updatedAt string true The date and time when the specialty was most recently updated, in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). -
createdBy Reference false The ID of the individual who entered the record into the system. -
updatedBy Reference false The ID of the individual who updated the record. -

SubSpecialtyLevel2

Name Type Required Description Accepted Values
id string true The unique ID of the specialty. -
name string true The name of the specialty. -
description string false The description of the specialty definition. -
children [SubSpecialtyLevel3] false The list of subspecialties associated with this specialty. -
status string true The status of the specialty. ACTIVE, INACTIVE
taxonomy TaxonomyIdName true The taxonomy of the specialty. -
aliases [Alias] false The list of specialty aliases. -
createdAt string true The date and time when the specialty was created, in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). -
updatedAt string true The date and time when the specialty was most recently updated, in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). -
createdBy Reference false The ID of the individual who entered the record into the system. -
updatedBy Reference false The ID of the individual who updated the record. -

SubSpecialtyLevel3

Name Type Required Description Accepted Values
id string true The unique ID of the specialty. -
name string true The name of the specialty. -
description string false The description of the specialty definition. -
children [SubSpecialtyLevel3] false The list of subspecialties associated with this specialty. -
status string true The status of the specialty. ACTIVE, INACTIVE
taxonomy TaxonomyIdName true The taxonomy of the specialty. -
aliases [Alias] false The list of specialty aliases. -
createdAt string true The date and time when the specialty was created, in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). -
updatedAt string true The date and time when the specialty was most recently updated, in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). -
createdBy Reference false The ID of the individual who entered the record into the system. -
updatedBy Reference false The ID of the individual who updated the record. -

TaxonomyIdName

Name Type Required Description Accepted Values
id string false The unique ID of the taxonomy. -
name string false The formatted display text of the taxonomy. -

Alias

Name Type Required Description Accepted Values
system string false The authority responsible for assigning the alias value. Alias values are unique within this system namespace but not across systems. -
value string false The unique ID of the provider in the context of the system or assigning authority. -

postSpecialties

Name Type Required Description Accepted Values
name string true The name of the specialty. -
description string false The description of the specialty. -
taxonomy object true The taxonomy of the specialty. -
» id string true The unique ID of the taxonomy. -
status string true The status of the specialty. ACTIVE, INACTIVE
aliases [object] false The list of specialty aliases. -
» system string true The authority responsible for assigning the alias value. Alias values are unique within this system namespace but not across systems. -
» value string true The unique ID of the provider in the context of the system or assigning authority. -
parent object false The parent of the specialty in the context of the same taxonomy. Root level specialties have a null parent. -
» id string true The unique ID of the specialty. -
createdBy object false The individual who is creating the new record. -
» id string true The ID of the individual creating the new record. -

Specialties

Name Type Required Description Accepted Values
items [Specialty] 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. -

Specialty

Name Type Required Description Accepted Values
id string true The unique ID of the specialty. -
name string true The name of the specialty. -
description string false The description of the specialty definition. -
parent SpecialtyIdName false The parent of the specialty in the context of the same taxonomy. Root level specialties have a null parent. -
children [SpecialtyIdName] false The list of subspecialties associated with this specialty. -
status string true The status of the specialty. ACTIVE, INACTIVE
taxonomy TaxonomyIdName true The taxonomy of the specialty. -
aliases [Alias] false The list of specialty aliases. -
createdAt string true The date and time when the specialty was created, in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). -
updatedAt string true The date and time when the specialty was most recently updated, in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). -
createdBy Reference false The ID of the individual who entered the record into the system. -
updatedBy Reference false The ID of the individual who updated the record. -

SpecialtyIdName

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

putSpecialties

Name Type Required Description Accepted Values
name string true The name of the specialty. -
description string false The description of the specialty. -
status string true The status of the specialty. ACTIVE, INACTIVE
aliases [object] false The list of specialty aliases. -
» system string true The authority responsible for assigning the alias value. Alias values are unique within this system namespace but not across systems. -
» value string true The unique ID of the provider in the context of the system or assigning authority. -
parent object false The parent of the specialty. -
» id string true The unique ID of the specialty. -
updatedBy object false The individual who is updating the new record. -
» id string true The ID of the individual updating the record. -

HierarchySpecialties

Name Type Required Description Accepted Values
items [HierarchySpecialty] 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. -

StandardSpecialties

Name Type Required Description Accepted Values
items [StandardSpecialty] 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. -

StandardSpecialty

Name Type Required Description Accepted Values
id string true The unique ID of the specialty. -
name string true The name of the specialty. -
description string false The description of the specialty definition. -
parent SpecialtyIdName false The parent of the specialty in the context of the same taxonomy. Root level specialties have a null parent. -
children [SpecialtyIdName] false The list of subspecialties associated with this specialty. -
status string true The status of the specialty. ACTIVE, INACTIVE
taxonomy TaxonomyIdName true The taxonomy of the specialty. -
aliases [Alias] false The list of specialty aliases. -
createdAt string true The date and time when the specialty was created, in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). -
updatedAt string true The date and time when the specialty was most recently updated, in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ). -

SpecialtyId

Name Type Required Description Accepted Values
id string false The unique ID of the specialty. -

TaxonomyId

Name Type Required Description Accepted Values
id string false The unique ID of the taxonomy. -