HiMS API Documentation

The CareTeam includes all the people, teams, and organizations who plan to participate in the coordination and delivery of care for a single patient or a group. CareTeam can also be organizationally assigned without a subject in context, such as a code blue team or emergency response team. This is not limited to practitioners, but may include other caregivers such as family members, guardians, the patient themself, or others. The Care Team, depending on where used, may include care team members specific to a particular care plan, an episode, an encounter, or may reflect all known team members across these perspectives. An individual's CareTeam can be dynamic over time, such that there can be transience of team members, such as a rehabilitation team.

The CareTeam resource returns data classes and elements defined for Care Team Members in United States Core Data for Interoperability (USCDI v2) such as Care Team Member Name, Care Team Member Identifier, Care Team Member Role, Care Team Member Location, Care Team Member Telecom. Example requests for patient data are shown below:

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

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

Find Care Teams using a patient ID and status of the care team

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

Examples:
GET https://fhir-api.hmsfirst.com/r4/CareTeam?patient=29355&status=active
                    

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"
                    }
                  }
                }
              },
              "status": {
                "type": "string"
              },
              "subject": {
                "type": "object",
                "required": [],
                "properties": {
                  "reference": {
                    "type": "string"
                  }
                }
              },
              "period": {
                "type": "object",
                "required": [],
                "properties": {
                  "start": {
                    "type": "string"
                  }
                }
              },
              "participant": {
                "type": "array",
                "items": {
                  "type": "object",
                  "required": [],
                  "properties": {
                    "role": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "required": [],
                        "properties": {
                          "coding": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "required": [],
                              "properties": {
                                "system": {
                                  "type": "string"
                                },
                                "code": {
                                  "type": "string"
                                },
                                "display": {
                                  "type": "string"
                                }
                              }
                            }
                          },
                          "text": {
                            "type": "string"
                          }
                        }
                      }
                    },
                    "member": {
                      "type": "object",
                      "required": [],
                      "properties": {
                        "reference": {
                          "type": "string"
                        },
                        "display": {
                          "type": "string"
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}