NAV Navbar
Logo cerner
Ruby Shell

Procedure API v1

The HealtheIntent Procedure API allows systems to interact with procedure data in HealtheIntent.

Note: The data retrieved by this API is filtered based on your sensitive data filters for HealtheIntent. Ensure that your implementations of this API are designed with this in mind, and if you integrate data from HealtheIntent into a clinical workflow using this API, ensure that your users are informed of your sensitive data filters. See Understand Sensitive Data in HealtheIntent in the Reference Pages on Cerner Wiki for more information.

URL: https://cernerdemo.api.us.healtheintent.com/procedure/v1

Procedure

A procedure is an activity that is performed on a patient with the intention of determining, measuring, or diagnosing a patient condition.

Retrieve a Single Procedure

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.healtheintent.com/procedure/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/0f2fbbc9-7c18-45e0-a95e-89076c8a9581/procedures/adc07a0f7d62da22eece277b96b22e4ab84484785cb812d849065e8a01474e49', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/procedure/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/0f2fbbc9-7c18-45e0-a95e-89076c8a9581/procedures/adc07a0f7d62da22eece277b96b22e4ab84484785cb812d849065e8a01474e49 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "code": {
    "codings": [
      {
        "code": "171149006",
        "display": "Cervical neoplasia screening",
        "system": "2.16.840.1.113883.6.96"
      },
      {
        "code": "PAP_TEST_PROC",
        "display": "Pap Test",
        "system": "2A8180EF0FB44CC6898F19243F9A3DAC"
      }
    ],
    "sourceCodings": [
      {
        "code": "171149006",
        "display": "Pap",
        "system": "2.16.840.1.113883.6.96"
      }
    ],
    "text": "Pap"
  },
  "encounter": {
    "id": "7cd017ef-7d31-390e-b4fe-52d9f86e517e"
  },
  "end": "2013-08-01T09:00:00.000Z",
  "id": "adc07a0f7d62da22eece277b96b22e4ab84484785cb812d849065e8a01474e49",
  "modifiers": [
    {
      "codings": [
        {
          "code": "LT",
          "display": "Left side (used to identify procedures performed on the left side of the body)",
          "system": "2.16.840.1.113883.6.285"
        }
      ],
      "sourceCodings": [
        {
          "code": "LT",
          "display": "Left side (used to identify procedures performed on the left side of the body)",
          "system": "2.16.840.1.113883.6.285"
        }
      ],
      "text": "Left side (used to identify procedures performed on the left side of the body)"
    }
  ],
  "notes": [
    {
      "author": {
        "aliases": [
          {
            "system": "2.16.840.1.113883.4.814",
            "type": "DEA",
            "value": "1234"
          }
        ],
        "name": {
          "family": [
            "Brizendine"
          ],
          "formatted": "Brizendine, Margaret",
          "given": [
            "Margaret"
          ],
          "prefix": "Dr.",
          "suffix": "Jr."
        }
      },
      "date": "2018-01-23",
      "text": "Operation went smoothly."
    }
  ],
  "placeOfService": {
    "codings": [
      {
        "system": "2.16.840.1.113883.15.5",
        "code": "22",
        "display": "Outpatient Hospital"
      }
    ],
    "sourceCodings": [
      {
        "system": "urn:oid:2.16.840.1.113883.15.5",
        "code": "22",
        "display": "Outpatient Hospital"
      }
    ],
    "text": "Outpatient Hospital"
  },
  "status": {
    "codings": [
      {
        "system": "2.16.840.1.113883.5.14",
        "code": "cancelled",
        "display": "Cancelled"
      }
    ],
    "sourceCodings": [
      {
        "system": "2.16.840.1.113883.5.14",
        "code": "cancelled",
        "display": "Cancelled"
      }
    ],
    "text": "Cancelled"
  },
  "principalProvider": {
    "provider": {
      "aliases": [
        {
          "system": "2.16.840.1.113883.4.6",
          "type": "NPI",
          "value": "1831176692"
        }
      ],
      "name": {
        "family": [],
        "formatted": "Richardson, Megan",
        "given": []
      }
    },
    "type": {
      "codings": [
        {}
      ],
      "sourceCodings": [
        {}
      ]
    }
  },
  "provenances": [
    {
      "entities": [
        {
          "role": {
            "sourceCodings": [
              {
                "code": "source",
                "system": "2.16.840.1.113883.4.642.1.437",
                "display": "Source"
              }
            ],
            "codings": [
              {
                "code": "source",
                "system": "2.16.840.1.113883.4.642.1.437",
                "display": "Source"
              }
            ],
            "text": "Source"
          },
          "what": {
            "documentReference": {
              "id": "581433f4-b179-3df4-9bb2-9768ef76493c"
            }
          }
        }
      ],
      "agents": [
        {
          "type": {
            "sourceCodings": [
              {
                "code": "author",
                "system": "2.16.840.1.113883.4.642.1.1131",
                "display": "Author"
              }
            ],
            "codings": [
              {
                "code": "author",
                "system": "2.16.840.1.113883.4.642.1.1131",
                "display": "Author"
              }
            ],
            "text": "Author"
          },
          "who": {
            "organization": {
              "name": "Rockcreek Clinic",
              "aliases": [
                {
                  "value": "151579",
                  "type": "EXTERNAL",
                  "system": "1.2.3.4.5.6.7.8.9.10.1"
                }
              ]
            }
          }
        }
      ],
      "recordedOn": "2011-07-26T23:53:00.000Z"
    }
  ],
  "relatedProviders": [
    {
      "provider": {
        "aliases": [
          {
            "system": "2.16.840.1.113883.4.6",
            "type": "NPI",
            "value": "1831176692"
          }
        ],
        "name": {
          "family": [],
          "formatted": "Richardson, Megan",
          "given": []
        }
      },
      "type": {
        "codings": [
          {
            "code": "304292004",
            "display": "Surgeon",
            "system": "2.16.840.1.113883.6.96"
          }
        ],
        "sourceCodings": [
          {
            "code": "1209",
            "display": "Surgeon",
            "system": "urn:cerner:coding:codingsystem:codeset:388"
          }
        ],
        "text": "Surgeon"
      }
    }
  ],
  "sourceIdentifier": {
    "dataPartitionId": "54dd3f9e-7c45-413d-88bc-3bafcee8b7ab",
    "id": "12345"
  },
  "start": "2013-08-01T05:00:00.000Z"
}

