General Information
The connectivity of this FHIR endpoint is as follows:
- HTTP Method
- GET, POST
- URL Template
- https://portal.viewmymed.com/fhir/CarePlan?_id=token&
_count=number& date=date& _pretty=boolean - Supported OAuth 2.0 User Types
- Backend Systems, Clinicians or Administrative Users, Patients
- Operations Supported
- read search-type vread history-instance
- Profiles Supported
-
- Us Core Careplan
Request Parameters
The following fields and datatypes are the parameters for the request string. All fields are optional, however if no settings are set, all values will be exported up to the maximum count of 100
| Name (type) | Description (bindings) |
|---|---|
| _id (token) |
A single or comma separated list of CarePlan ids. It is a required field if the patient field is not given. |
| _count (number) |
The maximum number of results to return in a page. Not honored when '_id' is set. |
| date (date) |
A date or date range from which to find careplan. The 'date' parameter may be provided once without a prefix or time component to imply a date range or once without a prefix and with a time component to search for careplan at a specific time. Alternately it may be provided twice with 'le' and 'gt' prefixes to search for careplan within a specific range. The date prefix pair must create a closed range. |
| _pretty (boolean) |
set to false to disable formatted output. |
Returned Data Fields
The following fields and bindings are returned if valued
| Field (type) | Description (bindings) | Opt? |
|---|---|---|
| id (Id) |
Id |
|
| status (CodeableConcept) |
The status of the care path (active, completed or unknown). Request Status (https://hl7.org/fhir/request-status) |
|
| intent (CodeableConcept) |
Is the care plan listed as planned or ordered Request Status (https://hl7.org/fhir/R4/codesystem-request-intent.html) |
|
| category (CodeableConcept) |
listed as assess-plan for first code, discrete snomed code Request Category (https://hl7.org/fhir/us/core/CodeSystem/careplan-category) SNOMED CT (http://snomed.info/sct) |
|
| subject (Reference) |
Reference to a patient resource for whom the care plan is relevant |
|
| encounter (Reference) |
Reference to a patient encounter for whom the care plan is relevant |
|
| created (DateTime) |
Date care plan entered |
|
| author (Reference) |
Reference to Provider whom entered data on the encounter. |
Default Patient Query
The following are live queries representative of a data request on our sandbox environment.
Headers
Accept: application/fhir+json Authorization: <OAuth2 Bearer Token>
Request
GET https://portal.viewmymed.com/fhir/CarePlan?_id=093e7a65a3144369f43986ddbbf639f9
HTTP/1.0 200 OK
Cache-Control: no-cache, private
Content-Type: application/fhir+json
Date: Mon, 02 Feb 2026 13:36:07 GMT
Etag: W/"1"
{
"resourceType": "CarePlan",
"id": "093e7a65a3144369f43986ddbbf639f9",
"meta": {
"versionId": "093e7a65a3144369f43986ddbbf639f9",
"lastUpdated": "2023-01-06T11:03:51+00:00"
},
"subject": {
"reference": "Patient/99997.122753-00"
},
"encounter": {
"reference": "Encounter/a141182b7801eea66aa0f6c15d2a0708"
},
"text": {
"status": "generated",
"div": "Date: 12/21/22
\nType: Instruction
\nDescription: Heat. Sitz baths. Keep stools soft - do not strain. If you have to go, go. Recheck 5 d if not significantly better, sooner if worse.
\nStatus:
\n"
},
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
"code": "assess-plan"
},
{
"system": "http://snomed.info/sct",
"code": "736241001",
"display": "Pediatric outpatient care plan"
}
],
"text": "Pediatric outpatient care plan"
}
],
"title": "Instruction",
"description": "Heat. Sitz baths. Keep stools soft - do not strain. If you have to go, go. Recheck 5 d if not significantly better, sooner if worse.",
"created": "2022-12-21T00:00:00+00:00",
"status": "unknown",
"intent": "plan",
"author": {
"reference": "Practitioner/6d06a711a40230653f65ac42bdd4f97a",
"display": "Fenderson, Howard"
}
}
Error Codes / Outcomes
All endpoints share the same error codes and common outcomes.