General Information
The connectivity of this FHIR endpoint is as follows:
- HTTP Method
- GET, POST
- URL Template
- https://portal.viewmymed.com/fhir/Goal?_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
- Scopes Supported
-
- patient/Goal
- user/Goal
- system/Goal
- system/*.read
- system/*.rs
- Profiles Supported
-
- Us Core Goal
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 Goal 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 goal. 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 goal at a specific time. Alternately it may be provided twice with 'le' and 'gt' prefixes to search for goal 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 |
|
| subject (Reference) |
Reference to a patient resource for whom the report is relevant |
|
| lifecycleStatus (String) |
Status of current Goal |
|
| description.coding (CodeableConcept) |
Codified per-site compendium of description in standard SNOMED codes. SNOMED CT (http://snomed.info/sct) |
|
| target (Date) |
Target date of goal, generally 1 year. |
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/Goal?_id=20c02e2d19773fbb8219111f6023da03
HTTP/1.0 200 OK
Cache-Control: no-cache, private
Content-Type: application/fhir+json
Date: Mon, 02 Feb 2026 13:40:14 GMT
Etag: W/"1"
{
"resourceType": "Goal",
"id": "20c02e2d19773fbb8219111f6023da03",
"meta": {
"versionId": "20c02e2d19773fbb8219111f6023da03",
"lastUpdated": "2023-01-06T11:03:51+00:00"
},
"subject": {
"reference": "Patient/99997.122753-00"
},
"lifecycleStatus": "active",
"description": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "840539006"
}
],
"text": "Date: 01/02/23 Type: Goal Description: Test Goal 3/1/23 Status: Snomed Code: 840539006"
},
"target": [
{
"dueDate": "2023-03-01"
}
]
}
Error Codes / Outcomes
All endpoints share the same error codes and common outcomes.