API documentation

Supported Formats

json

Errors

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

Examples

GET /Condition?patient=1&access_token=6b5h9crwD1EP2zzNDifB5GNZi1rgmU3vmjsdJE9G9BfhQUL3Pm7stAUvJCgwSbAb
200
{
  "resourceType": "Bundle",
  "id": "a60df84c63af16a586b9266134801a16",
  "type": "search set",
  "entry": [
    {
      "full_url": "/Condition/1005",
      "resource": {
        "resourceType": "Condition",
        "id": "1005",
        "meta": {
          "versionId": "1",
          "lastUpdated": "2021-03-23T19:36:17.299+00:00",
          "source": "#E1VolYkq84D3M96u",
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition"
          ]
        },
        "clinicalStatus": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
              "code": "active",
              "display": "Active"
            }
          ]
        },
        "verificationStatus": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
              "code": "confirmed",
              "display": "Confirmed"
            }
          ]
        },
        "category": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/condition-category",
                "code": "problem-list-item",
                "display": "Problem List Item"
              },
              {
                "system": "http://terminology.hl7.org/CodeSystem/us-core-tags",
                "code": "sdoh",
                "display": "SDOH"
              }
            ]
          }
        ],
        "code": {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "code": "404684003",
              "display": "Overweight (finding)"
            }
          ]
        },
        "subject": {
          "reference": "Patient/1",
          "display": "Alice Newman"
        },
        "recordedDate": "2006-12-30T23:00:00-05:00"
      }
    },
    {
      "full_url": "/Condition/1004",
      "resource": {
        "resourceType": "Condition",
        "id": "1004",
        "meta": {
          "versionId": "1",
          "lastUpdated": "2021-03-23T19:36:17.299+00:00",
          "source": "#E1VolYkq84D3M96u",
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition"
          ]
        },
        "clinicalStatus": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
              "code": "active",
              "display": "Active"
            }
          ]
        },
        "verificationStatus": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
              "code": "confirmed",
              "display": "Confirmed"
            }
          ]
        },
        "category": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/condition-category",
                "code": "problem-list-item",
                "display": "Problem List Item"
              },
              {
                "system": "http://terminology.hl7.org/CodeSystem/us-core-tags",
                "code": "sdoh",
                "display": "SDOH"
              }
            ]
          }
        ],
        "code": {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "code": "404684003",
              "display": "Fever (finding)"
            }
          ]
        },
        "subject": {
          "reference": "Patient/1",
          "display": "Alice Newman"
        },
        "recordedDate": "2016-06-22T00:00:00-04:00"
      }
    },
    {
      "full_url": "/Condition/1003",
      "resource": {
        "resourceType": "Condition",
        "id": "1003",
        "meta": {
          "versionId": "1",
          "lastUpdated": "2021-03-23T19:36:17.299+00:00",
          "source": "#E1VolYkq84D3M96u",
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition"
          ]
        },
        "clinicalStatus": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
              "code": "active",
              "display": "Active"
            }
          ]
        },
        "verificationStatus": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
              "code": "confirmed",
              "display": "Confirmed"
            }
          ]
        },
        "category": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/condition-category",
                "code": "problem-list-item",
                "display": "Problem List Item"
              },
              {
                "system": "http://terminology.hl7.org/CodeSystem/us-core-tags",
                "code": "sdoh",
                "display": "SDOH"
              }
            ]
          }
        ],
        "code": {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "code": "404684003",
              "display": "Chronic rejection of renal transplant (disorder)"
            }
          ]
        },
        "subject": {
          "reference": "Patient/1",
          "display": "Alice Newman"
        },
        "recordedDate": "2011-12-30T23:00:00-05:00"
      }
    },
    {
      "full_url": "/Condition/1002",
      "resource": {
        "resourceType": "Condition",
        "id": "1002",
        "meta": {
          "versionId": "1",
          "lastUpdated": "2021-03-23T19:36:17.299+00:00",
          "source": "#E1VolYkq84D3M96u",
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition"
          ]
        },
        "clinicalStatus": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
              "code": "active",
              "display": "Active"
            }
          ]
        },
        "verificationStatus": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
              "code": "confirmed",
              "display": "Confirmed"
            }
          ]
        },
        "category": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/condition-category",
                "code": "problem-list-item",
                "display": "Problem List Item"
              },
              {
                "system": "http://terminology.hl7.org/CodeSystem/us-core-tags",
                "code": "sdoh",
                "display": "SDOH"
              }
            ]
          }
        ],
        "code": {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "code": "404684003",
              "display": "Severe hypothyroidism (disorder)"
            }
          ]
        },
        "subject": {
          "reference": "Patient/1",
          "display": "Alice Newman"
        },
        "recordedDate": "2006-12-30T23:00:00-05:00"
      }
    },
    {
      "full_url": "/Condition/1001",
      "resource": {
        "resourceType": "Condition",
        "id": "1001",
        "meta": {
          "versionId": "1",
          "lastUpdated": "2021-03-23T19:36:17.299+00:00",
          "source": "#E1VolYkq84D3M96u",
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition"
          ]
        },
        "clinicalStatus": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
              "code": "active",
              "display": "Active"
            }
          ]
        },
        "verificationStatus": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
              "code": "confirmed",
              "display": "Confirmed"
            }
          ]
        },
        "category": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/condition-category",
                "code": "problem-list-item",
                "display": "Problem List Item"
              },
              {
                "system": "http://terminology.hl7.org/CodeSystem/us-core-tags",
                "code": "sdoh",
                "display": "SDOH"
              }
            ]
          }
        ],
        "code": {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "code": "404684003",
              "display": "Essential hypertension (disorder)"
            }
          ]
        },
        "subject": {
          "reference": "Patient/1",
          "display": "Alice Newman"
        },
        "recordedDate": "2011-10-05T00:00:00-04:00"
      }
    }
  ],
  "total": 5
}

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.
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.

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 %>

