Which of the procedure code's columns to return.
Endpoints
Procedures
POST
/v0/procedure-codes/browseBrowse procedure codes
Queries the CPT/HCPCS procedure 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.procedureCodeobjectselect.procedureCode.idbooleanCPT or HCPCS procedure code (for example 99213).
select.procedureCode.shortDescriptionbooleanShort procedure description resolved from the procedure-code reference data.
where.procedureCodeobjectFilters on the procedure code's columns.
where.procedureCode.idobject | object | object | object | object | object | object | string[]CPT or HCPCS procedure code (for example 99213).
where.procedureCode.shortDescriptionobject | object | object | object | object | object | object | string[]Short procedure description resolved from the procedure-code reference data.
aggregate.procedureCode.countbooleanWhen true, return the number of rows that match the filter.
aggregate.procedureCode.sumobjectNumeric columns to total across the rows that match the filter.
aggregate.procedureCode.avgobjectNumeric columns to average across the rows that match the filter.
aggregate.procedureCode.minobjectNumeric columns to find the smallest value of across the rows that match the filter.
aggregate.procedureCode.maxobjectNumeric columns to find the largest value of across the rows that match the filter.
ReturnsTyped browse response for ProcedureCodeBrowseResponse
Conditional attributes
table[].procedureCodeobjectThe procedure code's columns, as selected by the request.
table[].procedureCode.idstringCPT or HCPCS procedure code (for example 99213).
table[].procedureCode.shortDescriptionstringShort procedure description resolved from the procedure-code reference data.
aggregate.procedureCode.countintegerNumber of rows that match the filter. Present when `count` was requested.
aggregate.procedureCode.sumobjectTotal of each requested numeric column across the rows that match the filter.
aggregate.procedureCode.avgobjectAverage of each requested numeric column across the rows that match the filter.
aggregate.procedureCode.minobjectSmallest value of each requested numeric column across the rows that match the filter.
aggregate.procedureCode.maxobjectLargest value of each requested numeric column across the rows that match the filter.
Errors
400401500
POST
/v0/procedures/browseBrowse procedures
Queries the procedures 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.procedureobjectWhich of the procedure's columns to return.
select.procedure.refbooleanReference for the procedure record in the current output. It can change when clinical data is reprocessed.
select.procedure.lineSequencebooleanSequence number of the procedure line within its source visit or claim.
select.procedure.lineItemControlNumberbooleanSource control or tracking number for the procedure line.
select.procedure.revenueCodebooleanRevenue code reported for the procedure line. Preserve as text, including leading zeros.
select.procedure.modifier1booleanFirst modifier reported for the procedure code. Qualifies the service described by that code.
select.procedure.modifier2booleanSecond modifier reported for the procedure code.
select.procedure.modifier3booleanThird modifier reported for the procedure code.
select.procedure.modifier4booleanFourth modifier reported for the procedure code.
select.procedure.unitCountbooleanNumber of service units reported for the procedure line. Units depend on the procedure and source and may be fractional.
select.procedure.procedureCodeDescriptionbooleanDescription stored with the procedure when the source data was ingested. It may differ from the current reference-data description.
select.procedure.createdAtbooleanTimestamp associated with the procedure data in the platform. For procedures derived from a merged visit, this is the newest contributing visit-data timestamp.
select.procedure.companyIdbooleanPlatform identifier for the customer organization associated with the record.
select.procedure.projectIdbooleanPlatform identifier for the project containing the patient and record.
select.procedure.patientIdbooleanPlatform identifier for the patient associated with the record. Use with the company and project identifiers to identify the patient scope.
select.procedure.visitRefbooleanReference to the parent visit in the current clinical output. This reference can change when the data is reprocessed.
select.procedure.procedureCodebooleanProcedure code reported for the service, such as a CPT or HCPCS code. Preserve as text.
select.procedure.attendingProviderIdbooleanPlatform practitioner reference for the attending provider associated with the procedure.
select.procedure.renderingProviderIdbooleanPlatform practitioner reference for the rendering provider associated with the procedure.
select.procedure.operatingProviderIdbooleanPlatform practitioner reference for the operating provider associated with the procedure.
select.procedure.diagnosisCountbooleanNumber of diagnoses linked to this procedure line.
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.procedureCodeobject & objectWhich of the joined procedure code's columns to return. Absent when the row has no procedure code.
select.attendingProviderobject & objectWhich of the joined attending provider's columns to return. Absent when the row has no attending provider.
select.renderingProviderobject & objectWhich of the joined rendering provider's columns to return. Absent when the row has no rendering provider.
select.operatingProviderobject & objectWhich of the joined operating provider's columns to return. Absent when the row has no operating provider.
where.procedureobjectFilters on the procedure's columns.
where.procedure.refobject | object | object | object | object | object | object | string[]Reference for the procedure record in the current output. It can change when clinical data is reprocessed.
where.procedure.lineSequenceobject | object | object | object | object | object | object | object | string[]Sequence number of the procedure line within its source visit or claim.
where.procedure.lineItemControlNumberobject | object | object | object | object | object | object | string[]Source control or tracking number for the procedure line.
where.procedure.revenueCodeobject | object | object | object | object | object | object | string[]Revenue code reported for the procedure line. Preserve as text, including leading zeros.
where.procedure.modifier1object | object | object | object | object | object | object | string[]First modifier reported for the procedure code. Qualifies the service described by that code.
where.procedure.modifier2object | object | object | object | object | object | object | string[]Second modifier reported for the procedure code.
where.procedure.modifier3object | object | object | object | object | object | object | string[]Third modifier reported for the procedure code.
where.procedure.modifier4object | object | object | object | object | object | object | string[]Fourth modifier reported for the procedure code.
where.procedure.unitCountobject | object | object | object | object | object | object | object | string[]Number of service units reported for the procedure line. Units depend on the procedure and source and may be fractional.
where.procedure.procedureCodeDescriptionobject | object | object | object | object | object | object | string[]Description stored with the procedure when the source data was ingested. It may differ from the current reference-data description.
where.procedure.createdAtobject | object | object | object | object | object | object | object | string[]Timestamp associated with the procedure data in the platform. For procedures derived from a merged visit, this is the newest contributing visit-data timestamp.
where.procedure.companyIdobject | object | object | object | object | object | object | object | string[]Platform identifier for the customer organization associated with the record.
where.procedure.projectIdobject | object | object | object | object | object | object | string[]Platform identifier for the project containing the patient and record.
where.procedure.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.procedure.visitRefobject | object | object | object | object | object | object | string[]Reference to the parent visit in the current clinical output. This reference can change when the data is reprocessed.
where.procedure.procedureCodeobject | object | object | object | object | object | object | string[]Procedure code reported for the service, such as a CPT or HCPCS code. Preserve as text.
where.procedure.attendingProviderIdobject | object | object | object | object | object | object | string[]Platform practitioner reference for the attending provider associated with the procedure.
where.procedure.renderingProviderIdobject | object | object | object | object | object | object | string[]Platform practitioner reference for the rendering provider associated with the procedure.
where.procedure.operatingProviderIdobject | object | object | object | object | object | object | string[]Platform practitioner reference for the operating provider associated with the procedure.
where.procedure.diagnosisCountobject | object | object | object | object | object | object | object | string[]Number of diagnoses linked to this procedure line.
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.procedureCodestring | object & objectFilters on the joined procedure code's columns. `isNull` or `isNotNull` in place of the filters matches the rows without or with a procedure code.
where.attendingProviderstring | object & objectFilters on the joined attending provider's columns. `isNull` or `isNotNull` in place of the filters matches the rows without or with a attending provider.
where.renderingProviderstring | object & objectFilters on the joined rendering provider's columns. `isNull` or `isNotNull` in place of the filters matches the rows without or with a rendering provider.
where.operatingProviderstring | object & objectFilters on the joined operating provider's columns. `isNull` or `isNotNull` in place of the filters matches the rows without or with a operating provider.
aggregate.procedure.countbooleanWhen true, return the number of rows that match the filter.
aggregate.procedure.sumobjectNumeric columns to total across the rows that match the filter.
aggregate.procedure.avgobjectNumeric columns to average across the rows that match the filter.
aggregate.procedure.minobjectNumeric columns to find the smallest value of across the rows that match the filter.
aggregate.procedure.maxobjectNumeric columns to find the largest value of across the rows that match the filter.
ReturnsTyped browse response for ProcedureBrowseResponse
Conditional attributes
table[].procedureobject & objectThe procedure'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[].procedureCodeobject & objectThe joined procedure code's columns, as selected by the request. Absent when the row has no procedure code.
table[].attendingProviderobject & objectThe joined attending provider's columns, as selected by the request. Absent when the row has no attending provider.
table[].renderingProviderobject & objectThe joined rendering provider's columns, as selected by the request. Absent when the row has no rendering provider.
table[].operatingProviderobject & objectThe joined operating provider's columns, as selected by the request. Absent when the row has no operating provider.
aggregate.procedure.countintegerNumber of rows that match the filter. Present when `count` was requested.
aggregate.procedure.sumobjectTotal of each requested numeric column across the rows that match the filter.
aggregate.procedure.avgobjectAverage of each requested numeric column across the rows that match the filter.
aggregate.procedure.minobjectSmallest value of each requested numeric column across the rows that match the filter.
aggregate.procedure.maxobjectLargest value of each requested numeric column across the rows that match the filter.
Errors
400401500