Which of the diagnosis's columns to return.
Endpoints
Diagnoses
POST
/v0/diagnoses/browseBrowse diagnoses
Queries the diagnoses on the patients visible to the caller.
Read-only. Uses the shared browse syntax described in
Browsing tables and returns the { table, aggregate, total } envelope as JSON, or the selected columns as CSV when you send
Accept: text/csv.
Until clinical data has finished loading after a service restart, the call
returns 500 rather than an empty table; retry shortly.
Request bodyapplication/json
Optional parameters
select.diagnosisobjectselect.diagnosis.refbooleanReference for the diagnosis record in the current output. It can change when clinical data is reprocessed.
select.diagnosis.sequencebooleanSequence number of the diagnosis within its visit, claim, or lab accession. Sequence alone does not establish clinical priority.
select.diagnosis.createdAtbooleanTimestamp associated with the diagnosis data in the platform. For diagnoses derived from a merged visit, this is the newest contributing visit-data timestamp.
select.diagnosis.codeSystembooleanCode system reported by the source for the diagnosis, when supplied. Currently populated for some lab-accession diagnoses.
select.diagnosis.descriptionbooleanDiagnosis description supplied by the source, when available. Separate from the reference-data short and long descriptions.
select.diagnosis.scorebooleanSource-supplied score associated with the diagnosis, when available. The export does not define a universal scoring scale.
select.diagnosis.companyIdbooleanPlatform identifier for the customer organization associated with the record.
select.diagnosis.projectIdbooleanPlatform identifier for the project containing the patient and record.
select.diagnosis.patientIdbooleanPlatform identifier for the patient associated with the record. Use with the company and project identifiers to identify the patient scope.
select.diagnosis.visitRefbooleanReference to the parent visit. Blank for a diagnosis attached directly to a lab accession. This reference can change when the data is reprocessed.
select.diagnosis.labAccessionRefbooleanPlatform reference to the parent lab accession. Blank for a diagnosis attached to a visit. This is different from the source accession identifier.
select.diagnosis.diagnosisCodeIdbooleanDiagnosis code associated with the record. Reference-data descriptions are provided when a matching code is available.
select.diagnosis.diagnosisCategoryIdbooleanDerived ICD-10 category code associated with the diagnosis. May be empty when no matching category is available.
select.diagnosis.procedureCountbooleanNumber of procedure records linked to the diagnosis.
select.companyobject & objectWhich of the joined company's columns to return. Absent when the row has no company.
select.projectobject & objectWhich of the joined project's columns to return. Absent when the row has no project.
select.patientobject & objectWhich of the joined patient's columns to return. Absent when the row has no patient.
select.visitobject & objectWhich of the joined visit's columns to return. Absent when the row has no visit.
select.labAccessionobject & objectWhich of the joined lab accession's columns to return. Absent when the row has no lab accession.
select.diagnosisCodeobject & objectWhich of the joined diagnosis code's columns to return. Absent when the row has no diagnosis code.
select.diagnosisCategoryobject & objectWhich of the joined diagnosis category's columns to return. Absent when the row has no diagnosis category.
where.diagnosisobjectFilters on the diagnosis's columns.
where.diagnosis.refobject | object | object | object | object | object | object | string[]Reference for the diagnosis record in the current output. It can change when clinical data is reprocessed.
where.diagnosis.sequenceobject | object | object | object | object | object | object | object | string[]Sequence number of the diagnosis within its visit, claim, or lab accession. Sequence alone does not establish clinical priority.
where.diagnosis.createdAtobject | object | object | object | object | object | object | object | string[]Timestamp associated with the diagnosis data in the platform. For diagnoses derived from a merged visit, this is the newest contributing visit-data timestamp.
where.diagnosis.codeSystemobject | object | object | object | object | object | object | string[]Code system reported by the source for the diagnosis, when supplied. Currently populated for some lab-accession diagnoses.
where.diagnosis.descriptionobject | object | object | object | object | object | object | string[]Diagnosis description supplied by the source, when available. Separate from the reference-data short and long descriptions.
where.diagnosis.scoreobject | object | object | object | object | object | object | object | string[]Source-supplied score associated with the diagnosis, when available. The export does not define a universal scoring scale.
where.diagnosis.companyIdobject | object | object | object | object | object | object | object | string[]Platform identifier for the customer organization associated with the record.
where.diagnosis.projectIdobject | object | object | object | object | object | object | string[]Platform identifier for the project containing the patient and record.
where.diagnosis.patientIdobject | object | object | object | object | object | object | string[]Platform identifier for the patient associated with the record. Use with the company and project identifiers to identify the patient scope.
where.diagnosis.visitRefobject | object | object | object | object | object | object | string[]Reference to the parent visit. Blank for a diagnosis attached directly to a lab accession. This reference can change when the data is reprocessed.
where.diagnosis.labAccessionRefobject | object | object | object | object | object | object | string[]Platform reference to the parent lab accession. Blank for a diagnosis attached to a visit. This is different from the source accession identifier.
where.diagnosis.diagnosisCodeIdobject | object | object | object | object | object | object | string[]Diagnosis code associated with the record. Reference-data descriptions are provided when a matching code is available.
where.diagnosis.diagnosisCategoryIdobject | object | object | object | object | object | object | string[]Derived ICD-10 category code associated with the diagnosis. May be empty when no matching category is available.
where.diagnosis.procedureCountobject | object | object | object | object | object | object | object | string[]Number of procedure records linked to the diagnosis.
where.companystring | object & objectFilters on the joined company's columns. `isNull` or `isNotNull` in place of the filters matches the rows without or with a company.
where.projectstring | object & objectFilters on the joined project's columns. `isNull` or `isNotNull` in place of the filters matches the rows without or with a project.
where.patientstring | object & objectFilters on the joined patient's columns. `isNull` or `isNotNull` in place of the filters matches the rows without or with a patient.
where.visitstring | object & objectFilters on the joined visit's columns. `isNull` or `isNotNull` in place of the filters matches the rows without or with a visit.
where.labAccessionstring | object & objectFilters on the joined lab accession's columns. `isNull` or `isNotNull` in place of the filters matches the rows without or with a lab accession.
where.diagnosisCodestring | object & objectFilters on the joined diagnosis code's columns. `isNull` or `isNotNull` in place of the filters matches the rows without or with a diagnosis code.
where.diagnosisCategorystring | object & objectFilters on the joined diagnosis category's columns. `isNull` or `isNotNull` in place of the filters matches the rows without or with a diagnosis category.
aggregate.diagnosis.countbooleanWhen true, return the number of rows that match the filter.
aggregate.diagnosis.sumobjectNumeric columns to total across the rows that match the filter.
aggregate.diagnosis.avgobjectNumeric columns to average across the rows that match the filter.
aggregate.diagnosis.minobjectNumeric columns to find the smallest value of across the rows that match the filter.
aggregate.diagnosis.maxobjectNumeric columns to find the largest value of across the rows that match the filter.
ReturnsTyped browse response for DiagnosisBrowseResponse
Conditional attributes
table[].diagnosisobject & objectThe diagnosis's columns, as selected by the request.
table[].companyobject & object & object & objectThe joined company's columns, as selected by the request. Absent when the row has no company.
table[].projectobject & object & objectThe joined project's columns, as selected by the request. Absent when the row has no project.
table[].patientobject & object & objectThe joined patient's columns, as selected by the request. Absent when the row has no patient.
table[].visitobject & object & objectThe joined visit's columns, as selected by the request. Absent when the row has no visit.
table[].labAccessionobject & objectThe joined lab accession's columns, as selected by the request. Absent when the row has no lab accession.
table[].diagnosisCodeobject & objectThe joined diagnosis code's columns, as selected by the request. Absent when the row has no diagnosis code.
table[].diagnosisCategoryobject & objectThe joined diagnosis category's columns, as selected by the request. Absent when the row has no diagnosis category.
aggregate.diagnosis.countintegerNumber of rows that match the filter. Present when `count` was requested.
aggregate.diagnosis.sumobjectTotal of each requested numeric column across the rows that match the filter.
aggregate.diagnosis.avgobjectAverage of each requested numeric column across the rows that match the filter.
aggregate.diagnosis.minobjectSmallest value of each requested numeric column across the rows that match the filter.
aggregate.diagnosis.maxobjectLargest value of each requested numeric column across the rows that match the filter.
Errors
400401500
POST
/v0/diagnosis-categories/browseBrowse diagnosis categories
Queries the ICD-10-CM diagnosis category reference table, which is the
same for every caller.
Read-only. Uses the shared browse syntax described in
Browsing tables and returns the { table, aggregate, total } envelope as JSON, or the selected columns as CSV when you send
Accept: text/csv.
Request bodyapplication/json
Optional parameters
select.diagnosisCategoryobjectWhich of the diagnosis category's columns to return.
select.diagnosisCategory.idbooleanICD-10 category code resolved from the diagnosis.
select.diagnosisCategory.descriptionbooleanDescription of the ICD-10 category associated with the diagnosis.
where.diagnosisCategoryobjectFilters on the diagnosis category's columns.
where.diagnosisCategory.idobject | object | object | object | object | object | object | string[]ICD-10 category code resolved from the diagnosis.
where.diagnosisCategory.descriptionobject | object | object | object | object | object | object | string[]Description of the ICD-10 category associated with the diagnosis.
aggregate.diagnosisCategory.countbooleanWhen true, return the number of rows that match the filter.
aggregate.diagnosisCategory.sumobjectNumeric columns to total across the rows that match the filter.
aggregate.diagnosisCategory.avgobjectNumeric columns to average across the rows that match the filter.
aggregate.diagnosisCategory.minobjectNumeric columns to find the smallest value of across the rows that match the filter.
aggregate.diagnosisCategory.maxobjectNumeric columns to find the largest value of across the rows that match the filter.
ReturnsTyped browse response for DiagnosisCategoryBrowseResponse
Conditional attributes
table[].diagnosisCategoryobjectThe diagnosis category's columns, as selected by the request.
table[].diagnosisCategory.idstringICD-10 category code resolved from the diagnosis.
table[].diagnosisCategory.descriptionstringDescription of the ICD-10 category associated with the diagnosis.
aggregate.diagnosisCategory.countintegerNumber of rows that match the filter. Present when `count` was requested.
aggregate.diagnosisCategory.sumobjectTotal of each requested numeric column across the rows that match the filter.
aggregate.diagnosisCategory.avgobjectAverage of each requested numeric column across the rows that match the filter.
aggregate.diagnosisCategory.minobjectSmallest value of each requested numeric column across the rows that match the filter.
aggregate.diagnosisCategory.maxobjectLargest value of each requested numeric column across the rows that match the filter.
Errors
400401500
POST
/v0/diagnosis-codes/browseBrowse diagnosis codes
Queries the ICD-10-CM diagnosis code reference table, which is the same
for every caller.
Read-only. Uses the shared browse syntax described in
Browsing tables and returns the { table, aggregate, total } envelope as JSON, or the selected columns as CSV when you send
Accept: text/csv.
Request bodyapplication/json
Optional parameters
select.diagnosisCodeobjectWhich of the diagnosis code's columns to return.
select.diagnosisCode.idbooleanICD-10-CM diagnosis code, written without the dot (for example E119).
select.diagnosisCode.diagnosisCategoryIdbooleanICD-10-CM category code the diagnosis code falls under: the longest category code that prefixes it (for example E11). May be empty when no matching category is available.
select.diagnosisCode.shortDescriptionbooleanShort diagnosis description resolved from the diagnosis-code reference data, when a match exists.
select.diagnosisCode.longDescriptionbooleanFull diagnosis description resolved from the diagnosis-code reference data, when a match exists.
where.diagnosisCodeobjectFilters on the diagnosis code's columns.
where.diagnosisCode.idobject | object | object | object | object | object | object | string[]ICD-10-CM diagnosis code, written without the dot (for example E119).
where.diagnosisCode.diagnosisCategoryIdobject | object | object | object | object | object | object | string[]ICD-10-CM category code the diagnosis code falls under: the longest category code that prefixes it (for example E11). May be empty when no matching category is available.
where.diagnosisCode.shortDescriptionobject | object | object | object | object | object | object | string[]Short diagnosis description resolved from the diagnosis-code reference data, when a match exists.
where.diagnosisCode.longDescriptionobject | object | object | object | object | object | object | string[]Full diagnosis description resolved from the diagnosis-code reference data, when a match exists.
aggregate.diagnosisCode.countbooleanWhen true, return the number of rows that match the filter.
aggregate.diagnosisCode.sumobjectNumeric columns to total across the rows that match the filter.
aggregate.diagnosisCode.avgobjectNumeric columns to average across the rows that match the filter.
aggregate.diagnosisCode.minobjectNumeric columns to find the smallest value of across the rows that match the filter.
aggregate.diagnosisCode.maxobjectNumeric columns to find the largest value of across the rows that match the filter.
ReturnsTyped browse response for DiagnosisCodeBrowseResponse
Conditional attributes
table[].diagnosisCodeobjectThe diagnosis code's columns, as selected by the request.
table[].diagnosisCode.idstringICD-10-CM diagnosis code, written without the dot (for example E119).
table[].diagnosisCode.diagnosisCategoryIdstringICD-10-CM category code the diagnosis code falls under: the longest category code that prefixes it (for example E11). May be empty when no matching category is available.
table[].diagnosisCode.shortDescriptionstringShort diagnosis description resolved from the diagnosis-code reference data, when a match exists.
table[].diagnosisCode.longDescriptionstringFull diagnosis description resolved from the diagnosis-code reference data, when a match exists.
aggregate.diagnosisCode.countintegerNumber of rows that match the filter. Present when `count` was requested.
aggregate.diagnosisCode.sumobjectTotal of each requested numeric column across the rows that match the filter.
aggregate.diagnosisCode.avgobjectAverage of each requested numeric column across the rows that match the filter.
aggregate.diagnosisCode.minobjectSmallest value of each requested numeric column across the rows that match the filter.
aggregate.diagnosisCode.maxobjectLargest value of each requested numeric column across the rows that match the filter.
Errors
400401500