Integrating with Measurements through the CoachCare API

This article provides guidance on integrating with the measurement feature of the CoachCare API.  The measurements feature is broadly defined as the functionality for a clinic to organize, capture, and view measurement data for an individual patient.  The feature provides flexibility to define what those measurements are, how they are organized, and which user types (patient and/or provider) can interact with those measurements.

Key Concepts and Notes

• Main Components
  To utilize and interact with the measurement feature, there are four main components to understand:
  
  • Data Point Type
    The type measurement, such as weight, body at percentage, heart rate, systolic blood pressure, hdl cholesterol, etc. 
  • Label
    A category name or grouping used to associate similar data point types, such as composition, vitals, or circumference.  Labels are used to assist in visually and logically organizing the data point types for both patients and providers
  • Preference
    The functionality to manage (add, edit, remove, set order) data point types and labels to your organization and subsequently to patients and/or providers.  Further, this is used to control visibility and edibility of the data point types to patients and providers.
  • Group
    Managing (adding, editing, removing, listing, viewing) data point type entries.  For example, fetching weight measurements for a patient.
• Structure
  Measurements are grouped into categories, and sub at a specific organization as a preference.  As with other features of the platform, this 
  A Measurement is intended to be a point-in-time data record.
• Data Point Types Cannot be Created via the API 
  Through the API, you are able to expose or hide any available data point type to your organization.  However, the available data point types cannot be created through the API.  If you would like new data point types added, please email [e-mail] with a request.  Please provide the title, unit name, minimum validation value, and maximum validation value.
  CoachCare imposes this restriction to prevent unnecessary duplication or data point types, in an effort to maintain a clean and curated listing.

API Endpoint Summaries

	Title/Grouping	Purpose	Provider Account Type Use Cases	Client Account Type Use Cases
Platform-Wide	Type	Fetch information about data-points	Fetch and display information (name, bounds, units) for a data-point type in a specified locale	Fetch and display information (name, bounds, units) for a data-point type in a specified locale
Clinic-Specific	Label	Manages categories of measurements available in an organization Manage i18n strings and translations of those names	Manage available categories for clinic Used to construct category and measurement listings	Used to construct category and measurement listings
Clinic-Specific	Preference	Manages the preference entity for a clinic’s ‘measurement management’ setup	Manage (create or inherit) the ‘measurement management' preference for a specific clinic (at and below this clinic) Define if this preference is enforced onto all child clinics (descendantTypeManagementEnabled as false) or if child clinics can override (descendantTypeManagementEnabled as true)	Fetch preference for specific clinic
Clinic-Specific	Type Association	Manages the ordered listings of exposed measurement data points types by organization, with a specific label. Although technically under-the-hood all data-points would be available to a user, the labels are the (non-enforced) source of truth for display	Manage exposed measurement data point types Used to construct category and measurement listings within various sections of patient profile	Used to construct category and measurement listings Used to construct add new measurement listing
General Usage	Group	Viewing, adding, removing multiple measurements	View and add multiple measurements for patients	View and add multiple measurement
General Usage	General/Data Point	Viewing, adding, removing a single measurement	View and add a single measurement for patients	View and add a single measurement

API Endpoint References

Label

• Manage Labels
  • GET Fetch all labels, with either specific locale or all available translations https://documentation.api.coachcare.com/?urls.primaryName=v1#/measurement/getAllMeasurementLabelV1
  • GET Fetch single, with either specific locale or all available translations https://documentation.api.coachcare.com/?urls.primaryName=v1#/measurement/getSingleMeasurementLabelV1
  • POST Create single label, with only a default non-translated name https://documentation.api.coachcare.com/?urls.primaryName=v1#/measurement/createMeasurementLabelV1
  • PATCH Update single label, but not the i18n translations https://documentation.api.coachcare.com/?urls.primaryName=v1#/measurement/updateMeasurementLabelV1
