Jump to

• Request
• Response
• Examples

Retrieve Ethnicity for a Subject Identifier

get

/ohfapi/cg/v3.3/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: integer(int64)
  Minimum Value: 0

  Subject Row ID

Query Parameters

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

Security

• basicAuth: basic
  Type: basic

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

successful operation

Body ()

Root Schema : PageableCollectionEthnicity

Type: object

Model for paginated collections of data.

Show Source

• count(optional): integer(int64)
  Number of objects in the 'items' collection.
• hasMore(optional): boolean
  A boolean indicating if more pages are available.
• items(optional): array items
  A collection of paged items.
• links(optional): array links
  A collection of links containing hrefs to the current, next, and previous pages as applicable.
• resourceType(optional): string
  Identify the resource type

{
    "type":"object",
    "properties":{
        "resourceType":{
            "type":"string",
            "description":"Identify the resource type"
        },
        "items":{
            "type":"array",
            "xml":{
                "wrapped":true
            },
            "description":"A collection of paged items.",
            "items":{
                "$ref":"#/definitions/Ethnicity"
            }
        },
        "count":{
            "type":"integer",
            "format":"int64",
            "description":"Number of objects in the 'items' collection."
        },
        "hasMore":{
            "type":"boolean",
            "description":"A boolean indicating if more pages are available."
        },
        "links":{
            "type":"array",
            "example":"{rel: 'next',href: '/patientapi/patients?limit=100&offset=300'}",
            "xml":{
                "wrapped":true
            },
            "description":"A collection of links containing hrefs to the current, next, and previous pages as applicable.",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"Model for paginated collections of data."
}

Nested Schema : items

Type: array

A collection of paged items.

Show Source

• Array of: object Ethnicity
  Model for a Ethnicity object in CDM.

{
    "type":"array",
    "xml":{
        "wrapped":true
    },
    "description":"A collection of paged items.",
    "items":{
        "$ref":"#/definitions/Ethnicity"
    }
}

Nested Schema : links

Type: array

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

Show Source

• Array of: string

{
    "type":"array",
    "example":"{rel: 'next',href: '/patientapi/patients?limit=100&offset=300'}",
    "xml":{
        "wrapped":true
    },
    "description":"A collection of links containing hrefs to the current, next, and previous pages as applicable.",
    "items":{
        "type":"string"
    }
}

Example:

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

Nested Schema : Ethnicity

Type: object

Model for a Ethnicity object in CDM.

Show Source

• identifier(optional): object Identifier
  Identifier assigned by a given system
• patient(optional): object LinkedReference
• subject(optional): object LinkedReference
• valueCode(optional): object CodeableConcept
  Model that represents a value as a reference to one or more terminologies or ontologies or defined by the provision of text.

{
    "type":"object",
    "properties":{
        "identifier":{
            "description":"Ethnicity Identifier",
            "$ref":"#/definitions/Identifier"
        },
        "valueCode":{
            "description":"CodeableConcept",
            "$ref":"#/definitions/CodeableConcept"
        },
        "subject":{
            "example":"{href: '/subjectapi/subjects/{subjectId}'}",
            "description":"A link containing href to retrieve Subject details",
            "$ref":"#/definitions/LinkedReference"
        },
        "patient":{
            "example":"{href: '/patientapi/patients/{patientId}'}",
            "description":"A link containing href to retrieve Patient details",
            "$ref":"#/definitions/LinkedReference"
        }
    },
    "description":"Model for a Ethnicity object in CDM."
}

Nested Schema : Identifier

Type: object

Identifier assigned by a given system

Show Source

• system(optional): string
  System which assigned this identifier
• value(optional): string
  Identifier value

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string",
            "description":"System which assigned this identifier"
        },
        "value":{
            "type":"string",
            "description":"Identifier value"
        }
    },
    "description":"Identifier assigned by a given system"
}

Nested Schema : LinkedReference

Type: object

Show Source

• display(optional): string
• reference(optional): string

