REST API for Oracle Healthcare Translational Research

Retrieve Clinical Encounters for a Patient Identifier

get

/HSDataService-web/api/3.2.0/patientapi/patients/{id}/encounters

This endpoint supports the retrieval of Clinical Encounters for a single Patient Identifier passed. It returns Clinical Encounter information like Type, Encounter Number, Location and other Clinical Encounter associated information.

Request

Supported Media Types

application/json
application/xml

Path Parameters

id: Type: integer (int64)

Required: true

Patient Row ID

Query Parameters

limit: Type: integer (int32)

Pagination query params: ?limit=2&offset=0
offset: Type: integer (int32)

Pagination query params: ?limit=2&offset=0

Response

Supported Media Types

application/json
application/xml

200 Response

successful operation

Body

Model for paginated collections of data.

Root Schema : PageableCollectionClinicalEncounter

Type: object

Model for paginated collections of data.

Properties

count: Type: integer (int64)

Number of objects in the 'items' collection.
hasMore: Type: boolean

Default Value: false

A boolean indicating if more pages are available.
items: Type: array items

A collection of paged items.
links: Type: array links

A collection of links containing hrefs to the current, next, and previous pages as applicable.
resourceType: Type: string

Identify the resource type

Nested Schema : items

Type: array

A collection of paged items.

Items

Type: object ClinicalEncounter

Model for a clinical encounter object in CDM.

Nested Schema : links

Type: array

A collection of links containing hrefs to the current, next, and previous pages as applicable.

Example

{rel: 'next',href: '/patientapi/patients?limit=100&offset=300'}

Items

Type: string

Nested Schema : ClinicalEncounter

Type: object

Model for a clinical encounter object in CDM.

Properties

encounterNumber: Type: string

Encounter Number
identifier: Type: object Identifier

Identifier assigned by a given system
location: Type: object Location
patient: Type: object LinkedReference
period: Type: object DateRange
type: Type: object CodeableConcept

Model that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text.

Nested Schema : Identifier

Type: object

Identifier assigned by a given system

Properties

system: Type: string

System which assigned this identifier
value: Type: string

Identifier value

Nested Schema : Location

Type: object

Properties

identifier: Type: object CdmIdentifier

Identifier assigned by a given system
name: Type: string

Name of the facility.
type: Type: object CodeableConcept

Model that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text.

Nested Schema : LinkedReference

Type: object

Properties

display: Type: string
reference: Type: string

Nested Schema : DateRange

Type: object

Properties

end: Type: string (date-time)
start: Type: string (date-time)

Nested Schema : CodeableConcept

Type: object

Model that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text.

Properties

coding: Type: array coding

Read Only: true

Code(s) defined by a terminology system.
text: Type: string

Plain text representation of the concept.

Nested Schema : CdmIdentifier

Type: object

Identifier assigned by a given system

Properties

system: Type: string

System which assigned this identifier
value: Type: string

Identifier value

Nested Schema : coding

Type: array

Read Only: true

Code(s) defined by a terminology system.

Items

Type: object Coding

Model for a reference to a code defined by a terminology system.

Nested Schema : Coding

Type: object

Model for a reference to a code defined by a terminology system.

Properties

code: Type: string

Symbol in syntax defined by the system.
description: Type: string

Description defined by the system.
display: Type: string

Representation defined by the system.
sysId: Type: string

Identity of the terminology system.
sysName: Type: string

Name of the terminology system.
sysVersion: Type: string

Version of the system - if relevant.

400 Response

Invalid parameters supplied

404 Response

Encounter(s) not found

Examples

The following example submits a GET request.

API URL

http://localhost:7001/HSDataService-web/api/3.2.0/patientapi/patients/1/encounters?limit=2&offset=0

Example of Response Body

The following example shows the response returned in JSON format.

{
 "resourceType": "Encounter",
  "items": [
    {
      "identifier": {
        "system": "CDM",
        "value": "1"
      },
      "type": {
        "coding": [
          {
            "code": "1",
            "display": "ENC_TYPE1",
            "description": "ENC_TYPE_DESC1",
            "sysId": "EHA_CUSTOM_CD_SYS",
            "sysName": "EHA Custom Code System",
            "sysVersion": "1"
          }
        ]
      },
      "location": {
        "identifier": {
          "system": "CDM",
          "value": "1"
        },
        "name": "FAC1",
        "type": {
          "coding": [
            {
              "code": "FAC_SUBTYP_RM",
              "display": "Room",
              "description": "A space allocated for a function within a building or a floor",
              "sysId": "EHA_CUSTOM_CD_SYS",
              "sysName": "EHA Custom Code System",
              "sysVersion": "1"
            }
          ]
        }
      },
      "patient": {
        "reference": "/HSDataService-web/api/3.2.0/patientapi/patients/1"
      },
      "period": {
        "start": "01/01/1998",
        "end": "12/01/1998"
      },
      "encounterNumber": "ENC1"
    },
    {
      "identifier": {
        "system": "CDM",
        "value": "2"
      },
      "type": {
        "coding": [
          {
            "code": "1",
            "display": "ENC_TYPE1",
            "description": "ENC_TYPE_DESC1",
            "sysId": "EHA_CUSTOM_CD_SYS",
            "sysName": "EHA Custom Code System",
            "sysVersion": "1"
          }
        ]
      },
      "location": {
        "identifier": {
          "system": "CDM",
          "value": "1"
        },
        "name": "FAC1",
        "type": {
          "coding": [
            {
              "code": "FAC_SUBTYP_RM",
              "display": "Room",
              "description": "A space allocated for a function within a building or a floor",
              "sysId": "EHA_CUSTOM_CD_SYS",
              "sysName": "EHA Custom Code System",
              "sysVersion": "1"
            }
          ]
        }
      },
      "patient": {
        "reference": "/HSDataService-web/api/3.2.0/patientapi/patients/1"
      },
      "period": {
        "start": "01/01/1998",
        "end": "12/01/1998"
      },
      "encounterNumber": "ENC1"
    }
  ],
  "count": 2,
  "hasMore": true,
  "links": [
    {
      "rel": "self",
      "href": "http://localhost:7001/HSDataService-web/api/3.2.0/patientapi/patients/1/encounters?limit=2&offset=0"
    },
    {
      "rel": "next",
      "href": "http://localhost:7001/HSDataService-web/api/3.2.0/patientapi/patients/1/encounters?offset=2&limit=2"
    }
  ]
}