GET /populations/{populationId}/patients/{patientId}/procedures/{procedureId}

Retrieves a single procedure for a given patient.

Parameters

Parameter In Type Required Default Description Accepted Values
patientId path string true N/A The ID of the patient. -
populationId path string true N/A The ID of the population. -
procedureId path string true N/A The unique ID of the procedure for the patient. -

Response Statuses

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

Retrieve a List of Procedures

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.healtheintent.com/procedure/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/0f2fbbc9-7c18-45e0-a95e-89076c8a9581/procedures', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us.healtheintent.com/procedure/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/0f2fbbc9-7c18-45e0-a95e-89076c8a9581/procedures \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "code": {
        "codings": [
          {
            "code": "171149006",
            "display": "Cervical neoplasia screening",
            "system": "2.16.840.1.113883.6.96"
          },
          {
            "code": "PAP_TEST_PROC",
            "display": "Pap Test",
            "system": "2A8180EF0FB44CC6898F19243F9A3DAC"
          }
        ],
        "sourceCodings": [
          {
            "code": "171149006",
            "display": "Pap",
            "system": "2.16.840.1.113883.6.96"
          }
        ],
        "text": "Pap"
      },
      "encounter": {
        "id": "7cd017ef-7d31-390e-b4fe-52d9f86e517e"
      },
      "end": "2013-08-01T09:00:00.000Z",
      "id": "adc07a0f7d62da22eece277b96b22e4ab84484785cb812d849065e8a01474e49",
      "modifiers": [
        {
          "codings": [
            {
              "code": "LT",
              "display": "Left side (used to identify procedures performed on the left side of the body)",
              "system": "2.16.840.1.113883.6.285"
            }
          ],
          "sourceCodings": [
            {
              "code": "LT",
              "display": "Left side (used to identify procedures performed on the left side of the body)",
              "system": "2.16.840.1.113883.6.285"
            }
          ],
          "text": "Left side (used to identify procedures performed on the left side of the body)"
        }
      ],
      "notes": [
        {
          "author": {
            "aliases": [
              {
                "system": "2.16.840.1.113883.4.814",
                "type": "DEA",
                "value": "1234"
              }
            ],
            "name": {
              "family": [
                "Brizendine"
              ],
              "formatted": "Brizendine, Margaret",
              "given": [
                "Margaret"
              ],
              "prefix": "Dr.",
              "suffix": "Jr."
            }
          },
          "date": "2018-01-23",
          "text": "Operation went smoothly."
        }
      ],
      "placeOfService": {
        "codings": [
          {
            "system": "2.16.840.1.113883.15.5",
            "code": "22",
            "display": "Outpatient Hospital"
          }
        ],
        "sourceCodings": [
          {
            "system": "urn:oid:2.16.840.1.113883.15.5",
            "code": "22",
            "display": "Outpatient Hospital"
          }
        ],
        "text": "Outpatient Hospital"
      },
      "status": {
        "codings": [
          {
            "system": "2.16.840.1.113883.5.14",
            "code": "cancelled",
            "display": "Cancelled"
          }
        ],
        "sourceCodings": [
          {
            "system": "2.16.840.1.113883.5.14",
            "code": "cancelled",
            "display": "Cancelled"
          }
        ],
        "text": "Cancelled"
      },
      "principalProvider": {
        "provider": {
          "aliases": [
            {
              "system": "2.16.840.1.113883.4.6",
              "type": "NPI",
              "value": "1831176692"
            }
          ],
          "name": {
            "family": [],
            "formatted": "Richardson, Megan",
            "given": []
          }
        },
        "type": {
          "codings": [
            {}
          ],
          "sourceCodings": [
            {}
          ]
        }
      },
      "provenances": [
        {
          "entities": [
            {
              "role": {
                "sourceCodings": [
                  {
                    "code": "source",
                    "system": "2.16.840.1.113883.4.642.1.437",
                    "display": "Source"
                  }
                ],
                "codings": [
                  {
                    "code": "source",
                    "system": "2.16.840.1.113883.4.642.1.437",
                    "display": "Source"
                  }
                ],
                "text": "Source"
              },
              "what": {
                "documentReference": {
                  "id": "581433f4-b179-3df4-9bb2-9768ef76493c"
                }
              }
            }
          ],
          "agents": [
            {
              "type": {
                "sourceCodings": [
                  {
                    "code": "author",
                    "system": "2.16.840.1.113883.4.642.1.1131",
                    "display": "Author"
                  }
                ],
                "codings": [
                  {
                    "code": "author",
                    "system": "2.16.840.1.113883.4.642.1.1131",
                    "display": "Author"
                  }
                ],
                "text": "Author"
              },
              "who": {
                "organization": {
                  "name": "Rockcreek Clinic",
                  "aliases": [
                    {
                      "value": "151579",
                      "type": "EXTERNAL",
                      "system": "1.2.3.4.5.6.7.8.9.10.1"
                    }
                  ]
                }
              }
            }
          ],
          "recordedOn": "2011-07-26T23:53:00.000Z"
        }
      ],
      "relatedProviders": [
        {
          "provider": {
            "aliases": [
              {
                "system": "2.16.840.1.113883.4.6",
                "type": "NPI",
                "value": "1831176692"
              }
            ],
            "name": {
              "family": [],
              "formatted": "Richardson, Megan",
              "given": []
            }
          },
          "type": {
            "codings": [
              {
                "code": "304292004",
                "display": "Surgeon",
                "system": "2.16.840.1.113883.6.96"
              }
            ],
            "sourceCodings": [
              {
                "code": "1209",
                "display": "Surgeon",
                "system": "urn:cerner:coding:codingsystem:codeset:388"
              }
            ],
            "text": "Surgeon"
          }
        }
      ],
      "sourceIdentifier": {
        "dataPartitionId": "54dd3f9e-7c45-413d-88bc-3bafcee8b7ab",
        "id": "12345"
      },
      "start": "2013-08-01T05:00:00.000Z"
    }
  ],
  "firstLink": "https://cernerdemo.api.us.healtheintent.com/procedure/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/0f2fbbc9-7c18-45e0-a95e-89076c8a9581/procedures?limit=20",
  "nextLink": "https://cernerdemo.api.us.healtheintent.com/procedure/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/0f2fbbc9-7c18-45e0-a95e-89076c8a9581/procedures?cursor=adc07a0f7d62da22eece277b96b22e4ab84484785cb812d849065e8a01474e49&limit=20"
}

