NAV
Ruby Shell

Encounter API v1

The HealtheIntent Encounter API allows systems to interact with encounter 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-1.healtheintent.com/encounter/v1

Encounter

An encounter represents a planned, current, or past interaction between the patient and one or more health care providers. For example, an encounter can represent an inpatient hospitalization, an ambulatory or outpatient visit, an emergency department visit, a home health visit at the patient’s residence, or a virtual encounter by email or teleconference.

Retrieve a Single Encounter

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/encounter/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/a2f6a16d-1331-4ccc-8f70-6c4d953ba70b/encounters/47f126a0-1b03-3d9d-8455-3aa71c090d5d', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/encounter/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/a2f6a16d-1331-4ccc-8f70-6c4d953ba70b/encounters/47f126a0-1b03-3d9d-8455-3aa71c090d5d \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "47f126a0-1b03-3d9d-8455-3aa71c090d5d",
  "sourceIdentifier": {
    "dataPartitionId": "e5f34c23-e572-44c3-a2cd-7ca358dcec9f",
    "id": "7209f9fb-3a5d-44c1-8dbb-123f340a9850"
  },
  "aliases": [
    {
      "value": "1831-176692",
      "computationalValue": "1831176692",
      "renderedValue": "****176692",
      "system": "1.1.16.6.0",
      "type": {
        "sourceCodings": [
          {
            "system": "urn:cerner:coding:codingsystem:codeset:319",
            "code": "777",
            "display": "FIN NBR"
          }
        ],
        "codings": [
          {
            "system": "2.16.840.1.113883.12.203",
            "code": "AN",
            "display": "Account number"
          }
        ],
        "text": "FIN NBR"
      }
    }
  ],
  "reasonForVisit": {
    "sourceCodings": [],
    "codings": [],
    "text": "Heart valve disorder"
  },
  "reasonCodes": [
    {
      "sourceCodings": [],
      "codings": [],
      "text": "Heart valve disorder"
    },
    {
      "sourceCodings": [
        {
          "system": "2.16.840.1.113883.6.96",
          "code": "35314007",
          "display": "Hurricane (event)"
        }
      ],
      "codings": [
        {
          "system": "2.16.840.1.113883.6.96",
          "code": "35314007",
          "display": "Hurricane (event)"
        }
      ]
    }
  ],
  "estimatedArrivalOn": "2018-04-21T16:00:00Z",
  "actualArrivalOn": "2018-04-21T16:14:53Z",
  "admittedOn": "2018-04-21T16:50:18Z",
  "period": {
    "start": "2018-04-21T16:14:53Z",
    "end": "2018-04-23T10:09:10Z"
  },
  "admissionSource": {
    "sourceCodings": [
      {
        "system": "urn:cerner:coding:codingsystem:codeset:2",
        "code": "9999",
        "display": "Physician Referral"
      }
    ],
    "codings": [
      {
        "system": "2.16.840.1.113883.12.23",
        "code": "1",
        "display": "Physician referral"
      }
    ],
    "text": "Physician Referral"
  },
  "estimatedDepartureOn": "2018-04-23T10:00:00Z",
  "dischargedOn": "2018-04-23T10:09:10Z",
  "dischargeDisposition": {
    "sourceCodings": [
      {
        "system": "urn:cerner:coding:codingsystem:codeset:19",
        "code": "638671",
        "display": "Home"
      }
    ],
    "codings": [
      {
        "system": "2.16.840.1.113883.12.112",
        "code": "01",
        "display": "Discharged to home or self care (routine discharge)"
      }
    ],
    "text": "Home"
  },
  "dischargeToLocation": {
    "sourceCodings": [
      {
        "system": "urn:cerner:coding:codingsystem:codeset:20",
        "code": "264362003",
        "display": "Home"
      }
    ],
    "codings": [
      {
        "system": "2.16.840.1.113883.6.96",
        "code": "264362003",
        "display": "Home (environment)"
      }
    ],
    "text": "Home"
  },
  "priority": {
    "sourceCodings": [
      {
        "system": "urn:cerner:coding:codingsystem:codeset:1304",
        "code": "S",
        "display": "Stat (do immediately)"
      }
    ],
    "codings": [
      {
        "system": "2.16.840.1.113883.12.27",
        "code": "S",
        "display": "Stat (do immediately)"
      }
    ],
    "text": "Stat (do immediately)"
  },
  "status": {
    "sourceCodings": [
      {
        "system": "urn:cerner:coding:codingsystem:codeset:261",
        "code": "856",
        "display": "Discharged"
      }
    ],
    "codings": [
      {
        "system": "2.16.840.1.113883.5.14",
        "code": "completed",
        "display": "null"
      }
    ],
    "text": "Discharged"
  },
  "participants": [
    {
      "provider": {
        "aliases": [
          {
            "system": "2.16.840.1.113883.4.6",
            "type": "NPI",
            "value": "1831176692"
          }
        ],
        "name": {
          "prefix": "Dr.",
          "given": [
            "Jane",
            "Susannah"
          ],
          "family": [
            "Smith"
          ],
          "suffix": "MD.",
          "formatted": "Dr. Jane Susannah Smith MD."
        }
      },
      "type": {
        "sourceCodings": [
          {
            "system": "urn:cerner:coding:codingsystem:codeset:333",
            "code": "1111",
            "display": "Attending Physician"
          }
        ],
        "codings": [
          {
            "system": "2.16.840.1.113883.12.443",
            "code": "AT",
            "display": "Attending"
          }
        ],
        "text": "Attending Physician"
      },
      "effectivePeriod": {
        "start": "2018-04-21T16:50:18Z",
        "end": "2018-04-23T10:09:10Z"
      }
    }
  ],
  "provenances": [
    {
      "entities": [
        {
          "role": {
            "sourceCodings": [
              {
                "code": "source",
                "system": "2.16.840.1.113883.4.642.4.437",
                "display": "Source"
              }
            ],
            "codings": [
              {
                "code": "source",
                "system": "2.16.840.1.113883.4.642.4.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.4.1131",
                "display": "Author"
              }
            ],
            "codings": [
              {
                "code": "author",
                "system": "2.16.840.1.113883.4.642.4.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"
    }
  ],
  "services": [
    {
      "service": {
        "sourceCodings": [
          {
            "system": "urn:cerner:coding:codingsystem:codeset:34",
            "code": "333333",
            "display": "CAR - Cardiology"
          }
        ],
        "codings": [
          {
            "system": "2.16.840.1.113883.6.96",
            "code": "3471000175103",
            "display": "Cardiology service"
          }
        ],
        "text": "CAR - Cardiology"
      },
      "effectivePeriod": {
        "start": "2018-04-21T16:50:18Z",
        "end": "2018-04-23T10:09:10Z"
      }
    }
  ],
  "types": [
    {
      "type": {
        "sourceCodings": [
          {
            "system": "urn:cerner:coding:codingsystem:codeset:71",
            "code": "33333",
            "display": "ER - Emergency"
          }
        ],
        "codings": [
          {
            "system": "2.16.840.1.113883.12.4",
            "code": "E",
            "display": "Emergency"
          }
        ],
        "text": "ER - Emergency"
      },
      "classification": {
        "sourceCodings": [
          {
            "system": "urn:cerner:coding:codingsystem:codeset:69",
            "code": "888",
            "display": "Emergency"
          }
        ],
        "codings": [
          {
            "system": "2.16.840.1.113883.12.4",
            "code": "E",
            "display": "Emergency"
          }
        ],
        "text": "Emergency"
      },
      "effectivePeriod": {
        "start": "2018-04-21T16:14:53Z",
        "end": "2018-04-21T16:50:18Z"
      }
    },
    {
      "type": {
        "sourceCodings": [
          {
            "system": "urn:cerner:coding:codingsystem:codeset:71",
            "code": "309308",
            "display": "Inpatient"
          }
        ],
        "codings": [
          {
            "system": "2.16.840.1.113883.12.4",
            "code": "I",
            "display": "Inpatient"
          }
        ],
        "text": "Inpatient"
      },
      "classification": {
        "sourceCodings": [
          {
            "system": "urn:cerner:coding:codingsystem:codeset:69",
            "code": "391",
            "display": "Inpatient"
          }
        ],
        "codings": [
          {
            "system": "2.16.840.1.113883.12.4",
            "code": "I",
            "display": "Inpatient"
          }
        ],
        "text": "Inpatient"
      },
      "effectivePeriod": {
        "start": "2018-04-21T16:50:18Z",
        "end": "2018-04-23T10:09:10Z"
      }
    }
  ],
  "organization": {
    "aliases": [
      {
        "value": "151579",
        "type": "EXTERNAL",
        "system": "1.2.3.4.5.6.7.8.9.10.1"
      }
    ],
    "name": "Rockcreek Clinic"
  }
}

GET /populations/{populationId}/patients/{patientId}/encounters/{encounterId}

Retrieves a single encounter by ID.

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. -
encounterId path string true N/A The ID that uniquely identifies the encounter for the patient. -

Response Statuses

Status Meaning Description Schema
200 OK An encounter object. Encounter
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Retrieve a List of Encounters

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/encounter/v1/populations/005769fa-ffc0-11e7-a3d6-46705f8c9e77/patients/ae5769fa-ffc0-11e7-a3d6-46705f8c9e77/encounters', headers: headers)

print JSON.pretty_generate(result)


# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/encounter/v1/populations/005769fa-ffc0-11e7-a3d6-46705f8c9e77/patients/ae5769fa-ffc0-11e7-a3d6-46705f8c9e77/encounters \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "47f126a0-1b03-3d9d-8455-3aa71c090d5d",
      "sourceIdentifier": {
        "dataPartitionId": "e5f34c23-e572-44c3-a2cd-7ca358dcec9f",
        "id": "7209f9fb-3a5d-44c1-8dbb-123f340a9850"
      },
      "aliases": [
        {
          "value": "1831-176692",
          "computationalValue": "1831176692",
          "renderedValue": "****176692",
          "system": "1.1.16.6.0",
          "type": {
            "sourceCodings": [
              {
                "system": "urn:cerner:coding:codingsystem:codeset:319",
                "code": "777",
                "display": "FIN NBR"
              }
            ],
            "codings": [
              {
                "system": "2.16.840.1.113883.12.203",
                "code": "AN",
                "display": "Account number"
              }
            ],
            "text": "FIN NBR"
          }
        }
      ],
      "reasonForVisit": {
        "sourceCodings": [],
        "codings": [],
        "text": "Heart valve disorder"
      },
      "reasonCodes": [
        {
          "sourceCodings": [],
          "codings": [],
          "text": "Heart valve disorder"
        },
        {
          "sourceCodings": [
            {
              "system": "2.16.840.1.113883.6.96",
              "code": "35314007",
              "display": "Hurricane (event)"
            }
          ],
          "codings": [
            {
              "system": "2.16.840.1.113883.6.96",
              "code": "35314007",
              "display": "Hurricane (event)"
            }
          ]
        }
      ],
      "estimatedArrivalOn": "2018-04-21T16:00:00Z",
      "actualArrivalOn": "2018-04-21T16:14:53Z",
      "admittedOn": "2018-04-21T16:50:18Z",
      "period": {
        "start": "2018-04-21T16:14:53Z",
        "end": "2018-04-23T10:09:10Z"
      },
      "admissionSource": {
        "sourceCodings": [
          {
            "system": "urn:cerner:coding:codingsystem:codeset:2",
            "code": "9999",
            "display": "Physician Referral"
          }
        ],
        "codings": [
          {
            "system": "2.16.840.1.113883.12.23",
            "code": "1",
            "display": "Physician referral"
          }
        ],
        "text": "Physician Referral"
      },
      "estimatedDepartureOn": "2018-04-23T10:00:00Z",
      "dischargedOn": "2018-04-23T10:09:10Z",
      "dischargeDisposition": {
        "sourceCodings": [
          {
            "system": "urn:cerner:coding:codingsystem:codeset:19",
            "code": "638671",
            "display": "Home"
          }
        ],
        "codings": [
          {
            "system": "2.16.840.1.113883.12.112",
            "code": "01",
            "display": "Discharged to home or self care (routine discharge)"
          }
        ],
        "text": "Home"
      },
      "dischargeToLocation": {
        "sourceCodings": [
          {
            "system": "urn:cerner:coding:codingsystem:codeset:20",
            "code": "264362003",
            "display": "Home"
          }
        ],
        "codings": [
          {
            "system": "2.16.840.1.113883.6.96",
            "code": "264362003",
            "display": "Home (environment)"
          }
        ],
        "text": "Home"
      },
      "priority": {
        "sourceCodings": [
          {
            "system": "urn:cerner:coding:codingsystem:codeset:1304",
            "code": "S",
            "display": "Stat (do immediately)"
          }
        ],
        "codings": [
          {
            "system": "2.16.840.1.113883.12.27",
            "code": "S",
            "display": "Stat (do immediately)"
          }
        ],
        "text": "Stat (do immediately)"
      },
      "status": {
        "sourceCodings": [
          {
            "system": "urn:cerner:coding:codingsystem:codeset:261",
            "code": "856",
            "display": "Discharged"
          }
        ],
        "codings": [
          {
            "system": "2.16.840.1.113883.5.14",
            "code": "completed",
            "display": "null"
          }
        ],
        "text": "Discharged"
      },
      "participants": [
        {
          "provider": {
            "aliases": [
              {
                "system": "2.16.840.1.113883.4.6",
                "type": "NPI",
                "value": "1831176692"
              }
            ],
            "name": {
              "prefix": "Dr.",
              "given": [
                "Jane",
                "Susannah"
              ],
              "family": [
                "Smith"
              ],
              "suffix": "MD.",
              "formatted": "Dr. Jane Susannah Smith MD."
            }
          },
          "type": {
            "sourceCodings": [
              {
                "system": "urn:cerner:coding:codingsystem:codeset:333",
                "code": "1111",
                "display": "Attending Physician"
              }
            ],
            "codings": [
              {
                "system": "2.16.840.1.113883.12.443",
                "code": "AT",
                "display": "Attending"
              }
            ],
            "text": "Attending Physician"
          },
          "effectivePeriod": {
            "start": "2018-04-21T16:50:18Z",
            "end": "2018-04-23T10:09:10Z"
          }
        }
      ],
      "provenances": [
        {
          "entities": [
            {
              "role": {
                "sourceCodings": [
                  {
                    "code": "source",
                    "system": "2.16.840.1.113883.4.642.4.437",
                    "display": "Source"
                  }
                ],
                "codings": [
                  {
                    "code": "source",
                    "system": "2.16.840.1.113883.4.642.4.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.4.1131",
                    "display": "Author"
                  }
                ],
                "codings": [
                  {
                    "code": "author",
                    "system": "2.16.840.1.113883.4.642.4.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"
        }
      ],
      "services": [
        {
          "service": {
            "sourceCodings": [
              {
                "system": "urn:cerner:coding:codingsystem:codeset:34",
                "code": "333333",
                "display": "CAR - Cardiology"
              }
            ],
            "codings": [
              {
                "system": "2.16.840.1.113883.6.96",
                "code": "3471000175103",
                "display": "Cardiology service"
              }
            ],
            "text": "CAR - Cardiology"
          },
          "effectivePeriod": {
            "start": "2018-04-21T16:50:18Z",
            "end": "2018-04-23T10:09:10Z"
          }
        }
      ],
      "types": [
        {
          "type": {
            "sourceCodings": [
              {
                "system": "urn:cerner:coding:codingsystem:codeset:71",
                "code": "33333",
                "display": "ER - Emergency"
              }
            ],
            "codings": [
              {
                "system": "2.16.840.1.113883.12.4",
                "code": "E",
                "display": "Emergency"
              }
            ],
            "text": "ER - Emergency"
          },
          "classification": {
            "sourceCodings": [
              {
                "system": "urn:cerner:coding:codingsystem:codeset:69",
                "code": "888",
                "display": "Emergency"
              }
            ],
            "codings": [
              {
                "system": "2.16.840.1.113883.12.4",
                "code": "E",
                "display": "Emergency"
              }
            ],
            "text": "Emergency"
          },
          "effectivePeriod": {
            "start": "2018-04-21T16:14:53Z",
            "end": "2018-04-21T16:50:18Z"
          }
        },
        {
          "type": {
            "sourceCodings": [
              {
                "system": "urn:cerner:coding:codingsystem:codeset:71",
                "code": "309308",
                "display": "Inpatient"
              }
            ],
            "codings": [
              {
                "system": "2.16.840.1.113883.12.4",
                "code": "I",
                "display": "Inpatient"
              }
            ],
            "text": "Inpatient"
          },
          "classification": {
            "sourceCodings": [
              {
                "system": "urn:cerner:coding:codingsystem:codeset:69",
                "code": "391",
                "display": "Inpatient"
              }
            ],
            "codings": [
              {
                "system": "2.16.840.1.113883.12.4",
                "code": "I",
                "display": "Inpatient"
              }
            ],
            "text": "Inpatient"
          },
          "effectivePeriod": {
            "start": "2018-04-21T16:50:18Z",
            "end": "2018-04-23T10:09:10Z"
          }
        }
      ],
      "organization": {
        "aliases": [
          {
            "value": "151579",
            "type": "EXTERNAL",
            "system": "1.2.3.4.5.6.7.8.9.10.1"
          }
        ],
        "name": "Rockcreek Clinic"
      }
    }
  ],
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/encounter/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/a2f6a16d-1331-4ccc-8f70-6c4d953ba70b/encounters?limit=20",
  "nextLink": "https://cernerdemo.api.us-1.healtheintent.com/encounter/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/a2f6a16d-1331-4ccc-8f70-6c4d953ba70b/encounters?cursor=47f126a0-1b03-3d9d-8455-3aa71c090d5d&limit=20"
}

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

Retrieves a list of the encounters 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 0 A marker indicating the position of the last item retrieved for a response. 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. -
provenance query string false source Returns only encounters whose provenance entity role matches the specified code. If no explicit provenance is specified, the default value is source. source, derivation
status query array[string] false N/A Filters the list based on the status field. MISSING, ACTIVE_SUBSET_QUAL, NEGATION_PROCEDURE_QUAL, IN_ERROR_NEVER_ACTIVE_SUBSET_QUAL
type query array[string] false N/A The alias values for encounter type concepts by which results should be filtered. ENCOUNTER_EMERGENCY_DEPT_ENC, ENCOUNTER_EXTENDED_CARE_ENC, ENCOUNTER_GP_EPISODE_ENC, ENCOUNTER_HOSPICE_ENC, ENCOUNTER_INPATIENT_ENC, ENCOUNTER_NURSING_FACILITY_ENC, ENCOUNTER_OBSERVATION_ENC, ENCOUNTER_OUTPATIENT_ENC, ENCOUNTER_PHARMACY_ENC, ENCOUNTER_REHABILITATION_ENC, ENCOUNTER_THERAPEUTIC_SERVICE_ENC, ENCOUNTER_TRANSPORT_SERVICE_ENC, ENCOUNTER_VIRTUAL_ENC

Response Statuses

Status Meaning Description Schema
200 OK A collection of encounter objects. Encounters
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Schema Definitions

Encounter

Name Type Required Description Accepted Values
id string true The unique ID of the encounter. -
sourceIdentifier SourceIdentifier false An ID that uniquely identifies this encounter for a patient in a data partition. -
aliases [EncounterAlias] true The list of encounter aliases. -
reasonForVisit CodeableConcept false The reason why the encounter takes place. Note: reasonForVisit is being deprecated in the favor of reasonCodes. -
reasonCodes [CodeableConcept] false The list of reasons why the encounter takes place. -
estimatedArrivalOn string false The estimated date and time when the patient arrived for the encounter. In International Organization for Standardization (ISO) 8601 formatting with precision ranging from YYYY to YYYY-MM-DDThh:mm:ss.SSSZ. -
actualArrivalOn string false The actual date and time when the patient arrived for the encounter. In ISO 8601 formatting with precision ranging from YYYY to YYYY-MM-DDThh:mm:ss.SSSZ. -
admittedOn string false The inpatient admission date and time of the encounter. This can differ from the actualArrivalOn field, for example, if the encounter began in the emergency department and then the patient was admitted to the hospital as an inpatient. In ISO 8601 formatting with precision ranging from YYYY to YYYY-MM-DDThh:mm:ss.SSSZ. -
period EncounterPeriod true The start and end date of the encounter. The start date should be equivalent to the actual arrival unless it is unknown, in which case it defaults to the estimated arrival. The end date should be equivalent to the discharge date unless it is unknown, in which case it defaults to the estimated departure. In ISO 8601 formatting with precision ranging from YYYY to YYYY-MM-DDThh:mm:ss.SSSZ. -
admissionSource CodeableConcept false The place the patient came from before the patient was admitted to the current location. This typically applies to inpatient encounters when the patient was transferred from another facility. -
estimatedDepartureOn string false The estimated discharge date (for inpatient encounters) or departure date (for outpatient encounters). In ISO 8601 formatting with precision ranging from YYYY to YYYY-MM-DDThh:mm:ss.SSSZ. -
dischargedOn string false The date and time when the patient was discharged from the care facility. In ISO 8601 formatting with precision ranging from YYYY to YYYY-MM-DDThh:mm:ss.SSSZ. -
dischargeDisposition CodeableConcept false The disposition of the patient at discharge of the encounter. -
dischargeToLocation CodeableConcept false The type or kind of location to which the patient was discharged. -
priority CodeableConcept false The urgency of the encounter. -
status CodeableConcept false The status of the encounter, for example, active, hold, discharged, or cancelled. This can also include its HealtheIntent ontological concept or concepts. -
participants [Participant] true A list of providers related to this encounter and the duration of their participation. Participants are sorted in descending order by start date. -
provenances [Provenance] true The record-keeping assertions about the context in which the information in this encounter 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 encounter was derived, if applicable). -
services [HospitalService] true A list of all medical services rendered during the encounter and the duration of when they were rendered. Services are sorted in descending order by start date. -
types [EncounterType] true A list of encounter types to reflect the encounter-type change history. Encounter types are sorted in descending order by start date. -
organization Organization false The organization of the service provider who is the custodian of this encounter record and is in charge of maintaining the information of this encounter. This organization is not always the same as the place of service. For example, when an ambulatory provider visits a patient in the hospital, the place of service is the hospital and the service provider organization is the ambulatory organization. -

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 encounter for a patient in a data partition. -

EncounterAlias

Name Type Required Description Accepted Values
value string true The ID issued by the assigning authority. The formatting may vary by alias type. -
computationalValue string false The formatted version of the alias value that is unique in the system and can be used for computational mapping (for example, removing nonsignificant whitespace, dashes, and so on). -
renderedValue string false The rendered version of the alias value intended for human display. -
system string false The authority responsible for assigning the alias value. Alias values may be unique in each system but not across systems. -
type CodeableConcept false The type of the alias, for example, financial number (FIN). -

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. -
concepts [Concept] false The list of ontological concepts derived from the codified values from standard code systems 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. -

Concept

Name Type Required Description Accepted Values
alias string true The unique ID of the concept in a context. -
contextId string true The unique ID of the context. IDs are all uppercase and do not include dashes. -

EncounterPeriod

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

Participant

Name Type Required Description Accepted Values
provider Provider true A provider related to this encounter. -
type CodeableConcept false The role of the participant in the encounter. -
effectivePeriod EffectivePeriod false The effective time period for the provider relationship. -

Provider

Name Type Required Description Accepted Values
aliases [ProviderAlias] false A list of IDs for the provider, such as the ten-digit 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 false The type of alias. The type value must match one of the accepted values for this field. Otherwise, it is excluded. 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. -

EffectivePeriod

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

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 document reference entity used in the provenance activity. -

DocumentReferenceId

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

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

HospitalService

Name Type Required Description Accepted Values
service CodeableConcept true The hospital service provided during the encounter. -
effectivePeriod EffectivePeriod false The effective time period for the service. -

EncounterType

Name Type Required Description Accepted Values
type CodeableConcept false The type of the encounter, such as inpatient, outpatient, or recurring patient. The type can be more specific than classification. -
classification CodeableConcept false The classification of the encounter, such as inpatient or outpatient. -
effectivePeriod EffectivePeriod false The effective time period for the encounter type. -

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

Encounters

Name Type Required Description Accepted Values
items [Encounter] true [Retrieves a single encounter by ID.] -
firstLink string true The first page of results. -
nextLink string false The next page of results. -