• Manage Locale for a single label
  • PUT Sets a single label to a specific locale https://documentation.api.coachcare.com/?urls.primaryName=v1#/measurement/upsertMeasurementLabelLocaleV1
  • DELETE Remove a single label from a specific locale https://documentation.api.coachcare.com/?urls.primaryName=v1#/measurement/deleteMeasurementLabelLocaleV1

Preference

• GET Fetch preference for specific clinic (by org id) https://documentation.api.coachcare.com/?urls.primaryName=v1#/measurement/getMatchingMeasurementPreferenceV1

• GET Fetch preference by the preference ID https://documentation.api.coachcare.com/?urls.primaryName=v1#/measurement/getSingleMeasurementPreferenceV1

• POST Create preference https://documentation.api.coachcare.com/?urls.primaryName=v1#/measurement/createMeasurementPreferenceV1

• PATCH Update preference https://documentation.api.coachcare.com/?urls.primaryName=v1#/measurement/updateMeasurementPreferenceV1

• DELETE Remove preference https://documentation.api.coachcare.com/?urls.primaryName=v1#/measurement/deleteMeasurementPreferenceV1

General/Data Point

• GET Fetch aggregate data https://documentation.api.coachcare.com/?urls.primaryName=v1#/measurement/getDataPointAggregateV1

• GET Fetch data points sample https://documentation.api.coachcare.com/?urls.primaryName=v1#/measurement/getDataPointSampleV1

• GET Fetch data points snapshot https://documentation.api.coachcare.com/?urls.primaryName=v1#/measurement/getDataPointSnapshotV1

• GET Fetch data point summary https://documentation.api.coachcare.com/?urls.primaryName=v1#/measurement/getDataPointSummaryV1

• POST Replace a single data point in a group https:/}documentation.api.coachcare.com/?urls.primaryName=v1#/measurement/replaceDataPointV1

• GET Fetch data point by id https://documentation.api.coachcare.com/?urls.primaryName=v1#/measurement/getSingleDataPointV1

• DELETE Delete data point by id https://documentation.api.coachcare.com/?urls.primaryName=v1#/measurement/removeDataPointV1

Group

• GET Fetch Data point group listing https://documentation.api.coachcare.com/?urls.primaryName=v1#/measurement/getDataPointGroupListingV1

• POST Create a new data point grouping https://documentation.api.coachcare.com/?urls.primaryName=v1#/measurement/createDataPointGroupV1

• GET Fetch a single data point group by ID https://documentation.api.coachcare.com/?urls.primaryName=v1#/measurement/getSingleDataPointGroupV1

• DELETE Remove a data point group by ID https://documentation.api.coachcare.com/?urls.primaryName=v1#/measurement/removeDataPointGroupV1

Type

• GET Fetch listing of data point types https://documentation.api.coachcare.com/?urls.primaryName=v1#/measurement/getAllMeasurementDataPointTypeV1

• GET Fetch single data point by id https://documentation.api.coachcare.com/?urls.primaryName=v1#/measurement/getSingleMeasurementDataPointTypeV1

Type Locale

• GET Fetch locale of data point by id https://documentation.api.coachcare.com/?urls.primaryName=v1#/measurement/getSingleMeasurementDataPointTypeLocaleV1

• PUT Update single data point locale by id https://documentation.api.coachcare.com/?urls.primaryName=v1#/measurement/upsertMeasurementDataPointTypeLocaleV1

• DELETE Remove single data point locale by id https://documentation.api.coachcare.com/?urls.primaryName=v1#/measurement/deleteMeasurementLabelLocaleV1

Type Association

• GET Fetch listing of associations https://documentation.api.coachcare.com/?urls.primaryName=v1#/measurement/getAllMeasurementDataPointTypeAssociationV1

• POST Create association https://documentation.api.coachcare.com/?urls.primaryName=v1#/measurement/createMeasurementDataPointTypeAssociationV1

• GET Fetch single association https://documentation.api.coachcare.com/?urls.primaryName=v1#/measurement/getSingleMeasurementDataPointTypeAssociationV1

• PATCH Update single association https://documentation.api.coachcare.com/?urls.primaryName=v1#/measurement/updateMeasurementDataPointTypeAssociationV1