GET /populations/{populationId}/patients/{patientId}/procedures

Retrieves a list of the procedures for a given patient.

Parameters

Parameter In Type Required Default Description Accepted Values
patientId path string true N/A The ID of the patient. -
populationId path string true N/A The ID of the population. -
cursor query string false N/A The last item on the list in the response from the previous request. If you specify this parameter, the response begins with the next item on the list. -
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 OK Procedures
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Schema Definitions

Procedure

Name Type Required Description Accepted Values
code CodeableConcept true The procedure that was performed or scheduled to be performed. This can also include its HealtheIntent ontological concept or concepts. -
encounter Encounter false The encounter associated with the procedure. -
end string false The ending date of the procedure. In International Organization for Standardization (ISO) 8601 formatting with precision ranging from YYYY to YYYY-MM-DDThh:mm:ss.SSSZ. -
id string true The unique ID of the procedure record. -
modifiers [CodeableConcept] true Modifiers denote additional details around the procedures, such as the procedure location, repeat procedures, and procedures performed by specific specialties. These are typically CPT-4 modifiers. -
notes [ProviderNote] true Notes or comments associated with the procedure. -
placeOfService CodeableConcept false Where services were rendered, for example, inpatient hospital, office, pharmacy, home, assisted living facility, urgent care facility, school, or place of employment. -
status CodeableConcept false The state of the procedure, such as canceled or completed. -
principalProvider ProviderRelationship false The primary provider, such as the surgeon for a surgical procedure. -
provenances [Provenance] true The record-keeping assertions about the context in which the information in this procedure was obtained (for example, the authoring organization, the transmitter or custodian organization that informs the chain of custody, or the source Consolidated Clinical Document Architecture (C-CDA) document from which this procedure was derived, if applicable). -
relatedProviders [ProviderRelationship] true All providers who performed the procedure, such as the surgeon and anesthesiologist for a surgical procedure. The principal provider is included on the list. -
sourceIdentifier SourceIdentifier false A unique ID of this procedure for a patient in the same data partition. -
start string false The start date of the procedure. In ISO 8601 formatting with precision ranging from YYYY to YYYY-MM-DDThh:mm:ss.SSSZ. -

