Jump to

• Request
• Response
• Examples

Retrieve Diagnosis for a Clinical Specimen Identifier

get

/ohfapi/cg/v3.3/{apiContext}/clinicalspecimens/{id}/conditions

This endpoint supports the retrieval of Conditions for a single Patient Clinical Specimen Identifier. It returns all the Condition links for the given Clinical Specimen.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• id: integer(int64)
  Minimum Value: 0

  Patient Clinical Specimen Row ID

Security

• basicAuth: basic
  Type: basic

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

successful operation

Body ()

Root Schema : SpecimenDiagnosis

Type: object

Model for a Specimen Diagnosis object in CDM.

Show Source

• clinicalspecimen(optional): object LinkedReference
• patientconditions(optional): array patientconditions
  A list of links containing href to retrieve condition details

{
    "type":"object",
    "properties":{
        "clinicalspecimen":{
            "example":"{href: '/patientapi/clinicalspecimens/{id}'}",
            "description":"A link containing href to retrieve Clinical Specimen details",
            "$ref":"#/definitions/LinkedReference"
        },
        "patientconditions":{
            "type":"array",
            "example":"{href: '/patientapi/conditions/{id}'}",
            "description":"A list of links containing href to retrieve condition details",
            "items":{
                "$ref":"#/definitions/LinkedReference"
            }
        }
    },
    "description":"Model for a Specimen Diagnosis object in CDM."
}

Nested Schema : LinkedReference

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "reference":{
            "type":"string"
        },
        "display":{
            "type":"string"
        }
    }
}

Nested Schema : patientconditions

Type: array

A list of links containing href to retrieve condition details

Show Source

• Array of: object LinkedReference

{
    "type":"array",
    "example":"{href: '/patientapi/conditions/{id}'}",
    "description":"A list of links containing href to retrieve condition details",
    "items":{
        "$ref":"#/definitions/LinkedReference"
    }
}

Example:

{href: '/patientapi/conditions/{id}'}

400 Response

Invalid parameters supplied

404 Response

Diagnosis not found

Back to Top

Examples

The following example submits a GET request.

API URL

http://localhost:7010/ohfapi/cg/v3.3/patientapi/clinicalspecimens/14212/conditions

Example of Response Body

The following example shows the response returned in JSON format.

{
     "clinicalspecimen": {
         "reference": "/ohfapi/cg/v3.3/patientapi/clinicalspecimens/14212"
     },
     "patientconditions": [
         {
             "reference": "/ohfapi/cg/v3.3/patientapi/conditions/10001"
         }
     ]
 }

Back to Top