Care Management

GET Retrieve care plan records

GET /CarePlan

Retrieves a set of resources by using filters.

Parameters

• category (query, string, required) Specifies the type of the care plan.
• patient (query, string, required) Specifies the patient for whom the care plan is for.
• X-CORRELATION-ID (header, string)
• Accept (header, string)
  Allowed values: */*, application/fhir+json.

Responses

• 200

  Media type: application/fhir+json. Schema: CarePlanBundle.

  Contains a collection of resources

  • Rule: total only when a search or history
  • Rule: entry.search only when a search
  • Rule: entry.request mandatory for batch/transaction/history, otherwise prohibited
  • Rule: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited
  • Rule: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
  • Rule: A document must have an identifier with a system and a value
  • Rule: A document must have a date
  • Rule: A document must have a Composition as the first resource
  • Rule: A message must have a MessageHeader as the first resource Elements defined in Ancestors: id, meta, implicitRules, language

  Example

  {
      "resourceType": "Bundle",
      "id": "bba1eb2e-2c47-460f-ade2-6ca8a55741a5",
      "meta": {
          "lastUpdated": "2023-05-04T17:56:44.628+05:30"
      },
      "type": "searchset",
      "total": 1,
      "link": [
          {
              "relation": "self",
              "url": "https://localhost:8092/care-management/fhir-r4/v1/CarePlan?patient=001RO000004bNW6YAM&category=assess-plan"
          }
      ],
      "entry": [
          {
              "fullUrl": "https://localhost:8092/care-management/fhir-r4/v1/CarePlan/1spRO00000000i7YAA",
              "search": {
                  "mode": "match"
              },
              "resource": {
                  "resourceType": "CarePlan",
                  "id": "1spRO00000000i7YAA",
                  "identifier": [
                      {
                          "use": "usual",
                          "value": "12000723457689870",
                          "system": "urn:custom:sourcesystem:fhirid"
                      }
                  ],
                  "basedOn": [
                      {
                          "reference": "CarePlan/1spRO00000000b0YAA"
                      }
                  ],
                  "replaces": [
                      {
                          "reference": "CarePlan/1spRO00000000b0YAA"
                      }
                  ],
                  "partOf": [
                      {
                          "reference": "CarePlan/1spRO00000000b0YAA"
                      }
                  ],
                  "status": "active",
                  "intent": "proposal",
                  "category": [
                      {
                          "id": "1kpCO00000000i7YWA",
                          "coding": [
                              {
                                  "system": "urn:uuid:53fefa32-fcbb-4ff8-8a92-55ee120877b7",
                                  "version": "v1",
                                  "code": "assess-plan",
                                  "display": "assess-plan"
                              }
                          ]
                      }
                  ],
                  "title": "Title of CarePlan",
                  "description": "description of CarePlan",
                  "subject": {
                      "reference": "Patient/001RO000004bNW6YAM"
                  },
                  "encounter": {
                      "reference": "Encounter/0kGRO00000001FY2AY"
                  },
                  "period": {
                      "start": "2023-05-04T06:23:57.000Z",
                      "end": "2010-05-16T00:00:00.000Z"
                  },
                  "created": "2001-05-06T00:00:00.000Z",
                  "author": {
                      "reference": "Patient/001RO000004bNW6YAM"
                  },
                  "contributor": [
                      {
                          "reference": "Practitioner/0cmRO00000002nQYAQ"
                      }
                  ],
                  "addresses": [
                      {
                          "reference": "Condition/0j4RO00000000BFYAY"
                      }
                  ],
                  "supportingInfo": [
                      {
                          "reference": "CarePlan/1spRO00000000b0YAA"
                      }
                  ],
                  "activity": [
                      {
                          "id": "1kpCO00000000i7YWA",
                          "outcomeCodeableConcept": [
                              {
                                  "coding": [
                                      {
                                          "code": "418914006molerclea",
                                          "system": "http://snomed.info/sct",
                                          "display": "Warning. May cause drowsiness. If affected, don't drive or operate machinery. Avoid any alcoholic drink (qualifier value)."
                                      }
                                  ],
                                  "text": "test text"
                              }
                          ],
                          "outcomeReference": [
                              {
                                  "reference": "Patient/001RO000004bNW6YAM"
                              }
                          ],
                          "progress": [
                              {
                                  "text": "test text"
                              }
                          ],
                          "reference": {
                              "reference": "MedicationRequest/0kmRO00000001Z3YAI"
                          },
                          "detail": {
                              "kind": "Appointment",
                              "code": {
                                  "coding": [
                                      {
                                          "code": "4189134",
                                          "system": "http://snomed.info/sct",
                                          "display": "Warning. May cause drowsiness."
                                      }
                                  ],
                                  "text": "test text"
                              },
                              "reasonReference": [
                                  {
                                      "reference": "Observation/0hIRO00000005b12AA"
                                  }
                              ],
                              "status": "not-started",
                              "statusReason": {
                                  "coding": [
                                      {
                                          "code": "hud",
                                          "system": "http://snomed.info/sct",
                                          "display": "Warning. May cause drowsiness. If affected, don't drive or operate machinery. Avoid any alcoholic drink (qualifier value)."
                                      }
                                  ],
                                  "text": "test text"
                              },
                              "doNotPerform": false,
                              "location": {
                                  "reference": "Location/0klRO000000000uYAA",
                                  "display": "Location"
                              },
                              "performer": [
                                  {
                                      "reference": "PractitionerRole/0bSRO00000001hb2AA"
                                  }
                              ],
                              "productCodeableConcept": {
                                  "coding": [
                                      {
                                          "code": "4189140063orjn",
                                          "system": "http://snomed.info/sct",
                                          "display": "Warning. May cause drowsiness. If affected, don't drive or operate machinery. Avoid any alcoholic drink (qualifier value)."
                                      }
                                  ],
                                  "text": "test text"
                              },
                              "dailyAmount": {
                                  "value": 30.0,
                                  "unit": "TAB",
                                  "code": "TAB"
                              },
                              "quantity": {
                                  "value": 30.0,
                                  "unit": "TAB",
                                  "code": "TAB"
                              },
                              "description": "test description"
                          }
                      }
                  ]
              }
          }
      ]
  }

• 500 Server encountered an error while processing the request.

  Media type: application/fhir+json. Schema: OperationOutcome.

  Example

  {
      "resourceType": "OperationOutcome",
      "issue": [
          {
              "severity": "error",
              "code": "code-invalid",
              "details": {
                  "text": "Details not found."
              }
          }
      ]
  }

• 503 Error connecting Salesforce.

  Media type: application/fhir+json. Schema: OperationOutcome.

  Example: same as GET /CarePlan 500 response.