REST API for Oracle Healthcare Translational Research

Retrieve Demographics for a Patient Identifier

get

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

This endpoint supports the retrieval of Demographics for a Patient Identifier. It returns Patient Demographic information like Name, Telecom, Marital Status, Gender, Deceased Date, Birth Date, Address, Race, Ethnicity and other Demographics associated information.

Request

Supported Media Types

application/json
application/xml

Path Parameters

id: Type: integer (int64)

Required: true

Patient Identifier

Response

Supported Media Types

application/json
application/xml

200 Response

successful operation

Body

Model for a Patient object in CDM.

Root Schema : Patient

Type: object

Model for a Patient object in CDM.

Properties

address: Type: object Address

Model for a postal address.
birthDate: Type: string (date-time)

Date of Birth
deceasedBoolean: Type: boolean

Default Value: false

Alive or Deceased
deceasedDate: Type: string (date-time)

Deceased Date
ethnicity: Type: object LinkedReference
gender: 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.
identifiers: Type: array identifiers

A list of identifiers assigned to this patient
maritalStatus: 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.
name: Type: object HumanName

Model for a name of a human with text and parts information.
race: Type: object LinkedReference
subject: Type: object LinkedReference
telecom: Type: object Telecom

Nested Schema : Address

Type: object

Model for a postal address.

Properties

city: Type: string

Name of city, town etc.
country: 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.
district: Type: string

District name (aka county).
line: Type: array line

Street name, number, direction & P.O. Box etc.
postalCode: Type: string

Postal code for area.
state: 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 : 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 : identifiers

Type: array

A list of identifiers assigned to this patient

Items

Type: object Identifier

Identifier assigned by a given system

Nested Schema : HumanName

Type: object

Model for a name of a human with text and parts information.

Properties

family: Type: string

Family name (often called 'Surname').
given: Type: array given

Given names (not always 'first'). Includes middle names.
text: Type: string

Text representation of the full name.

Nested Schema : Telecom

Type: object

Properties

use: 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.
value: Type: string

Telecom Value

Nested Schema : line

Type: array

Street name, number, direction & P.O. Box etc.

Items

Type: string

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

Type: array

Given names (not always 'first'). Includes middle names.

Items

Type: string

400 Response

Invalid parameters supplied

404 Response

Patient(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

Example of Response Body

The following example shows the response returned in JSON format.

{
  "identifiers": [
    {
      "system": "CDM",
      "value": "1"
    },
    {
      "system": "Customer Defined",
      "value": "P1_1"
    }
  ],
  "name": {
    "text": "James MN1 Young",
    "family": "Young",
    "given": [
      "James",
      "MN1"
    ]
  },
  "telecom": {
    "value": "info@oracle.com",
    "use": {
      "coding": [
        {
          "code": "CNTCT_INFO_SUBTYP_EML",
          "display": "Email",
          "description": "Communicate electronically on the computer",
          "sysId": "EHA_CUSTOM_CD_SYS",
          "sysName": "EHA Custom Code System",
          "sysVersion": "1"
        }
      ]
    }
  },
  "gender": {
    "coding": [
      {
        "code": "1",
        "display": "Male",
        "description": "Male",
        "sysId": "EHA_CUSTOM_CD_SYS",
        "sysName": "EHA Custom Code System",
        "sysVersion": "1"
      }
    ]
  },
  "birthDate": "01/01/1945",
  "deceasedBoolean": false,
  "maritalStatus": {
    "coding": [
      {
        "code": "1",
        "display": "Married",
        "description": "Married",
        "sysId": "EHA_CUSTOM_CD_SYS",
        "sysName": "EHA Custom Code System",
        "sysVersion": "1"
      }
    ]
  },
  "address": {
    "line": [
      "SADD11",
      "SADD21",
      "SADD31"
    ],
    "city": "C1",
    "district": "C1",
    "state": {
      "coding": [
        {
          "code": "1",
          "display": "State1",
          "description": "State1DESC",
          "sysId": "EHA_CUSTOM_CD_SYS",
          "sysName": "EHA Custom Code System",
          "sysVersion": "1"
        }
      ]
    },
    "postalCode": "Z1",
    "country": {
      "coding": [
        {
          "code": "1",
          "display": "USA",
          "description": "United State of America",
          "sysId": "EHA_CUSTOM_CD_SYS",
          "sysName": "EHA Custom Code System",
          "sysVersion": "1"
        }
      ]
    }
  },
  "race": {
    "reference": "/HSDataService-web/api/3.2.0/patientapi/patients/1/race"
  },
  "ethnicity": {
    "reference": "/HSDataService-web/api/3.2.0/patientapi/patients/1/ethnicity"
  },
  "subject": {
    "reference": "/HSDataService-web/api/3.2.0/patientapi/patients/1/subjects"
  }
}