Problems

To define

Supported Formats

json
>>>

GET /api/Condition
Conditions

Supported Formats

json

Errors

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

Examples

GET /Condition?patient=1&access_token=Pn4p4dV8wKy5p8awLR9CYQRWdsgNYLRxRef5DdYEDt1smi6jkMbfu2Zmp9q3Svkh
200
{
  "resourceType": "Bundle",
  "id": "e40efc06b315c627ad4dc7aacb0330c3",
  "type": "searchset",
  "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": "inactive",
              "display": "Inactive"
            }
          ]
        },
        "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"
              }
            ]
          }
        ],
        "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",
        "onsetDateTime": "2006-12-30T23:00:00-05:00",
        "abatementDateTime": "2007-06-01T00:00:00-04:00",
        "encounter": {
          "reference": "Encounter/"
        }
      }
    },
    {
      "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"
              }
            ]
          }
        ],
        "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",
        "onsetDateTime": "2016-06-22T00:00:00-04:00",
        "encounter": {
          "reference": "Encounter/"
        }
      }
    },
    {
      "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"
              }
            ]
          }
        ],
        "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",
        "onsetDateTime": "2011-12-30T23:00:00-05:00",
        "encounter": {
          "reference": "Encounter/"
        }
      }
    },
    {
      "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"
              }
            ]
          }
        ],
        "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",
        "onsetDateTime": "2006-12-30T23:00:00-05:00",
        "encounter": {
          "reference": "Encounter/"
        }
      }
    },
    {
      "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"
              }
            ]
          }
        ],
        "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",
        "onsetDateTime": "2011-10-05T00:00:00-04:00",
        "encounter": {
          "reference": "Encounter/"
        }
      }
    }
  ],
  "total": 5
}
GET /Condition?patient=1&access_token=Pn4p4dV8wKy5p8awLR9CYQRWdsgNYLRxRef5DdYEDt1smi6jkMbfu2Zmp9q3Svkh
200
{
  "resourceType": "Bundle",
  "id": "c240fcbabdf2c990a6b99280de91191d",
  "type": "searchset",
  "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": "inactive",
              "display": "Inactive"
            }
          ]
        },
        "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"
              }
            ]
          }
        ],
        "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",
        "onsetDateTime": "2006-12-30T23:00:00-05:00",
        "abatementDateTime": "2007-06-01T00:00:00-04:00",
        "encounter": {
          "reference": "Encounter/"
        }
      }
    },
    {
      "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"
              }
            ]
          }
        ],
        "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",
        "onsetDateTime": "2016-06-22T00:00:00-04:00",
        "encounter": {
          "reference": "Encounter/"
        }
      }
    },
    {
      "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"
              }
            ]
          }
        ],
        "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",
        "onsetDateTime": "2011-12-30T23:00:00-05:00",
        "encounter": {
          "reference": "Encounter/"
        }
      }
    },
    {
      "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"
              }
            ]
          }
        ],
        "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",
        "onsetDateTime": "2006-12-30T23:00:00-05:00",
        "encounter": {
          "reference": "Encounter/"
        }
      }
    },
    {
      "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"
              }
            ]
          }
        ],
        "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",
        "onsetDateTime": "2011-10-05T00:00:00-04:00",
        "encounter": {
          "reference": "Encounter/"
        }
      }
    }
  ],
  "total": 5
}

Params

Param name Description
access_token
optional

CarePaths User OAuth Token

Validations:

  • Must be String.
category
optional

Type of condition (encounter-diagnosis, health-concern, problem-list-item, etc.)

Validations:

  • Must be string.
patient
optional

Patient ID

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/Condition/_search
Conditions by POST

GET /api/Condition/:id
Condition by ID

Supported Formats

json

Errors

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

Examples

GET /Condition/1005
401
GET /Condition/1005?access_token=Pn4p4dV8wKy5p8awLR9CYQRWdsgNYLRxRef5DdYEDt1smi6jkMbfu2Zmp9q3Svkh
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": "inactive",
        "display": "Inactive"
      }
    ]
  },
  "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"
        }
      ]
    }
  ],
  "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",
  "onsetDateTime": "2006-12-30T23:00:00-05:00",
  "abatementDateTime": "2007-06-01T00:00:00-04:00",
  "encounter": {
    "reference": "Encounter/"
  }
}
GET /Condition/1005?access_token=Pn4p4dV8wKy5p8awLR9CYQRWdsgNYLRxRef5DdYEDt1smi6jkMbfu2Zmp9q3Svkh
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": "inactive",
        "display": "Inactive"
      }
    ]
  },
  "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"
        }
      ]
    }
  ],
  "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",
  "onsetDateTime": "2006-12-30T23:00:00-05:00",
  "abatementDateTime": "2007-06-01T00:00:00-04:00",
  "encounter": {
    "reference": "Encounter/"
  }
}
GET /Condition/1005?access_token=Pn4p4dV8wKy5p8awLR9CYQRWdsgNYLRxRef5DdYEDt1smi6jkMbfu2Zmp9q3Svkh
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": "inactive",
        "display": "Inactive"
      }
    ]
  },
  "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"
        }
      ]
    }
  ],
  "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",
  "onsetDateTime": "2006-12-30T23:00:00-05:00",
  "abatementDateTime": "2007-06-01T00:00:00-04:00",
  "encounter": {
    "reference": "Encounter/"
  }
}

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

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

Validations:

  • Must be String.
abatement_date_time
required

Validations:

  • Must be String.
encounter
required

Validations:

  • Must be Hash.