GET api/v1/healthprofessional/patient/{patientId}/observation/{operation}/{typeId}/period?Value={Value}&Type={Type}&GroupedBy={GroupedBy}&Order={Order}&Offset={Offset}

Gets a collection of observations based on query for a period

Request Information

Headers

URI Parameters

Name	Description	Type	Additional information
patientId		string	Required
operation	The operation. {value, avg}	string	Required
typeId	The type identifier of the device type	DeviceType	Required
Value	The value of the period	integer	Required
Type	The type of the period	PeriodType	Required
GroupedBy	{Optional} - Defined the grouping used by the operation.	GroupedBy	None.
Order	{Optional} - Order of the data based on timestamp. Default set to ascending.	string	None.
Offset	{Optional} - Return timestamp with calculated offset, defaul = false.	boolean	None.

Body Parameters

None.

Response Information

Headers

Resource Description

Collection of observations

ObservationGroupedByPatient

Name	Description	Type	Additional information
PatientId		string	None.
ObservationGroupedBy		Collection of ObservationGroupedBy	None.

Response Formats

application/json

Sample:

{
  "PatientId": "sample string 1",
  "ObservationGroupedBy": [
    {
      "GroupedBy": {
        "Year": 1,
        "Value": 1,
        "ValueType": "sample string 1",
        "NumberOfObservations": 2,
        "StartDate": "2025-02-03T10:57:58.3933262+00:00",
        "EndDate": "2025-02-03T10:57:58.3933262+00:00"
      },
      "Observation": {
        "Typeid": 528388,
        "Timestamp": "sample string 1",
        "Inputtype": "sample string 2",
        "Source": "sample string 3",
        "Equipmentid": "sample string 4",
        "Measurements": [
          {
            "TypeId": 68185,
            "Value": "sample string 1",
            "UnitCode": 262656
          },
          {
            "TypeId": 68185,
            "Value": "sample string 1",
            "UnitCode": 262656
          }
        ],
        "Comment": "sample string 5",
        "Contexts": [
          {
            "TypeId": 29152,
            "Context": "sample string 1"
          },
          {
            "TypeId": 29152,
            "Context": "sample string 1"
          }
        ]
      }
    },
    {
      "GroupedBy": {
        "Year": 1,
        "Value": 1,
        "ValueType": "sample string 1",
        "NumberOfObservations": 2,
        "StartDate": "2025-02-03T10:57:58.3933262+00:00",
        "EndDate": "2025-02-03T10:57:58.3933262+00:00"
      },
      "Observation": {
        "Typeid": 528388,
        "Timestamp": "sample string 1",
        "Inputtype": "sample string 2",
        "Source": "sample string 3",
        "Equipmentid": "sample string 4",
        "Measurements": [
          {
            "TypeId": 68185,
            "Value": "sample string 1",
            "UnitCode": 262656
          },
          {
            "TypeId": 68185,
            "Value": "sample string 1",
            "UnitCode": 262656
          }
        ],
        "Comment": "sample string 5",
        "Contexts": [
          {
            "TypeId": 29152,
            "Context": "sample string 1"
          },
          {
            "TypeId": 29152,
            "Context": "sample string 1"
          }
        ]
      }
    }
  ]
}