Observations

To define

Supported Formats

json
>>>

GET /api/Observation
Observations

Supported Formats

json

Errors

Code Description
401 Unauthorized
500 Server crashed for some <%= reason %>

Examples

GET /Observation
401
GET /Observation?_revinclude=Provenance%3Atarget&code=72166-2&patient=1&access_token=Pn4p4dV8wKy5p8awLR9CYQRWdsgNYLRxRef5DdYEDt1smi6jkMbfu2Zmp9q3Svkh
200
{
  "resourceType": "Bundle",
  "id": "162eede88687c5342f0e8af169088b0a",
  "type": "searchset",
  "entry": [
    {
      "full_url": "/Observation/26",
      "resource": {
        "resourceType": "Observation",
        "id": "26",
        "status": "final",
        "issued": "2025-12-12T13:24:32.000-05:00",
        "category": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                "code": "social-history",
                "display": "Social History"
              }
            ],
            "text": "Social History"
          }
        ],
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "72166-2",
              "display": "Tobacco smoking status"
            }
          ],
          "text": "Tobacco smoking status"
        },
        "subject": {
          "reference": "Patient/1",
          "display": "Alice Newman"
        },
        "effectiveDateTime": "2015-06-22T00:00:00.000-04:00",
        "valueCodeableConcept": {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "code": "449868002"
            }
          ],
          "text": "Smokes tobacco daily (finding)"
        }
      }
    },
    {
      "full_url": "/Provenance/SmokingStatus26",
      "resource": {
        "resourceType": "Provenance",
        "id": "SmokingStatus26",
        "target": [
          {
            "reference": "Practitioner/1008"
          }
        ],
        "recorded": "2015-06-22T00:00:00.000-04:00",
        "agent": [
          {
            "id": "erecord",
            "onBehalfOf": {
              "display": "Practitioner/1016",
              "reference": "Practitioner/1008"
            },
            "type": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
                  "code": "author"
                }
              ]
            },
            "who": {
              "reference": "Practitioner/1008"
            }
          },
          {
            "id": "erecord_1",
            "onBehalfOf": {
              "display": "Practitioner/1016",
              "reference": "Organization/1007"
            },
            "type": {
              "coding": [
                {
                  "system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-provenance-participant-type",
                  "code": "transmitter"
                }
              ]
            },
            "who": {
              "display": "Practitioner/1016"
            }
          }
        ]
      }
    }
  ],
  "total": 2
}
GET /Observation?_revinclude=Provenance%3Atarget&code=72166-2&patient=1&access_token=Pn4p4dV8wKy5p8awLR9CYQRWdsgNYLRxRef5DdYEDt1smi6jkMbfu2Zmp9q3Svkh
200
{
  "resourceType": "Bundle",
  "id": "c14573b0676802f9c5c020ec1b51cb7a",
  "type": "searchset",
  "entry": [
    {
      "full_url": "/Observation/26",
      "resource": {
        "resourceType": "Observation",
        "id": "26",
        "status": "final",
        "issued": "2025-12-12T13:24:32.000-05:00",
        "category": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                "code": "social-history",
                "display": "Social History"
              }
            ],
            "text": "Social History"
          }
        ],
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "72166-2",
              "display": "Tobacco smoking status"
            }
          ],
          "text": "Tobacco smoking status"
        },
        "subject": {
          "reference": "Patient/1",
          "display": "Alice Newman"
        },
        "effectiveDateTime": "2015-06-22T00:00:00.000-04:00",
        "valueCodeableConcept": {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "code": "449868002"
            }
          ],
          "text": "Smokes tobacco daily (finding)"
        }
      }
    },
    {
      "full_url": "/Provenance/SmokingStatus26",
      "resource": {
        "resourceType": "Provenance",
        "id": "SmokingStatus26",
        "target": [
          {
            "reference": "Practitioner/1008"
          }
        ],
        "recorded": "2015-06-22T00:00:00.000-04:00",
        "agent": [
          {
            "id": "erecord",
            "onBehalfOf": {
              "display": "Practitioner/1016",
              "reference": "Practitioner/1008"
            },
            "type": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
                  "code": "author"
                }
              ]
            },
            "who": {
              "reference": "Practitioner/1008"
            }
          },
          {
            "id": "erecord_1",
            "onBehalfOf": {
              "display": "Practitioner/1016",
              "reference": "Organization/1007"
            },
            "type": {
              "coding": [
                {
                  "system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-provenance-participant-type",
                  "code": "transmitter"
                }
              ]
            },
            "who": {
              "display": "Practitioner/1016"
            }
          }
        ]
      }
    }
  ],
  "total": 2
}
GET /Observation?_revinclude=Provenance%3Atarget&code=72166-2&patient=1&access_token=Pn4p4dV8wKy5p8awLR9CYQRWdsgNYLRxRef5DdYEDt1smi6jkMbfu2Zmp9q3Svkh
200
{
  "resourceType": "Bundle",
  "id": "08b72576c5cda4319e3f07ef3938374b",
  "type": "searchset",
  "entry": [
    {
      "full_url": "/Observation/26",
      "resource": {
        "resourceType": "Observation",
        "id": "26",
        "status": "final",
        "issued": "2025-12-12T13:24:32.000-05:00",
        "category": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                "code": "social-history",
                "display": "Social History"
              }
            ],
            "text": "Social History"
          }
        ],
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "72166-2",
              "display": "Tobacco smoking status"
            }
          ],
          "text": "Tobacco smoking status"
        },
        "subject": {
          "reference": "Patient/1",
          "display": "Alice Newman"
        },
        "effectiveDateTime": "2015-06-22T00:00:00.000-04:00",
        "valueCodeableConcept": {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "code": "449868002"
            }
          ],
          "text": "Smokes tobacco daily (finding)"
        }
      }
    },
    {
      "full_url": "/Provenance/SmokingStatus26",
      "resource": {
        "resourceType": "Provenance",
        "id": "SmokingStatus26",
        "target": [
          {
            "reference": "Practitioner/1008"
          }
        ],
        "recorded": "2015-06-22T00:00:00.000-04:00",
        "agent": [
          {
            "id": "erecord",
            "onBehalfOf": {
              "display": "Practitioner/1016",
              "reference": "Practitioner/1008"
            },
            "type": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
                  "code": "author"
                }
              ]
            },
            "who": {
              "reference": "Practitioner/1008"
            }
          },
          {
            "id": "erecord_1",
            "onBehalfOf": {
              "display": "Practitioner/1016",
              "reference": "Organization/1007"
            },
            "type": {
              "coding": [
                {
                  "system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-provenance-participant-type",
                  "code": "transmitter"
                }
              ]
            },
            "who": {
              "display": "Practitioner/1016"
            }
          }
        ]
      }
    }
  ],
  "total": 2
}

