HiMS API Documentation

The CarePlan resource describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions.

The CarePlan resource returns data classes and elements defined for Assessment and Plan of Treatment in United States Core Data for Interoperability (USCDI v2). It also returns data classes and elements defined for SDOH Assessment:

• Observation Survey
• Observation SDOH Assessment
• Observation Social History
• QuestionnaireResponse

Examples of API requests to retrieve device data are shown below:

Get Care Plans related to a specific patient

curl --request GET \
--url 'https://fhir-api.hmsfirst.com/r4/CarePlan?patient={patientId}' \
--header 'Accept: application/fhir+json' \
--header 'Authorization: Bearer ACCESS_TOKEN'

Examples:
GET https://fhir-api.hmsfirst.com/r4/CarePlan?patient=29355
                    

Find Care Plans using a patient ID and category

curl --request GET \
--url 'https://fhir-api.hmsfirst.com/r4/CarePlan?patient={patientId}&category={category}' \
--header 'Accept: application/fhir+json' \
--header 'Authorization: Bearer ACCESS_TOKEN'

Examples:
GET https://fhir-api.hmsfirst.com/r4/CarePlan?patient=29355&category=?category=http://hl7.org/fhir/us/core/CodeSystem/careplan-category|assess-plan
                    

Response schema

{
  "type": "object",
  "required": [],
  "properties": {
    "resourceType": {
      "type": "string"
    },
    "id": {
      "type": "string"
    },
    "type": {
      "type": "string"
    },
    "total": {
      "type": "number"
    },
    "link": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [],
        "properties": {
          "relation": {
            "type": "string"
          },
          "url": {
            "type": "string"
          }
        }
      }
    },
    "entry": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [],
        "properties": {
          "fullUrl": {
            "type": "string"
          },
          "resource": {
            "type": "object",
            "required": [],
            "properties": {
              "resourceType": {
                "type": "string"
              },
              "id": {
                "type": "string"
              },
              "meta": {
                "type": "object",
                "required": [],
                "properties": {
                  "versionId": {
                    "type": "string"
                  },
                  "lastUpdated": {
                    "type": "string"
                  },
                  "profile": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  }
                }
              },
              "text": {
                "type": "object",
                "required": [],
                "properties": {
                  "status": {
                    "type": "string"
                  },
                  "div": {
                    "type": "string"
                  }
                }
              },
              "status": {
                "type": "string"
              },
              "intent": {
                "type": "string"
              },
              "category": {
                "type": "array",
                "items": {
                  "type": "object",
                  "required": [],
                  "properties": {
                    "coding": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "required": [],
                        "properties": {
                          "system": {
                            "type": "string"
                          },
                          "code": {
                            "type": "string"
                          }
                        }
                      }
                    },
                    "text": {
                      "type": "string"
                    }
                  }
                }
              },
              "subject": {
                "type": "object",
                "required": [],
                "properties": {
                  "reference": {
                    "type": "string"
                  }
                }
              },
              "encounter": {
                "type": "object",
                "required": [],
                "properties": {
                  "reference": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}