Retrieve Conditions for Patients

get

/ohfapi/cg/v3.3/patientapi/conditions

This endpoint supports the retrieval of Conditions (Diagnosis) for multiple Patient Record (row) ids passed. It returns Condition (Diagnosis) related information like Code, Type, Name, Onset Date, Onset Age, Encounter Details, Status, Anatomical Site Details, facility details,service provider details,specialty details.

Request

Supported Media Types
Query Parameters
  • Collection Format: multi
    Minimum Number of Items: 1
    Maximum Number of Items: 2147483647
    Patient Identifiers
  • Pagination query params: ?limit=2&offset=0
  • Pagination query params: ?limit=2&offset=0
Security
Back to Top

Response

Supported Media Types

200 Response

successful operation
Body ()
Root Schema : PageableCollectionDiagnosis
Type: object
Model for paginated collections of data.
Show Source
Nested Schema : items
Type: array
A collection of paged items.
Show Source
Nested Schema : Diagnosis
Type: object
Model for a Diagnosis object in CDM.
Show Source
Nested Schema : LinkedReference
Type: object
Show Source
Nested Schema : Practitioner
Type: object
Model for a Practitioner, i.e. a person who is directly or indirectly involved in the provisioning of healthcare with a formal responsibility.
Show Source
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
Nested Schema : Encounter
Type: object
Show Source
Nested Schema : CdmIdentifier
Type: object
Identifier assigned by a given system
Show Source
Nested Schema : Address
Type: object
Model for a postal address.
Show Source
Nested Schema : HumanName
Type: object
Model for a name of a human with text and parts information.
Show Source
Nested Schema : Telecom
Type: object
Show Source
Nested Schema : line
Type: array
Street name, number, direction & P.O. Box etc.
Show Source
Nested Schema : given
Type: array
Given names (not always 'first'). Includes middle names.
Show Source
Nested Schema : coding
Type: array
Read Only: true
Code(s) defined by a terminology system.
Show Source
Nested Schema : Coding
Type: object
Model for a reference to a code defined by a terminology system.
Show Source
Nested Schema : Location
Type: object
Show Source
Nested Schema : Number
Type: object

400 Response

Invalid parameters supplied

404 Response

conditions(diagnosis) not found
Back to Top

Examples

The following example submits a GET request.

API URL

http://localhost:7010/ohfapi/cg/v3.3/patientapi/conditions?id=1&id=2&id=3&id=4&limit=5&offset=0

Example of Response Body

The following example shows the contents of the response body in JSON format:

{

"resourceType": "Condition",
  "items": [
    {
      "identifier": {
        "system": "CDM",
        "value": "1"
      },
      "code": {
        "coding": [
          {
            "code": "1",
            "display": "D1",
            "description": "DDesc",
            "sysId": "ICD10",
            "sysName": "ICD10",
            "sysVersion": "ICD10_2016"
          }
        ]
      },
      "bodySite": {
        "coding": [
          {
            "code": "ANA_SITE_CD_CODE1",
            "display": "ANA_SITE_CD_CODE1name",
            "description": "ANA_SITE_CD_CODE1Desc",
            "sysId": "EHA_CUSTOM_CD_SYS",
            "sysName": "EHA Custom Code System",
            "sysVersion": "1"
          }
        ]
      },
      "clinicalStatus": {
        "coding": [
          {
            "code": "1",
            "display": "DIASTS1",
            "description": "DIASTS_DESC1",
            "sysId": "EHA_CUSTOM_CD_SYS",
            "sysName": "EHA Custom Code System",
            "sysVersion": "1"
          }
        ]
      },
      "onsetDate": "01/01/1998",
      "onsetAge": "50",
      "reportedDate": "03/01/1998",
      "endDate": "03/31/1998",
      "encounter": {
        "identifier": {
          "system": "CDM",
          "value": "ENC1"
        },
        "type": {
          "coding": [
            {
              "code": "1",
              "display": "ENC_TYPE1",
              "description": "ENC_TYPE_DESC1",
              "sysId": "EHA_CUSTOM_CD_SYS",
              "sysName": "EHA Custom Code System",
              "sysVersion": "1"
            }
          ]
        },
        "location": {
          "identifier": {
            "system": "CDM",
            "value": "1"
          },
          "name": "FAC1",
          "type": {
            "coding": [
              {
                "code": "FAC_SUBTYP_RM",
                "display": "Room",
                "description": "A space allocated for a function within a building or a floor",
                "sysId": "EHA_CUSTOM_CD_SYS",
                "sysName": "EHA Custom Code System",
                "sysVersion": "1"
              }
            ]
          }
        },
        "sequence": 1
      },
      "asserter": {
        "identifier": {
          "system": "CDM",
          "value": "SVCPRV1"
        },
        "type": {
          "coding": [
            {
              "code": "SVCPRV_TYP_CD_VALUE",
              "display": "SVCPRV_TYP_CD_NAME",
              "description": "SVCPRV_TYP_CD_DESC",
              "sysId": "SVCPRV_TYP_CD_SYS",
              "sysName": "Service Provider System",
              "sysVersion": "2"
            }
          ]
        },
        "speciality": {
          "coding": [
            {
              "code": "Speciality_1",
              "display": "SP_LTY_NAME",
              "description": "SP_LTY_DESC",
              "sysId": "EHA_CUSTOM_CD_SYS",
              "sysName": "EHA Custom Code System",
              "sysVersion": "1"
            }
          ]
        },
        "specimenAliasIssuerFlag": "Y"
      },
      "patient": {
        "reference": "/ohfapi/cg/v3.3/patientapi/patients/1"
      }
    },
    {
      "identifier": {
        "system": "CDM",
        "value": "2"
      },
      "code": {
        "coding": [
          {
            "code": "1",
            "display": "D1",
            "description": "DDesc",
            "sysId": "ICD10",
            "sysName": "ICD10",
            "sysVersion": "ICD10_2016"
          }
        ]
      },
      "bodySite": {
        "coding": [
          {
            "code": "ANA_SITE_CD_CODE1",
            "display": "ANA_SITE_CD_CODE1name",
            "description": "ANA_SITE_CD_CODE1Desc",
            "sysId": "EHA_CUSTOM_CD_SYS",
            "sysName": "EHA Custom Code System",
            "sysVersion": "1"
          }
        ]
      },
      "clinicalStatus": {
        "coding": [
          {
            "code": "1",
            "display": "DIASTS1",
            "description": "DIASTS_DESC1",
            "sysId": "EHA_CUSTOM_CD_SYS",
            "sysName": "EHA Custom Code System",
            "sysVersion": "1"
          }
        ]
      },
      "onsetDate": "01/01/1998",
      "onsetAge": "50",
      "reportedDate": "03/01/1998",
      "endDate": "03/31/1998",
      "encounter": {
        "identifier": {
          "system": "CDM",
          "value": "ENC1"
        },
        "type": {
          "coding": [
            {
              "code": "1",
              "display": "ENC_TYPE1",
              "description": "ENC_TYPE_DESC1",
              "sysId": "EHA_CUSTOM_CD_SYS",
              "sysName": "EHA Custom Code System",
              "sysVersion": "1"
            }
          ]
        },
        "location": {
          "identifier": {
            "system": "CDM",
            "value": "1"
          },
          "name": "FAC1",
          "type": {
            "coding": [
              {
                "code": "FAC_SUBTYP_RM",
                "display": "Room",
                "description": "A space allocated for a function within a building or a floor",
                "sysId": "EHA_CUSTOM_CD_SYS",
                "sysName": "EHA Custom Code System",
                "sysVersion": "1"
              }
            ]
          }
        },
        "sequence": 2
      },
      "asserter": {
        "identifier": {
          "system": "CDM",
          "value": "SVCPRV1"
        },
        "type": {
          "coding": [
            {
              "code": "SVCPRV_TYP_CD_VALUE",
              "display": "SVCPRV_TYP_CD_NAME",
              "description": "SVCPRV_TYP_CD_DESC",
              "sysId": "SVCPRV_TYP_CD_SYS",
              "sysName": "Service Provider System",
              "sysVersion": "2"
            }
          ]
        },
        "speciality": {
          "coding": [
            {
              "code": "Speciality_1",
              "display": "SP_LTY_NAME",
              "description": "SP_LTY_DESC",
              "sysId": "EHA_CUSTOM_CD_SYS",
              "sysName": "EHA Custom Code System",
              "sysVersion": "1"
            }
          ]
        },
        "specimenAliasIssuerFlag": "Y"
      },
      "patient": {
        "reference": "/ohfapi/cg/v3.3/patientapi/patients/1"
      }
    },
    {
      "identifier": {
        "system": "CDM",
        "value": "3"
      },
      "code": {
        "coding": [
          {
            "code": "1",
            "display": "D1",
            "description": "DDesc",
            "sysId": "ICD10",
            "sysName": "ICD10",
            "sysVersion": "ICD10_2016"
          }
        ]
      },
      "bodySite": {
        "coding": [
          {
            "code": "ANA_SITE_CD_CODE1",
            "display": "ANA_SITE_CD_CODE1name",
            "description": "ANA_SITE_CD_CODE1Desc",
            "sysId": "EHA_CUSTOM_CD_SYS",
            "sysName": "EHA Custom Code System",
            "sysVersion": "1"
          }
        ]
      },
      "clinicalStatus": {
        "coding": [
          {
            "code": "1",
            "display": "DIASTS1",
            "description": "DIASTS_DESC1",
            "sysId": "EHA_CUSTOM_CD_SYS",
            "sysName": "EHA Custom Code System",
            "sysVersion": "1"
          }
        ]
      },
      "onsetDate": "01/01/1998",
      "onsetAge": "50",
      "reportedDate": "03/01/1998",
      "endDate": "03/31/1998",
      "encounter": {
        "identifier": {
          "system": "CDM",
          "value": "ENC1"
        },
        "type": {
          "coding": [
            {
              "code": "1",
              "display": "ENC_TYPE1",
              "description": "ENC_TYPE_DESC1",
              "sysId": "EHA_CUSTOM_CD_SYS",
              "sysName": "EHA Custom Code System",
              "sysVersion": "1"
            }
          ]
        },
        "location": {
          "identifier": {
            "system": "CDM",
            "value": "1"
          },
          "name": "FAC1",
          "type": {
            "coding": [
              {
                "code": "FAC_SUBTYP_RM",
                "display": "Room",
                "description": "A space allocated for a function within a building or a floor",
                "sysId": "EHA_CUSTOM_CD_SYS",
                "sysName": "EHA Custom Code System",
                "sysVersion": "1"
              }
            ]
          }
        },
        "sequence": 3
      },
      "asserter": {
        "identifier": {
          "system": "CDM",
          "value": "SVCPRV1"
        },
        "type": {
          "coding": [
            {
              "code": "SVCPRV_TYP_CD_VALUE",
              "display": "SVCPRV_TYP_CD_NAME",
              "description": "SVCPRV_TYP_CD_DESC",
              "sysId": "SVCPRV_TYP_CD_SYS",
              "sysName": "Service Provider System",
              "sysVersion": "2"
            }
          ]
        },
        "speciality": {
          "coding": [
            {
              "code": "Speciality_1",
              "display": "SP_LTY_NAME",
              "description": "SP_LTY_DESC",
              "sysId": "EHA_CUSTOM_CD_SYS",
              "sysName": "EHA Custom Code System",
              "sysVersion": "1"
            }
          ]
        },
        "specimenAliasIssuerFlag": "Y"
      },
      "patient": {
        "reference": "/ohfapi/cg/v3.3/patientapi/patients/1"
      }
    },
    {
      "identifier": {
        "system": "CDM",
        "value": "4"
      },
      "code": {
        "coding": [
          {
            "code": "1",
            "display": "D1",
            "description": "DDesc",
            "sysId": "ICD10",
            "sysName": "ICD10",
            "sysVersion": "ICD10_2016"
          }
        ]
      },
      "bodySite": {
        "coding": [
          {
            "code": "ANA_SITE_CD_CODE1",
            "display": "ANA_SITE_CD_CODE1name",
            "description": "ANA_SITE_CD_CODE1Desc",
            "sysId": "EHA_CUSTOM_CD_SYS",
            "sysName": "EHA Custom Code System",
            "sysVersion": "1"
          }
        ]
      },
      "clinicalStatus": {
        "coding": [
          {
            "code": "1",
            "display": "DIASTS1",
            "description": "DIASTS_DESC1",
            "sysId": "EHA_CUSTOM_CD_SYS",
            "sysName": "EHA Custom Code System",
            "sysVersion": "1"
          }
        ]
      },
      "onsetDate": "01/01/1998",
      "onsetAge": "50",
      "reportedDate": "03/01/1998",
      "endDate": "03/31/1998",
      "encounter": {
        "identifier": {
          "system": "CDM",
          "value": "ENC1"
        },
        "type": {
          "coding": [
            {
              "code": "1",
              "display": "ENC_TYPE1",
              "description": "ENC_TYPE_DESC1",
              "sysId": "EHA_CUSTOM_CD_SYS",
              "sysName": "EHA Custom Code System",
              "sysVersion": "1"
            }
          ]
        },
        "location": {
          "identifier": {
            "system": "CDM",
            "value": "1"
          },
          "name": "FAC1",
          "type": {
            "coding": [
              {
                "code": "FAC_SUBTYP_RM",
                "display": "Room",
                "description": "A space allocated for a function within a building or a floor",
                "sysId": "EHA_CUSTOM_CD_SYS",
                "sysName": "EHA Custom Code System",
                "sysVersion": "1"
              }
            ]
          }
        },
        "sequence": 4
      },
      "asserter": {
        "identifier": {
          "system": "CDM",
          "value": "SVCPRV1"
        },
        "type": {
          "coding": [
            {
              "code": "SVCPRV_TYP_CD_VALUE",
              "display": "SVCPRV_TYP_CD_NAME",
              "description": "SVCPRV_TYP_CD_DESC",
              "sysId": "SVCPRV_TYP_CD_SYS",
              "sysName": "Service Provider System",
              "sysVersion": "2"
            }
          ]
        },
        "speciality": {
          "coding": [
            {
              "code": "Speciality_1",
              "display": "SP_LTY_NAME",
              "description": "SP_LTY_DESC",
              "sysId": "EHA_CUSTOM_CD_SYS",
              "sysName": "EHA Custom Code System",
              "sysVersion": "1"
            }
          ]
        },
        "specimenAliasIssuerFlag": "Y"
      },
      "patient": {
        "reference": "/ohfapi/cg/v3.3/patientapi/patients/1"
      }
    },
    {
      "identifier": {
        "system": "CDM",
        "value": "5"
      },
      "code": {
        "coding": [
          {
            "code": "1",
            "display": "D1",
            "description": "DDesc",
            "sysId": "ICD10",
            "sysName": "ICD10",
            "sysVersion": "ICD10_2016"
          }
        ]
      },
      "bodySite": {
        "coding": [
          {
            "code": "ANA_SITE_CD_CODE1",
            "display": "ANA_SITE_CD_CODE1name",
            "description": "ANA_SITE_CD_CODE1Desc",
            "sysId": "EHA_CUSTOM_CD_SYS",
            "sysName": "EHA Custom Code System",
            "sysVersion": "1"
          }
        ]
      },
      "clinicalStatus": {
        "coding": [
          {
            "code": "1",
            "display": "DIASTS1",
            "description": "DIASTS_DESC1",
            "sysId": "EHA_CUSTOM_CD_SYS",
            "sysName": "EHA Custom Code System",
            "sysVersion": "1"
          }
        ]
      },
      "onsetDate": "01/01/1998",
      "onsetAge": "50",
      "reportedDate": "03/01/1998",
      "endDate": "03/31/1998",
      "encounter": {
        "identifier": {
          "system": "CDM",
          "value": "ENC1"
        },
        "type": {
          "coding": [
            {
              "code": "1",
              "display": "ENC_TYPE1",
              "description": "ENC_TYPE_DESC1",
              "sysId": "EHA_CUSTOM_CD_SYS",
              "sysName": "EHA Custom Code System",
              "sysVersion": "1"
            }
          ]
        },
        "location": {
          "identifier": {
            "system": "CDM",
            "value": "1"
          },
          "name": "FAC1",
          "type": {
            "coding": [
              {
                "code": "FAC_SUBTYP_RM",
                "display": "Room",
                "description": "A space allocated for a function within a building or a floor",
                "sysId": "EHA_CUSTOM_CD_SYS",
                "sysName": "EHA Custom Code System",
                "sysVersion": "1"
              }
            ]
          }
        },
        "sequence": 5
      },
      "asserter": {
        "identifier": {
          "system": "CDM",
          "value": "SVCPRV1"
        },
        "type": {
          "coding": [
            {
              "code": "SVCPRV_TYP_CD_VALUE",
              "display": "SVCPRV_TYP_CD_NAME",
              "description": "SVCPRV_TYP_CD_DESC",
              "sysId": "SVCPRV_TYP_CD_SYS",
              "sysName": "Service Provider System",
              "sysVersion": "2"
            }
          ]
        },
        "speciality": {
          "coding": [
            {
              "code": "Speciality_1",
              "display": "SP_LTY_NAME",
              "description": "SP_LTY_DESC",
              "sysId": "EHA_CUSTOM_CD_SYS",
              "sysName": "EHA Custom Code System",
              "sysVersion": "1"
            }
          ]
        },
        "specimenAliasIssuerFlag": "Y"
      },
      "patient": {
        "reference": "/ohfapi/cg/v3.3/patientapi/patients/1"
      }
    }
  ],
  "count": 5,
  "hasMore": true,
  "links": [
    {
      "rel": "self",
      "href": "http://locahost:7010/ohfapi/cg/v3.3/patientapi/conditions?id=1&id=2&id=3&id=4&limit=5&offset=0"
    },
    {
      "rel": "next",
      "href": "http://localhost:7010/ohfapi/cg/v3.3/patientapi/conditions?offset=5&limit=5&id=1&id=2&id=3&id=4"
    }
  ]
}
Back to Top