GET api/v1/{EMRSystem}/Observations

Returns the Observations (Flowsheets or Clinical Interventions) for a given patient. Observations typically document interventions for a patient's visit (e.g., vital signs, patient turn, pain scale, etc.). FHIR connectors use the following resources for R4: Observation.Search, Patient.Read, and Encounter.Read.

Status: Released

URI Parameters

NameDescriptionTypeAdditional information
EMRSystem

The emr system.

EMRSystem

None.
UserId

Gets or sets the user identifier.

string

Required
PatientId

Gets or sets the patient identifier.

string

Required
EncounterId

Gets or sets the encounter identifier.

string

None.
CategoryId

Gets or sets the observation category identifier.

string

Required if EMRSystem = Epic
ComponentList

Gets or sets the component list.

string

None.
MaxRecords

Gets or sets the maximum records. If not set, defaulted to 9999

integer

None.
FromDateTime

Gets or sets from date.

datetime

None.
ToDateTime

Gets or sets to date.

datetime

None.

Header Parameters

NameDescriptionTypeAdditional information
LoginId

Gets or sets the login identifier. This Login Id will be encrypted and passed in Sansoro specific Http Request Headers.

string

Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox
Password

Gets or sets the password. This Password will be encrypted and passed in Sansoro specific Http Request Headers.

string

Data type: Password

Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox
EmrInstance

Gets or sets the emr instance. This emr instance info will be encrypted and passed in Sansoro specific Http Request Headers.

string

None.
ApplicationName

Gets or sets the requesting application name. This requesting application name will be encrypted and passed in Sansoro specific Http Request Headers.

string

Required if using application keys
ApplicationKey

Gets or sets the requesting application key. This requesting application key will be encrypted and passed in Sansoro specific Http Request Headers.

string

Data type: Password

Required if using application keys
AuthorizationToken

Gets or sets the custom authorization token. This requesting authorization token will be encrypted and passed in Sansoro specific Http Request Headers.

string

None.
RequestVerboseLogging

Enables verbose logging for a single request. When "true", verbose logging will occur. When "false", the configuration setting will be respected. This value will be passed in Sansoro specific Http Request Headers.

boolean

None.

Response Information

Collection of UdmObservationResponse
NameDescriptionTypeAdditional information
ObservationId

Gets or sets the Observation identifier.

string

None.
CategoryId

Gets or sets the Category identifier.

string

None.
CategoryDesc

Gets or sets the Category description.

string

None.
OrderId

Gets or sets the order identifier.

string

None.
ComponentId

Gets or sets the component identifier.

string

None.
ComponentDesc

Gets or sets the component desc.

string

None.
ObservationType

Gets or sets the type of the Observation.

string

None.
ObservationStatus

Gets or sets the Observation status.

string

None.
ObservationValue

Gets or sets the Observation value.

string

None.
ObservationUnits

Gets or sets the Observation units.

string

None.
Normalcy

Gets or sets the normalcy.

string

None.
EffectiveDateTime

Gets or sets the effective date time.

datetime

None.
ObservedDateTime

Gets or sets the observed date time.

datetime

None.
NormalHigh

Gets or sets the normal high.

string

None.
NormalLow

Gets or sets the normal low.

string

None.
ObservationGroup

The group this observation belongs to, this is usually dynamic and different than the category

CodedObject

None.
PatientId

Gets or sets the patient identifier.

string

None.
EncounterId

Gets or sets the encounter identifier.

string

None.
EncounterType

Gets or sets the encounter type.

CodedObject

None.
PatientClass

Gets or sets the patient class.

CodedObject

None.
Tasks

Gets or sets the List of Tasks.

Collection of TaskObject

None.
DocumentedBy

Gets or sets the Providers and their Actions

Collection of ProviderWithAction

None.
CodedResults

Gets or sets the list of CodedResults

Collection of CodedObject

None.
ObservationValueLongText

Gets or sets a list of the Result Values that are long text.

Collection of Note

None.
ObservationComment

Gets or sets a list of the Observation Comments

