NAV Navbar
Logo cerner
Ruby Shell

Encounter API v1

The HealtheIntent Encounter API allows systems to interact with encounters 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/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.healtheintent.com/encounter/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/a2f6a16d-1331-4ccc-8f70-6c4d953ba70b/encounters/9223350710483575807021bc72d0c51a99c7fe05109f2ebf4340bfc838b1821e4cf7297c99b05d73558', headers: headers)

print JSON.pretty_generate(result)


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

Example response

{
  "id": "f6ca33a808884274f609b5ae4d5f77c71a1b0b7d3f1d071c2acb78e18c1e6d77",
  "sourceIdentifier": [
    {
      "dataPartitionId": "e5f34c23-e572-44c3-a2cd-7ca358dcec9f",
      "id": "7209f9fb-3a5d-44c1-8dbb-123f340a9850"
    }
  ],
  "aliases": [
    {
      "value": "16",
      "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"
      },
      "system": "1.1.16.6"
    }
  ],
  "reasonForVisit": {
    "sourceCodings": [],
    "codings": [],
    "text": "Heart valve disorder"
  },
  "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"
      }
    }
  ],
  "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.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.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": "f6ca33a808884274f609b5ae4d5f77c71a1b0b7d3f1d071c2acb78e18c1e6d77",
      "sourceIdentifier": [
        {
          "dataPartitionId": "e5f34c23-e572-44c3-a2cd-7ca358dcec9f",
          "id": "7209f9fb-3a5d-44c1-8dbb-123f340a9850"
        }
      ],
      "aliases": [
        {
          "value": "16",
          "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"
          },
          "system": "1.1.16.6"
        }
      ],
      "reasonForVisit": {
        "sourceCodings": [],
        "codings": [],
        "text": "Heart valve disorder"
      },
      "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"
          }
        }
      ],
      "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.healtheintent.com/encounter/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/a2f6a16d-1331-4ccc-8f70-6c4d953ba70b/encounters?limit=20",
  "nextLink": "https://cernerdemo.api.us.healtheintent.com/encounter/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/a2f6a16d-1331-4ccc-8f70-6c4d953ba70b/encounters?cursor=f6ca33a808884274f609b5ae4d5f77c71a1b0b7d3f1d071c2acb78e18c1e6d77&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 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 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 the same data partition. -
aliases [EncounterAlias] true The list of encounter aliases. -
reasonForVisit CodeableConcept false The reason 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. -
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. -
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 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, such as when an ambulatory provider visits a patient in the hospital. While the place of service is the hospital, the service provider organization is the ambulatory organization. -

SourceIdentifier

Name Type Required Description Accepted Values
dataPartitionId string false The identifier of the source data partition. -
id string false The unique identifier for the entity in the 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. -
type CodeableConcept false The type of the alias, for example, financial number (FIN). -
system string false The authority responsible for assigning the alias value. Alias values may be unique in each system but not across systems. -

CodeableConcept

Name Type Required Description Accepted Values
codings [Code] false A list of codified values from standard code systems recognized by HealtheIntent. -
sourceCodings [Code] false 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 false The unique identifier of the code. -
display string false A human-readable representation of the code. -
system string false The identifier of the coding system that gives meaning to the code. -

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 identifiers of the provider, such as the ten-digit National Provider Identifier (NPI) of the provider or the Drug Enforcement Administration (DEA) number of the provider. -
name ProviderName false The name of the provider. -

ProviderAlias

Name Type Required Description Accepted Values
system string false Authority responsible for assigning the identifier. -
value string false The value or identifier within the context of the assigning authority. -
type string false The type of alias. DEA, EXTERNAL, NPI, SL, TAX, UPIN

ProviderName

Name Type Required Description Accepted Values
prefix string false The prefix portion of the provider’s name; such as Mr., Mrs., Dr., etc. -
given [string] false A list of given name portions of the provider’s name. If a person has a first name and a middle name, the first name should be the first item in the list and the middle name should be the second item in the list. -
family [string] false A list of family (i.e. last) name portions of the provider’s name. Some may have multiple family names. -
suffix string false The suffix portion of the provider’s name; such as Jr., Sr., MD., RN., etc. -
formatted string false The 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. -

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

Organization

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

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 in each system but not across systems. -

Error

Name Type Required Description Accepted Values
code integer(int32) true Http response status code representing the error. -
message string true Human readable description of the error. -
errorDetails [ErrorDetail] false 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 Codified value representing the specific error resulting in the current error status. -
message string false Human readable description of an error. -
locationType string false Location or type of the field that caused an error. query, header, path, formData, body
location string false Name of the field that caused an error. -

Encounters

Name Type Required Description Accepted Values
items [Encounter] true No description -
firstLink string true The first page of results. -
nextLink string false The next page of results. -