{
    "type":"object",
    "properties":{
        "reference":{
            "type":"string"
        },
        "display":{
            "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.

Show Source

• coding(optional): array coding
  Read Only: true

  Code(s) defined by a terminology system.
• text(optional): string
  Plain text representation of the concept.

{
    "type":"object",
    "properties":{
        "text":{
            "type":"string",
            "description":"Plain text representation of the concept."
        },
        "coding":{
            "type":"array",
            "description":"Code(s) defined by a terminology system.",
            "readOnly":true,
            "items":{
                "xml":{
                    "name":"coding"
                },
                "$ref":"#/definitions/Coding"
            }
        }
    },
    "description":"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.

Show Source

• Array of: object Coding
  Model for a reference to a code defined by a terminology system.

{
    "type":"array",
    "description":"Code(s) defined by a terminology system.",
    "readOnly":true,
    "items":{
        "xml":{
            "name":"coding"
        },
        "$ref":"#/definitions/Coding"
    }
}

Nested Schema : Coding

Type: object

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

Show Source

• code(optional): string
  Symbol in syntax defined by the system.
• description(optional): string
  Description defined by the system.
• display(optional): string
  Representation defined by the system.
• srvcProviderId(optional): string
  Service Provider Id of Specimen Alias .
• srvcProviderName(optional): string
  Service Provider Name of Specimen Alias .
• sysId(optional): string
  Identity of the terminology system.
• sysName(optional): string
  Name of the terminology system.
• sysVersion(optional): string
  Version of the system - if relevant.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Symbol in syntax defined by the system."
        },
        "display":{
            "type":"string",
            "description":"Representation defined by the system."
        },
        "description":{
            "type":"string",
            "description":"Description defined by the system."
        },
        "sysId":{
            "type":"string",
            "description":"Identity of the terminology system."
        },
        "sysName":{
            "type":"string",
            "description":"Name of the terminology system."
        },
        "sysVersion":{
            "type":"string",
            "description":"Version of the system - if relevant."
        },
        "srvcProviderId":{
            "type":"string",
            "description":"Service Provider Id of Specimen Alias ."
        },
        "srvcProviderName":{
            "type":"string",
            "description":"Service Provider Name of Specimen Alias ."
        }
    },
    "description":"Model for a reference to a code defined by a terminology system."
}

400 Response

Invalid parameters supplied

404 Response

Ethnicitys(s) not found

Back to Top

Examples

The following example submits a GET request.

API URL

http://localhost:7010/ohfapi/cg/v3.3/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" : "/ohfapi/cg/v3.3/subjectapi/subjects/4"
    },
    "patient" : {
      "reference" : "/ohfapi/cg/v3.3/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" : "/ohfapi/cg/v3.3/subjectapi/subjects/4"
    },
    "patient" : {
      "reference" : "/ohfapi/cg/v3.3/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" : "/ohfapi/cg/v3.3/subjectapi/subjects/4"
    },
    "patient" : {
      "reference" : "/ohfapi/cg/v3.3/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" : "/ohfapi/cg/v3.3/subjectapi/subjects/4"
    },
    "patient" : {
      "reference" : "/ohfapi/cg/v3.3/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" : "/ohfapi/cg/v3.3/subjectapi/subjects/4"
    },
    "patient" : {
      "reference" : "/ohfapi/cg/v3.3/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" : "/ohfapi/cg/v3.3/subjectapi/subjects/4"
    },
    "patient" : {
      "reference" : "/ohfapi/cg/v3.3/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" : "/ohfapi/cg/v3.3/subjectapi/subjects/4"
    },

    "patient" : {
      "reference" : "/ohfapi/cg/v3.3/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" : "/ohfapi/cg/v3.3/subjectapi/subjects/4"
    },
    "patient" : {
      "reference" : "/ohfapi/cg/v3.3/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" : "/ohfapi/cg/v3.3/subjectapi/subjects/4"
    },

    "patient" : {
      "reference" : "/ohfapi/cg/v3.3/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" : "/ohfapi/cg/v3.3/subjectapi/subjects/4"
    },

    "patient" : {
      "reference" : "/ohfapi/cg/v3.3/subjectapi/subjects/4/patients"
    }
  } ],

  "count" : 10,
  "hasMore" : false,
  "links" : [ {
    "rel" : "self",
    "href" : "http://localhost:7010/ohfapi/cg/v3.3/subjectapi/subjects/4/ethnicity"
  } ]

}

Back to Top