REST API for Oracle Healthcare Translational Research

Retrieve History for Patient Identifiers

get

/HSDataService-web/api/3.2.0/patientapi/patients/history

This endpoint supports the retrieval of Histories for multiple Patient Identifiers passed. It returns History related information like Code, Category and other associated information.

Request

Supported Media Types

application/json
application/xml

Query Parameters

id

Type: array

Required: true

Collection Format: multi

Minimum Number of Items: 1

Maximum Number of Items: 2147483647

Patient Identifiers

Items

Type: integer (int64)

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 : PageableCollectionHistory

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 History

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 : History

Type: object

Properties

amount: Type: object Quantity

Model for a Quantity object in CDM.
category: 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.
code: 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.
endDate: Type: string (date-time)

History End Date
familyMemberRelationshipTypeCode: Type: object FamilyMemberRelationshipType
frequency: Type: object Quantity

Model for a Quantity object in CDM.
identifier: Type: object Identifier

Identifier assigned by a given system
patient: Type: object LinkedReference
period: Type: object DateRange
startDate: Type: string (date-time)

History Start Date
subject: Type: object LinkedReference
valueCode: Type: object ValueCode

Nested Schema : Quantity

Type: object

Model for a Quantity object in CDM.

Properties

code: Type: string

The quantity units symbol in syntax defined by the system.
description: Type: string

The quantity units description.
sysId: Type: string

The quantity units terminology system identifier.
sysName: Type: string

The quantity units terminology system name.
sysVersion: Type: string

The quantity units terminology system version.
units: Type: string

The quantity units displayable name.
value: Type: string

The numerical value of the quantity.

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 : FamilyMemberRelationshipType

Type: object

Properties

identifier: Type: object CdmIdentifier

Identifier assigned by a given system
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 : 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 : ValueCode

Type: object

Properties

identifier: Type: object CdmIdentifier

Identifier assigned by a given system
value: 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 : 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.

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

400 Response

Invalid parameters supplied

404 Response

historys not found

Examples

The following example submits a GET request.

API URL

http://localhost:7001/HSDataService-web/api/3.2.0/patientapi/patients/history?id=79&id=80

Example of Response Body

The following example shows the contents of the response body in JSON format:

{
  "resourceType": "History",
  "items": [
    {
      "identifier": {
        "system": "CDM",
        "value": "1"
      },
      "code": {
        "coding": [
          {
            "code": "9469",
            "display": "PH9469"
          }
        ]
      },
      "category": {
        "coding": [
          {
            "code": "PHTYPCD9469",
            "display": "PHTYPNM9469"
          }
        ]
      },
      "amount": {
        "units": "UOM1",
        "code": "1"
      },
      "frequency": {
        "units": "UOM1",
        "code": "1"
      },
      "period": {
        "start": "02/11/2026",
        "end": "03/03/2026"
      },
      "patient": {
        "reference": "/HSDataService-web/api/3.2.0/patientapi/patients/79"
      }
    },
    {
      "identifier": {
        "system": "CDM",
        "value": "2"
      },
      "code": {
        "coding": [
          {
            "code": "6865",
            "display": "PH6865"
          }
        ]
      },
      "category": {
        "coding": [
          {
            "code": "PHTYPCD6865",
            "display": "PHTYPNM6865"
          }
        ]
      },
      "frequency": {
        "units": "UOM1",
        "code": "1"
      },
      "period": {
        "start": "11/26/1976",
        "end": "12/16/1976"
      },
      "patient": {
        "reference": "/HSDataService-web/api/3.2.0/patientapi/patients/80"
      }
    }
  ],
  "count": 2,
  "hasMore": false,
  "links": [
    {
      "rel": "self",
      "href": "http://localhost:7001/HSDataService-web/api/3.2.0/patientapi/patients/history?id=79&id=80"
    }
  ]
}