REST API for Oracle Healthcare Translational Research

Retrieve Ethnicity for a Subject Identifier

get

/HSDataService-web/api/3.2.0/subjectapi/subjects/{id}/ethnicity

This endpoint supports the retrieval of Ethnicities for a single Subject Identifier passed. It returns all the Ethnicity related information like Value Code.

Request

Supported Media Types

application/json
application/xml

Path Parameters

id: Type: integer (int64)

Required: true

Subject 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 : PageableCollectionEthnicity

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 Ethnicity

Model for a Ethnicity 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 : Ethnicity

Type: object

Model for a Ethnicity object in CDM.

Properties

identifier: Type: object Identifier

Identifier assigned by a given system
patient: Type: object LinkedReference
subject: Type: object LinkedReference
valueCode: 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 : 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 : 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

Ethnicitys(s) not found

Examples

The following example submits a GET request.

API URL

http://localhost:7001/HSDataService-web/api/3.2.0/subjectapi/subjects/4/ethnicity

Example of Response Body

The following example shows the response returned in JSON format.

 {
  "resourceType" : "Ethnicity",
  "items" : [ {
    "identifier" : {
      "system" : "CDM",
      "value" : "1"
    }, 

    "valueCode" : {
      "coding" : [ {
        "code" : "Ethnicity1",
        "display" : "Ethnicity1Name",
        "description" : "Ethnicity Desc",
        "sysId" : "EHA_CUSTOM_CD_SYS",
        "sysName" : "EHA Custom Code System",
        "sysVersion" : "1"
      } ]
    },

    "subject" : {
      "reference" : "/HSDataService-web/api/3.2.0/subjectapi/subjects/4"
    },
    "patient" : {
      "reference" : "/HSDataService-web/api/3.2.0/subjectapi/subjects/4/patients"
    }
  }, {

    "identifier" : {
      "system" : "CDM",
      "value" : "10"
    },

    "valueCode" : {
      "coding" : [ {
        "code" : "Ethnicity10",
        "display" : "Ethnicity10Name",
        "description" : "Ethnicity Desc",
        "sysId" : "EHA_CUSTOM_CD_SYS",
        "sysName" : "EHA Custom Code System",
        "sysVersion" : "1"
      } ]

    },

    "subject" : {
      "reference" : "/HSDataService-web/api/3.2.0/subjectapi/subjects/4"
    },
    "patient" : {
      "reference" : "/HSDataService-web/api/3.2.0/subjectapi/subjects/4/patients"
    }
  }, {

    "identifier" : {
      "system" : "CDM",
      "value" : "2"
    },

    "valueCode" : {
      "coding" : [ {
        "code" : "Ethnicity2",
        "display" : "Ethnicity2Name",
        "description" : "Ethnicity Desc",
        "sysId" : "EHA_CUSTOM_CD_SYS",
        "sysName" : "EHA Custom Code System",
        "sysVersion" : "1"
      } ]

    },

    "subject" : {
      "reference" : "/HSDataService-web/api/3.2.0/subjectapi/subjects/4"
    },
    "patient" : {
      "reference" : "/HSDataService-web/api/3.2.0/subjectapi/subjects/4/patients"
    }
  }, {
    "identifier" : {
      "system" : "CDM",
      "value" : "3"
    },

    "valueCode" : {
      "coding" : [ {
        "code" : "Ethnicity3",
        "display" : "Ethnicity3Name",
        "description" : "Ethnicity Desc",
        "sysId" : "EHA_CUSTOM_CD_SYS",
        "sysName" : "EHA Custom Code System",
        "sysVersion" : "1"
      } ]
    },

    "subject" : {
      "reference" : "/HSDataService-web/api/3.2.0/subjectapi/subjects/4"
    },
    "patient" : {
      "reference" : "/HSDataService-web/api/3.2.0/subjectapi/subjects/4/patients"
    }
  }, {
    "identifier" : {
      "system" : "CDM",
      "value" : "4"
    },
    "valueCode" : {
      "coding" : [ {
        "code" : "Ethnicity4",
        "display" : "Ethnicity4Name",
        "description" : "Ethnicity Desc",
        "sysId" : "EHA_CUSTOM_CD_SYS",
        "sysName" : "EHA Custom Code System",
        "sysVersion" : "1"
      } ]
    },

    "subject" : {
      "reference" : "/HSDataService-web/api/3.2.0/subjectapi/subjects/4"
    },
    "patient" : {
      "reference" : "/HSDataService-web/api/3.2.0/subjectapi/subjects/4/patients"
    }
  }, {
    "identifier" : {
      "system" : "CDM",
      "value" : "5"
    },

    "valueCode" : {
      "coding" : [ {
        "code" : "Ethnicity5",
        "display" : "Ethnicity5Name",
        "description" : "Ethnicity Desc",
        "sysId" : "EHA_CUSTOM_CD_SYS",
        "sysName" : "EHA Custom Code System",
        "sysVersion" : "1"
      } ]

    },
    "subject" : {
      "reference" : "/HSDataService-web/api/3.2.0/subjectapi/subjects/4"
    },
    "patient" : {
      "reference" : "/HSDataService-web/api/3.2.0/subjectapi/subjects/4/patients"
    }

  }, {
    "identifier" : {
      "system" : "CDM",
      "value" : "6"
    },

    "valueCode" : {
      "coding" : [ {
        "code" : "Ethnicity6",
        "display" : "Ethnicity6Name",
        "description" : "Ethnicity Desc",
        "sysId" : "EHA_CUSTOM_CD_SYS",
        "sysName" : "EHA Custom Code System",
        "sysVersion" : "1"
      } ]

    },

    "subject" : {
      "reference" : "/HSDataService-web/api/3.2.0/subjectapi/subjects/4"
    },

    "patient" : {
      "reference" : "/HSDataService-web/api/3.2.0/subjectapi/subjects/4/patients"
    }
  }, {

    "identifier" : {
      "system" : "CDM",
      "value" : "7"
    },

    "valueCode" : {
      "coding" : [ {
        "code" : "Ethnicity7",
        "display" : "Ethnicity7Name",
        "description" : "Ethnicity Desc",
        "sysId" : "EHA_CUSTOM_CD_SYS",
        "sysName" : "EHA Custom Code System",
        "sysVersion" : "1"
      } ]

    },
    "subject" : {
      "reference" : "/HSDataService-web/api/3.2.0/subjectapi/subjects/4"
    },
    "patient" : {
      "reference" : "/HSDataService-web/api/3.2.0/subjectapi/subjects/4/patients"
    }
  }, {

    "identifier" : {
      "system" : "CDM",
      "value" : "8"
    },

    "valueCode" : {
      "coding" : [ {
        "code" : "Ethnicity8",
        "display" : "Ethnicity8Name",
        "description" : "Ethnicity Desc",
        "sysId" : "EHA_CUSTOM_CD_SYS",
        "sysName" : "EHA Custom Code System",
        "sysVersion" : "1"
      } ]
    },

    "subject" : {
      "reference" : "/HSDataService-web/api/3.2.0/subjectapi/subjects/4"
    },

    "patient" : {
      "reference" : "/HSDataService-web/api/3.2.0/subjectapi/subjects/4/patients"
    }

  }, {
    "identifier" : {
      "system" : "CDM",
      "value" : "9"
    },

    "valueCode" : {
      "coding" : [ {
        "code" : "Ethnicity9",
        "display" : "Ethnicity9Name",
        "description" : "Ethnicity Desc",
        "sysId" : "EHA_CUSTOM_CD_SYS",
        "sysName" : "EHA Custom Code System",
        "sysVersion" : "1"
      } ]

    },

    "subject" : {
      "reference" : "/HSDataService-web/api/3.2.0/subjectapi/subjects/4"
    },

    "patient" : {
      "reference" : "/HSDataService-web/api/3.2.0/subjectapi/subjects/4/patients"
    }
  } ],

  "count" : 10,
  "hasMore" : false,
  "links" : [ {
    "rel" : "self",
    "href" : "http://localhost:7001/HSDataService-web/api/3.2.0/subjectapi/subjects/4/ethnicity"
  } ]

}