CodeableConcept

Name Type Required Description Accepted Values
codings [Code] true A list of codified values from standard code systems recognized by HealtheIntent. -
sourceCodings [Code] true The list of codified values provided in the source data. Not all of these codes are available in the codings list. For example, local or proprietary codes are not included on the codings list because they are not recognized by HealtheIntent. -
text string false This may be a localized or annotated description of the element provided by a source system or display text associated with one of the codes on the codings or sourceCodings list. -

Code

Name Type Required Description Accepted Values
code string true The unique ID of the code. -
display string false A human-readable representation of the code. -
system string true The ID of the coding system that gives meaning to the code. -

Encounter

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

ProviderNote

Name Type Required Description Accepted Values
date string false The date when the note was recorded. In ISO 8601 formatting with precision ranging from YYYY to YYYY-MM-DDThh:mm:ss.SSSZ. -
text string true The textual content of the note or comment. -
author Provider false The individual who recorded the note or comment. -
type CodeableConcept false The type of the note or comment. -

Provider

Name Type Required Description Accepted Values
aliases [ProviderAlias] false A list of IDs of the provider, such as the ten-digit National Provider Identifier (NPI) or the Drug Enforcement Administration (DEA) number. -
name ProviderName false The attributes of the provider name. -

ProviderAlias

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. -
type string true The type of alias. DEA, EXTERNAL, NPI, SL, TAX, UPIN