Examples

GET /Condition/1005?access_token=6b5h9crwD1EP2zzNDifB5GNZi1rgmU3vmjsdJE9G9BfhQUL3Pm7stAUvJCgwSbAb
200
{
  "resourceType": "Condition",
  "id": "1005",
  "meta": {
    "versionId": "1",
    "lastUpdated": "2021-03-23T19:36:17.299+00:00",
    "source": "#E1VolYkq84D3M96u",
    "profile": [
      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition"
    ]
  },
  "clinicalStatus": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
        "code": "active",
        "display": "Active"
      }
    ]
  },
  "verificationStatus": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
        "code": "confirmed",
        "display": "Confirmed"
      }
    ]
  },
  "category": [
    {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/condition-category",
          "code": "problem-list-item",
          "display": "Problem List Item"
        },
        {
          "system": "http://terminology.hl7.org/CodeSystem/us-core-tags",
          "code": "sdoh",
          "display": "SDOH"
        }
      ]
    }
  ],
  "code": {
    "coding": [
      {
        "system": "http://snomed.info/sct",
        "code": "404684003",
        "display": "Overweight (finding)"
      }
    ]
  },
  "subject": {
    "reference": "Patient/1",
    "display": "Alice Newman"
  },
  "recordedDate": "2006-12-30T23:00:00-05:00"
}

Params

Param name

Description

access_token
required

CarePaths User OAuth Token

Validations:

Must be String.

id
optional

ID of requested condition

Validations:

Must be number.

Returns

Code: 200

Description:

List of resources

Param name	Description
resource_type required	Condition Validations: Must be String.
clinical_status required	Validations: Must be Hash.
verification_status required	Validations: Must be Hash.
category required	Validations: Must be Array.
code required	Validations: Must be Hash.
subject required	Validations: Must be Hash.
recorded_date 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.
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.

Conditions

Supported Formats

GET /Condition
Condition Bundle

Supported Formats

Errors

Examples

Params

Returns

Code: 200

Description:

GET /Condition/:id
Condition by id

Supported Formats

Errors

Examples

Params

Returns

Code: 200

Description:

GET /Condition/_search
Condition search

Supported Formats

Errors

Params

Conditions

Supported Formats

GET /Condition Condition Bundle

Supported Formats

Errors

Examples

Params

Returns

Code: 200

Description:

GET /Condition/:id Condition by id

Supported Formats

Errors

Examples

Params

Returns

Code: 200

Description:

GET /Condition/_search Condition search

Supported Formats

Errors

Params

GET /Condition
Condition Bundle

GET /Condition/:id
Condition by id

GET /Condition/_search
Condition search