Collection of Note

None.
System

Gets or sets the System

CodedObject

None.

Response Codes

Http Status Code 200 - Indicates that the request was processed successfully.

Http Status Code 400 - Indicates that the request did not contain all the required fields or had an invalid value.

Http Status Code 401 - Indicates that authentication to the underlying EMR server using the provided LoginId and Password failed.

Http Status Code 403 - Indicates that there is an issue with the request UserId.

Http Status Code 408 - Indicates that the request to the underlying EMR server timed out.

Http Status Code 500 - Indicates that an internal server error occurred during processing of the request.

Http Status Code 502 - Indicates that a request made to the underlying EMR server could not be completed.

Response Formats

application/json

[
  {
    "ObservationId": "sample string 1",
    "CategoryId": "sample string 2",
    "CategoryDesc": "sample string 3",
    "OrderId": "sample string 4",
    "ComponentId": "sample string 5",
    "ComponentDesc": "sample string 6",
    "ObservationType": "sample string 7",
    "ObservationStatus": "sample string 8",
    "ObservationValue": "sample string 9",
    "ObservationUnits": "sample string 10",
    "Normalcy": "sample string 11",
    "EffectiveDateTime": "2025-12-12T20:56:31.5658629+00:00",
    "ObservedDateTime": "2025-12-12T20:56:31.5659147+00:00",
    "NormalHigh": "sample string 12",
    "NormalLow": "sample string 13",
    "ObservationGroup": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "PatientId": "sample string 14",
    "EncounterId": "sample string 15",
    "EncounterType": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "PatientClass": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "Tasks": [
      {
        "TaskId": "sample string 1",
        "TaskClass": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        "TaskStatus": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        "TaskType": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        }
      },
      {
        "TaskId": "sample string 1",
        "TaskClass": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        "TaskStatus": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        "TaskType": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        }
      }
    ],
    "DocumentedBy": [
      {
        "Provider": {
          "ProviderId": "sample string 1",
          "ProviderName": "sample string 2"
        },
        "Action": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        "ActionDateTime": "2025-12-12T20:56:31.5684894+00:00"
      },
      {
        "Provider": {
          "ProviderId": "sample string 1",
          "ProviderName": "sample string 2"
        },
        "Action": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        "ActionDateTime": "2025-12-12T20:56:31.5684894+00:00"
      }
    ],
    "CodedResults": [
      {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      {
        "Id": "sample string 1",
        "Name": "sample string 2"
      }
    ],
    "ObservationValueLongText": [
      {
        "Comments": "sample string 1",
        "NoteDateTime": "2025-12-12T20:56:31.5688355+00:00",
        "Format": "sample string 2",
        "IsEncoded": true,
        "Provider": {
          "ProviderId": "sample string 1",
          "ProviderName": "sample string 2"
        },
        "NoteType": "sample string 4"
      },
      {
        "Comments": "sample string 1",
        "NoteDateTime": "2025-12-12T20:56:31.5688355+00:00",
        "Format": "sample string 2",
        "IsEncoded": true,
        "Provider": {
          "ProviderId": "sample string 1",
          "ProviderName": "sample string 2"
        },
        "NoteType": "sample string 4"
      }
    ],
    "ObservationComment": [
      {
        "Comments": "sample string 1",
        "NoteDateTime": "2025-12-12T20:56:31.5688355+00:00",
        "Format": "sample string 2",
        "IsEncoded": true,
        "Provider": {
          "ProviderId": "sample string 1",
          "ProviderName": "sample string 2"
        },
        "NoteType": "sample string 4"
      },
      {
        "Comments": "sample string 1",
        "NoteDateTime": "2025-12-12T20:56:31.5688355+00:00",
        "Format": "sample string 2",
        "IsEncoded": true,
        "Provider": {
          "ProviderId": "sample string 1",
          "ProviderName": "sample string 2"
        },
        "NoteType": "sample string 4"
      }
    ],
    "System": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    }
  },
  {
    "ObservationId": "sample string 1",
    "CategoryId": "sample string 2",
    "CategoryDesc": "sample string 3",
    "OrderId": "sample string 4",
    "ComponentId": "sample string 5",
    "ComponentDesc": "sample string 6",
    "ObservationType": "sample string 7",
    "ObservationStatus": "sample string 8",
    "ObservationValue": "sample string 9",
    "ObservationUnits": "sample string 10",
    "Normalcy": "sample string 11",
    "EffectiveDateTime": "2025-12-12T20:56:31.5658629+00:00",
    "ObservedDateTime": "2025-12-12T20:56:31.5659147+00:00",
    "NormalHigh": "sample string 12",
    "NormalLow": "sample string 13",
    "ObservationGroup": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "PatientId": "sample string 14",
    "EncounterId": "sample string 15",
    "EncounterType": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "PatientClass": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "Tasks": [
      {
        "TaskId": "sample string 1",
        "TaskClass": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        "TaskStatus": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        "TaskType": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        }
      },
      {
        "TaskId": "sample string 1",
        "TaskClass": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        "TaskStatus": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        "TaskType": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        }
      }
    ],
    "DocumentedBy": [
      {
        "Provider": {
          "ProviderId": "sample string 1",
          "ProviderName": "sample string 2"
        },
        "Action": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        "ActionDateTime": "2025-12-12T20:56:31.5684894+00:00"
      },
      {
        "Provider": {
          "ProviderId": "sample string 1",
          "ProviderName": "sample string 2"
        },
        "Action": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        },
        "ActionDateTime": "2025-12-12T20:56:31.5684894+00:00"
      }
    ],
    "CodedResults": [
      {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      {
        "Id": "sample string 1",
        "Name": "sample string 2"
      }
    ],
    "ObservationValueLongText": [
      {
        "Comments": "sample string 1",
        "NoteDateTime": "2025-12-12T20:56:31.5688355+00:00",
        "Format": "sample string 2",
        "IsEncoded": true,
        "Provider": {
          "ProviderId": "sample string 1",
          "ProviderName": "sample string 2"
        },
        "NoteType": "sample string 4"
      },
      {
        "Comments": "sample string 1",
        "NoteDateTime": "2025-12-12T20:56:31.5688355+00:00",
        "Format": "sample string 2",
        "IsEncoded": true,
        "Provider": {
          "ProviderId": "sample string 1",
          "ProviderName": "sample string 2"
        },
        "NoteType": "sample string 4"
      }
    ],
    "ObservationComment": [
      {
        "Comments": "sample string 1",
        "NoteDateTime": "2025-12-12T20:56:31.5688355+00:00",
        "Format": "sample string 2",
        "IsEncoded": true,
        "Provider": {
          "ProviderId": "sample string 1",
          "ProviderName": "sample string 2"
        },
        "NoteType": "sample string 4"
      },
      {
        "Comments": "sample string 1",
        "NoteDateTime": "2025-12-12T20:56:31.5688355+00:00",
        "Format": "sample string 2",
        "IsEncoded": true,
        "Provider": {
          "ProviderId": "sample string 1",
          "ProviderName": "sample string 2"
        },
        "NoteType": "sample string 4"
      }
    ],
    "System": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    }
  }
]

'

GET api/v1/{EMRSystem}/Observations

Returns the Observations (Flowsheets or Clinical Interventions) for a given patient. Observations typically document interventions for a patient's visit (e.g., vital signs, patient turn, pain scale, etc.). FHIR connectors use the following resources for R4: Observation.Search, Patient.Read, and Encounter.Read.

Status: Released

URI Parameters


Required
Required
Required if EMRSystem = Epic

Header Parameters

Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox
Data type: Password , Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox
Required if using application keys
Data type: Password , Required if using application keys

Request: {{ method }} {{ url }}

  • Http Request Headers
  • {{header.name}} : {{header.value}} ******
  • Http Request Body
  • {{httpRequestBody}}
  • Http Response Headers
  • {{header.name}} : {{header.value}} ******
  • Http Response Data
  • {{httpResponseData}}