ProviderName

Name Type Required Description Accepted Values
prefix string false The parts that come before the name such as Dr., Mr., or Mrs. -
given [string] true A list of given name portions of the person’s name. For example, if a person has a first name and a middle name, the first name should be the first item on the list and the middle name should be the second item on the list. -
family [string] true A list of family (last) name portions of the person’s name. Some people have multiple family names. -
suffix string false The parts that come after the name such as MD, III, or Jr. -
formatted string false The person’s fully-formatted name. -

ProviderRelationship

Name Type Required Description Accepted Values
provider Provider false The patient’s provider, consisting of a provider’s aliases and names. -
type CodeableConcept false The type of relationship the provider has to the patient. -

Provenance

Name Type Required Description Accepted Values
entities [ProvenanceEntity] true A list of entities used in this activity. -
agents [ProvenanceAgent] true Actors taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place. -
recordedOn string false When the activity was recorded/updated. In ISO 8601 formatting with precision ranging from YYYY to YYYY-MM-DDThh:mm:ss.SSSZ. -

ProvenanceEntity

Name Type Required Description Accepted Values
role CodeableConcept false How the entity was used in a provenance activity (for example, source). -
what ProvenanceEntityIdentity false Identity of the entity used in the provenance activity. -

ProvenanceEntityIdentity

Name Type Required Description Accepted Values
documentReference DocumentReferenceId false The ID of the document reference entity used in the provenance activity. -

DocumentReferenceId

Name Type Required Description Accepted Values
id string false The unique ID that identifies the document reference within the data partition to which it was published. -

ProvenanceAgent

Name Type Required Description Accepted Values
type CodeableConcept true The participation the agent had with respect to the activity. -
who ProvenanceAgentEntity false Who participated as an agent in a provenance activity. -

ProvenanceAgentEntity

Name Type Required Description Accepted Values
organization Organization false An organization participating entity. -

Organization

Name Type Required Description Accepted Values
name string false The name of the organization. -
aliases [OrganizationAlias] true A list of IDs of the organization, such as the NPI or the tax ID. -

OrganizationAlias

Name Type Required Description Accepted Values
value string true The unique ID of the alias. -
type string true The type of organization alias, such as NPI. NPI, TAX, EXTERNAL, NABP, HL7_OID
system string false The authority responsible for assigning the alias value. Alias values may be unique within this system namespace but not across systems. -

SourceIdentifier

Name Type Required Description Accepted Values
dataPartitionId string false The ID of the data partition. See the Data Partitions endpoint of the Data Source API for more information. -
id string false An ID that uniquely identifies this entity for a patient in the data partition. -

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

Procedures

Name Type Required Description Accepted Values
items [Procedure] true [Retrieves a single procedure for a given patient.] -
firstLink string true The first page of results. -
nextLink string false The next page of results. -