Params

Param name Description
access_token
optional

CarePaths User OAuth Token

Validations:

  • Must be String.
code
optional

LOINC code of requested observation i.e. 72166-2 or loinc.org|72166-2

Validations:

  • Must be string.
category
optional

Category of observation i.e. laboratory/vital-signs

Validations:

  • Must be string.
date
optional

Date of observations with optional prefix in the form of two letters i.e. lt/gt/le/ge

Validations:

  • Must be string.
patient
optional

id of the requested patient

Validations:

  • Must be number.
start_date
optional

Start date for dataset; Format YYYY-MM-DD

Validations:

  • Must be Date.
end_date
optional

End date for dataset; Format YYYY-MM-DD

Validations:

  • Must be Date.

Returns

Code: 200

Description:

List of resources

Param name Description
resource_type
required

Bundle

Validations:

  • Must be String.
type
required

Validations:

  • Must be String.
>>>

POST /api/Observation/_search
Observations by POST

GET /api/Observation
Observation by ID

Supported Formats

json

Errors

Code Description
401 Unauthorized
500 Server crashed for some <%= reason %>

Params

Param name Description
access_token
optional

CarePaths User OAuth Token

Validations:

  • Must be String.

Returns

Code: 200

Description:

List of resources

Param name Description
resource_type
required

Observation

Validations:

  • Must be String.
issued
required

Validations:

  • Must be String.