Observations

Supported Formats

json

Errors

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

Examples

GET /Observation?_revinclude=Provenance%3Atarget&code=72166-2&patient=1&access_token=6b5h9crwD1EP2zzNDifB5GNZi1rgmU3vmjsdJE9G9BfhQUL3Pm7stAUvJCgwSbAb
200
{
  "resourceType": "Bundle",
  "id": "56cbcf8d37a413b761f0f2b89a432d0f",
  "type": "search set",
  "entry": [
    {
      "full_url": "/Observation/26",
      "resource": {
        "resourceType": "Observation",
        "id": "26",
        "status": "final",
        "issued": "2022-11-29T17:11:38.000-05:00",
        "category": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/observation-category",
                "code": "social-history",
                "display": "Social History"
              }
            ]
          }
        ],
        "code": {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "72166-2",
              "display": "Tobacco smoking status"
            }
          ],
          "text": "Tobacco smoking status"
        },
        "subject": {
          "reference": "Patient/1",
          "display": " "
        },
        "effectiveDateTime": "2015-06-22T00:00:00.000-04:00",
        "valueCodeableConcept": {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "code": "8517006"
            }
          ]
        }
      }
    },
    {
      "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 required	CarePaths User OAuth Token Validations: Must be String.
patient optional	ID of the requested patient Validations: Must be number.
code optional	LOINC code of requested observation i.e. 72166-2 or loinc.org|72166-2 Validations: Must be string.
category optional	Specifies the type of observation i.e. vital-signs or terminology.hl7.org/CodeSystem/observation-category|vital-signs Validations: Must be string.
date optional	Date of Observation with optional prefix in the form of two letters i.e. lt/gt/le/ge Validations: Must be string.
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.

Supported Formats

json

Errors

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

Params

Param name	Description
access_token required	CarePaths User OAuth Token Validations: Must be String.
id optional	ID of the requested observation Validations: Must be number.

Returns

Code: 200

Description:

List of resources

Param name	Description
resource_type required	Observation Validations: Must be String.
issued required	Validations: Must be String.

Supported Formats

json

Errors

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

Params

Param name	Description
access_token required	CarePaths User OAuth Token Validations: Must be String.
patient optional	ID of the requested patient Validations: Must be number.
code optional	LOINC code of requested observation i.e. 72166-2 or loinc.org|72166-2 Validations: Must be string.
category optional	Specifies the type of observation i.e. vital-signs or terminology.hl7.org/CodeSystem/observation-category|vital-signs Validations: Must be string.
date optional	Date of Observation with optional prefix in the form of two letters i.e. lt/gt/le/ge Validations: Must be string.
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.