Jump to

• Request
• Response
• Examples

Retrieve Clinical Specimens for a Condition Patient Record id

get

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

This endpoint supports the retrieval of Clinical Specimens for a single Condition Patient record (row) id. It returns all the Clinical Specimen links for the given Condition Patient ID.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• id: integer(int64)
  Minimum Value: 0

  Patient Condition 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 : DiagnosisSpecimens

Type: object

Model for a Diagnosis Specimen object in CDM.

Show Source

• clinicalspecimens(optional): array clinicalspecimens
  A list of links containing href to retrieve specimen details
• patientcondition(optional): object LinkedReference

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

Nested Schema : clinicalspecimens

Type: array

A list of links containing href to retrieve specimen details

Show Source

• Array of: object LinkedReference

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

Example:

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

Nested Schema : LinkedReference

Type: object

Show Source

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

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

400 Response

Invalid parameters supplied

404 Response

Clinical specimens not found

Back to Top

Examples

The following example submits a GET request.

API URL

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

Example of Response Body

The following example shows the response returned in JSON format.

{
   "patientcondition": {
      "reference": "/ohfapi/cg/v3.3/patientapi/conditions/10001"
}, 
"clinicalspecimens": [
  {
    "reference": "/ohfapi/cg/v3.3/patientapi/clinicalspecimens/14214"
  },
  {
    "reference": "/ohfapi/cg/v3.3/patientapi/clinicalspecimens/14215"
  }, 
  {
    "reference": "/ohfapi/cg/v3.3/patientapi/clinicalspecimens/14212"
     }
    ]
} 

Back to Top