Skip to main content
Read Care Plan
curl --request GET \
  --url https://{tenant_id}.api.nestmed.com/fhir/r4/CarePlan/{id} \
  --header 'Authorization: Bearer <token>'
{
  "resourceType": "CarePlan",
  "status": "draft",
  "intent": "proposal",
  "subject": {
    "reference": "<string>",
    "type": "<string>",
    "identifier": {
      "use": "usual",
      "type": {
        "coding": [
          {
            "system": "<string>",
            "version": "<string>",
            "code": "<string>",
            "display": "<string>",
            "userSelected": true
          }
        ],
        "text": "<string>"
      },
      "system": "<string>",
      "value": "<string>",
      "period": {
        "start": "2023-11-07T05:31:56Z",
        "end": "2023-11-07T05:31:56Z"
      },
      "assigner": "<unknown>"
    },
    "display": "<string>"
  },
  "id": "<string>",
  "meta": {
    "versionId": "<string>",
    "lastUpdated": "2023-11-07T05:31:56Z",
    "source": "<string>",
    "profile": [
      "<string>"
    ],
    "security": [
      {
        "system": "<string>",
        "version": "<string>",
        "code": "<string>",
        "display": "<string>",
        "userSelected": true
      }
    ],
    "tag": [
      {
        "system": "<string>",
        "version": "<string>",
        "code": "<string>",
        "display": "<string>",
        "userSelected": true
      }
    ]
  },
  "text": {
    "status": "generated",
    "div": "<string>"
  },
  "extension": [
    {
      "url": "<string>",
      "valueBoolean": true,
      "valueInteger": 123,
      "valueDecimal": 123,
      "valueString": "<string>",
      "valueUri": "<string>",
      "valueDate": "2023-12-25",
      "valueDateTime": "2023-11-07T05:31:56Z",
      "valueCode": "<string>",
      "valueCoding": {
        "system": "<string>",
        "version": "<string>",
        "code": "<string>",
        "display": "<string>",
        "userSelected": true
      },
      "valueCodeableConcept": {
        "coding": [
          {
            "system": "<string>",
            "version": "<string>",
            "code": "<string>",
            "display": "<string>",
            "userSelected": true
          }
        ],
        "text": "<string>"
      },
      "valueQuantity": {
        "value": 123,
        "comparator": "<",
        "unit": "<string>",
        "system": "<string>",
        "code": "<string>"
      },
      "valuePeriod": {
        "start": "2023-11-07T05:31:56Z",
        "end": "2023-11-07T05:31:56Z"
      },
      "valueReference": {
        "reference": "<string>",
        "type": "<string>",
        "identifier": {
          "use": "usual",
          "type": {
            "coding": [
              {
                "system": "<string>",
                "version": "<string>",
                "code": "<string>",
                "display": "<string>",
                "userSelected": true
              }
            ],
            "text": "<string>"
          },
          "system": "<string>",
          "value": "<string>",
          "period": {
            "start": "2023-11-07T05:31:56Z",
            "end": "2023-11-07T05:31:56Z"
          },
          "assigner": "<unknown>"
        },
        "display": "<string>"
      },
      "valueAttachment": {
        "contentType": "<string>",
        "language": "<string>",
        "data": "aSDinaTvuI8gbWludGxpZnk=",
        "url": "<string>",
        "size": 123,
        "hash": "<string>",
        "title": "<string>",
        "creation": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "identifier": [
    {
      "use": "usual",
      "type": {
        "coding": [
          {
            "system": "<string>",
            "version": "<string>",
            "code": "<string>",
            "display": "<string>",
            "userSelected": true
          }
        ],
        "text": "<string>"
      },
      "system": "<string>",
      "value": "<string>",
      "period": {
        "start": "2023-11-07T05:31:56Z",
        "end": "2023-11-07T05:31:56Z"
      },
      "assigner": "<unknown>"
    }
  ],
  "instantiatesCanonical": [
    "<string>"
  ],
  "instantiatesUri": [
    "<string>"
  ],
  "basedOn": [
    {
      "reference": "<string>",
      "type": "<string>",
      "identifier": {
        "use": "usual",
        "type": {
          "coding": [
            {
              "system": "<string>",
              "version": "<string>",
              "code": "<string>",
              "display": "<string>",
              "userSelected": true
            }
          ],
          "text": "<string>"
        },
        "system": "<string>",
        "value": "<string>",
        "period": {
          "start": "2023-11-07T05:31:56Z",
          "end": "2023-11-07T05:31:56Z"
        },
        "assigner": "<unknown>"
      },
      "display": "<string>"
    }
  ],
  "replaces": [
    {
      "reference": "<string>",
      "type": "<string>",
      "identifier": {
        "use": "usual",
        "type": {
          "coding": [
            {
              "system": "<string>",
              "version": "<string>",
              "code": "<string>",
              "display": "<string>",
              "userSelected": true
            }
          ],
          "text": "<string>"
        },
        "system": "<string>",
        "value": "<string>",
        "period": {
          "start": "2023-11-07T05:31:56Z",
          "end": "2023-11-07T05:31:56Z"
        },
        "assigner": "<unknown>"
      },
      "display": "<string>"
    }
  ],
  "partOf": [
    {
      "reference": "<string>",
      "type": "<string>",
      "identifier": {
        "use": "usual",
        "type": {
          "coding": [
            {
              "system": "<string>",
              "version": "<string>",
              "code": "<string>",
              "display": "<string>",
              "userSelected": true
            }
          ],
          "text": "<string>"
        },
        "system": "<string>",
        "value": "<string>",
        "period": {
          "start": "2023-11-07T05:31:56Z",
          "end": "2023-11-07T05:31:56Z"
        },
        "assigner": "<unknown>"
      },
      "display": "<string>"
    }
  ],
  "category": [
    {
      "coding": [
        {
          "system": "<string>",
          "version": "<string>",
          "code": "<string>",
          "display": "<string>",
          "userSelected": true
        }
      ],
      "text": "<string>"
    }
  ],
  "title": "<string>",
  "description": "<string>",
  "encounter": {
    "reference": "<string>",
    "type": "<string>",
    "identifier": {
      "use": "usual",
      "type": {
        "coding": [
          {
            "system": "<string>",
            "version": "<string>",
            "code": "<string>",
            "display": "<string>",
            "userSelected": true
          }
        ],
        "text": "<string>"
      },
      "system": "<string>",
      "value": "<string>",
      "period": {
        "start": "2023-11-07T05:31:56Z",
        "end": "2023-11-07T05:31:56Z"
      },
      "assigner": "<unknown>"
    },
    "display": "<string>"
  },
  "period": {
    "start": "2023-11-07T05:31:56Z",
    "end": "2023-11-07T05:31:56Z"
  },
  "created": "2023-11-07T05:31:56Z",
  "author": {
    "reference": "<string>",
    "type": "<string>",
    "identifier": {
      "use": "usual",
      "type": {
        "coding": [
          {
            "system": "<string>",
            "version": "<string>",
            "code": "<string>",
            "display": "<string>",
            "userSelected": true
          }
        ],
        "text": "<string>"
      },
      "system": "<string>",
      "value": "<string>",
      "period": {
        "start": "2023-11-07T05:31:56Z",
        "end": "2023-11-07T05:31:56Z"
      },
      "assigner": "<unknown>"
    },
    "display": "<string>"
  },
  "contributor": [
    {
      "reference": "<string>",
      "type": "<string>",
      "identifier": {
        "use": "usual",
        "type": {
          "coding": [
            {
              "system": "<string>",
              "version": "<string>",
              "code": "<string>",
              "display": "<string>",
              "userSelected": true
            }
          ],
          "text": "<string>"
        },
        "system": "<string>",
        "value": "<string>",
        "period": {
          "start": "2023-11-07T05:31:56Z",
          "end": "2023-11-07T05:31:56Z"
        },
        "assigner": "<unknown>"
      },
      "display": "<string>"
    }
  ],
  "careTeam": [
    {
      "reference": "<string>",
      "type": "<string>",
      "identifier": {
        "use": "usual",
        "type": {
          "coding": [
            {
              "system": "<string>",
              "version": "<string>",
              "code": "<string>",
              "display": "<string>",
              "userSelected": true
            }
          ],
          "text": "<string>"
        },
        "system": "<string>",
        "value": "<string>",
        "period": {
          "start": "2023-11-07T05:31:56Z",
          "end": "2023-11-07T05:31:56Z"
        },
        "assigner": "<unknown>"
      },
      "display": "<string>"
    }
  ],
  "addresses": [
    {
      "reference": "<string>",
      "type": "<string>",
      "identifier": {
        "use": "usual",
        "type": {
          "coding": [
            {
              "system": "<string>",
              "version": "<string>",
              "code": "<string>",
              "display": "<string>",
              "userSelected": true
            }
          ],
          "text": "<string>"
        },
        "system": "<string>",
        "value": "<string>",
        "period": {
          "start": "2023-11-07T05:31:56Z",
          "end": "2023-11-07T05:31:56Z"
        },
        "assigner": "<unknown>"
      },
      "display": "<string>"
    }
  ],
  "supportingInfo": [
    {
      "reference": "<string>",
      "type": "<string>",
      "identifier": {
        "use": "usual",
        "type": {
          "coding": [
            {
              "system": "<string>",
              "version": "<string>",
              "code": "<string>",
              "display": "<string>",
              "userSelected": true
            }
          ],
          "text": "<string>"
        },
        "system": "<string>",
        "value": "<string>",
        "period": {
          "start": "2023-11-07T05:31:56Z",
          "end": "2023-11-07T05:31:56Z"
        },
        "assigner": "<unknown>"
      },
      "display": "<string>"
    }
  ],
  "goal": [
    {
      "reference": "<string>",
      "type": "<string>",
      "identifier": {
        "use": "usual",
        "type": {
          "coding": [
            {
              "system": "<string>",
              "version": "<string>",
              "code": "<string>",
              "display": "<string>",
              "userSelected": true
            }
          ],
          "text": "<string>"
        },
        "system": "<string>",
        "value": "<string>",
        "period": {
          "start": "2023-11-07T05:31:56Z",
          "end": "2023-11-07T05:31:56Z"
        },
        "assigner": "<unknown>"
      },
      "display": "<string>"
    }
  ],
  "activity": [
    {
      "outcomeCodeableConcept": [
        {
          "coding": [
            {
              "system": "<string>",
              "version": "<string>",
              "code": "<string>",
              "display": "<string>",
              "userSelected": true
            }
          ],
          "text": "<string>"
        }
      ],
      "outcomeReference": [
        {
          "reference": "<string>",
          "type": "<string>",
          "identifier": {
            "use": "usual",
            "type": {
              "coding": [
                {
                  "system": "<string>",
                  "version": "<string>",
                  "code": "<string>",
                  "display": "<string>",
                  "userSelected": true
                }
              ],
              "text": "<string>"
            },
            "system": "<string>",
            "value": "<string>",
            "period": {
              "start": "2023-11-07T05:31:56Z",
              "end": "2023-11-07T05:31:56Z"
            },
            "assigner": "<unknown>"
          },
          "display": "<string>"
        }
      ],
      "progress": [
        {
          "authorReference": {
            "reference": "<string>",
            "type": "<string>",
            "identifier": {
              "use": "usual",
              "type": {
                "coding": [
                  {
                    "system": "<string>",
                    "version": "<string>",
                    "code": "<string>",
                    "display": "<string>",
                    "userSelected": true
                  }
                ],
                "text": "<string>"
              },
              "system": "<string>",
              "value": "<string>",
              "period": {
                "start": "2023-11-07T05:31:56Z",
                "end": "2023-11-07T05:31:56Z"
              },
              "assigner": "<unknown>"
            },
            "display": "<string>"
          },
          "authorString": "<string>",
          "time": "2023-11-07T05:31:56Z",
          "text": "<string>"
        }
      ],
      "reference": {
        "reference": "<string>",
        "type": "<string>",
        "identifier": {
          "use": "usual",
          "type": {
            "coding": [
              {
                "system": "<string>",
                "version": "<string>",
                "code": "<string>",
                "display": "<string>",
                "userSelected": true
              }
            ],
            "text": "<string>"
          },
          "system": "<string>",
          "value": "<string>",
          "period": {
            "start": "2023-11-07T05:31:56Z",
            "end": "2023-11-07T05:31:56Z"
          },
          "assigner": "<unknown>"
        },
        "display": "<string>"
      },
      "detail": {
        "kind": "<string>",
        "instantiatesCanonical": [
          "<string>"
        ],
        "instantiatesUri": [
          "<string>"
        ],
        "code": {
          "coding": [
            {
              "system": "<string>",
              "version": "<string>",
              "code": "<string>",
              "display": "<string>",
              "userSelected": true
            }
          ],
          "text": "<string>"
        },
        "reasonCode": [
          {
            "coding": [
              {
                "system": "<string>",
                "version": "<string>",
                "code": "<string>",
                "display": "<string>",
                "userSelected": true
              }
            ],
            "text": "<string>"
          }
        ],
        "reasonReference": [
          {
            "reference": "<string>",
            "type": "<string>",
            "identifier": {
              "use": "usual",
              "type": {
                "coding": [
                  {
                    "system": "<string>",
                    "version": "<string>",
                    "code": "<string>",
                    "display": "<string>",
                    "userSelected": true
                  }
                ],
                "text": "<string>"
              },
              "system": "<string>",
              "value": "<string>",
              "period": {
                "start": "2023-11-07T05:31:56Z",
                "end": "2023-11-07T05:31:56Z"
              },
              "assigner": "<unknown>"
            },
            "display": "<string>"
          }
        ],
        "goal": [
          {
            "reference": "<string>",
            "type": "<string>",
            "identifier": {
              "use": "usual",
              "type": {
                "coding": [
                  {
                    "system": "<string>",
                    "version": "<string>",
                    "code": "<string>",
                    "display": "<string>",
                    "userSelected": true
                  }
                ],
                "text": "<string>"
              },
              "system": "<string>",
              "value": "<string>",
              "period": {
                "start": "2023-11-07T05:31:56Z",
                "end": "2023-11-07T05:31:56Z"
              },
              "assigner": "<unknown>"
            },
            "display": "<string>"
          }
        ],
        "status": "not-started",
        "statusReason": {
          "coding": [
            {
              "system": "<string>",
              "version": "<string>",
              "code": "<string>",
              "display": "<string>",
              "userSelected": true
            }
          ],
          "text": "<string>"
        },
        "doNotPerform": true,
        "scheduledTiming": {},
        "scheduledPeriod": {
          "start": "2023-11-07T05:31:56Z",
          "end": "2023-11-07T05:31:56Z"
        },
        "scheduledString": "<string>",
        "location": {
          "reference": "<string>",
          "type": "<string>",
          "identifier": {
            "use": "usual",
            "type": {
              "coding": [
                {
                  "system": "<string>",
                  "version": "<string>",
                  "code": "<string>",
                  "display": "<string>",
                  "userSelected": true
                }
              ],
              "text": "<string>"
            },
            "system": "<string>",
            "value": "<string>",
            "period": {
              "start": "2023-11-07T05:31:56Z",
              "end": "2023-11-07T05:31:56Z"
            },
            "assigner": "<unknown>"
          },
          "display": "<string>"
        },
        "performer": [
          {
            "reference": "<string>",
            "type": "<string>",
            "identifier": {
              "use": "usual",
              "type": {
                "coding": [
                  {
                    "system": "<string>",
                    "version": "<string>",
                    "code": "<string>",
                    "display": "<string>",
                    "userSelected": true
                  }
                ],
                "text": "<string>"
              },
              "system": "<string>",
              "value": "<string>",
              "period": {
                "start": "2023-11-07T05:31:56Z",
                "end": "2023-11-07T05:31:56Z"
              },
              "assigner": "<unknown>"
            },
            "display": "<string>"
          }
        ],
        "productCodeableConcept": {
          "coding": [
            {
              "system": "<string>",
              "version": "<string>",
              "code": "<string>",
              "display": "<string>",
              "userSelected": true
            }
          ],
          "text": "<string>"
        },
        "productReference": {
          "reference": "<string>",
          "type": "<string>",
          "identifier": {
            "use": "usual",
            "type": {
              "coding": [
                {
                  "system": "<string>",
                  "version": "<string>",
                  "code": "<string>",
                  "display": "<string>",
                  "userSelected": true
                }
              ],
              "text": "<string>"
            },
            "system": "<string>",
            "value": "<string>",
            "period": {
              "start": "2023-11-07T05:31:56Z",
              "end": "2023-11-07T05:31:56Z"
            },
            "assigner": "<unknown>"
          },
          "display": "<string>"
        },
        "dailyAmount": {
          "value": 123,
          "comparator": "<",
          "unit": "<string>",
          "system": "<string>",
          "code": "<string>"
        },
        "quantity": {
          "value": 123,
          "comparator": "<",
          "unit": "<string>",
          "system": "<string>",
          "code": "<string>"
        },
        "description": "<string>"
      }
    }
  ],
  "note": [
    {
      "authorReference": {
        "reference": "<string>",
        "type": "<string>",
        "identifier": {
          "use": "usual",
          "type": {
            "coding": [
              {
                "system": "<string>",
                "version": "<string>",
                "code": "<string>",
                "display": "<string>",
                "userSelected": true
              }
            ],
            "text": "<string>"
          },
          "system": "<string>",
          "value": "<string>",
          "period": {
            "start": "2023-11-07T05:31:56Z",
            "end": "2023-11-07T05:31:56Z"
          },
          "assigner": "<unknown>"
        },
        "display": "<string>"
      },
      "authorString": "<string>",
      "time": "2023-11-07T05:31:56Z",
      "text": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

id
string
required

Response

CarePlan resource

resourceType
enum<string>
required
Available options:
CarePlan
status
enum<string>
required
Available options:
draft,
active,
on-hold,
revoked,
completed,
entered-in-error,
unknown
intent
enum<string>
required
Available options:
proposal,
plan,
order,
option
subject
object
required
id
string
meta
object
text
object
extension
object[]
identifier
object[]
instantiatesCanonical
string[]
instantiatesUri
string[]
basedOn
object[]
replaces
object[]
partOf
object[]
category
object[]
title
string
description
string
encounter
object
period
object
created
string<date-time>
author
object
contributor
object[]
careTeam
object[]
addresses
object[]
supportingInfo
object[]
goal
object[]
activity
object[]
note
object[]