MaxIntegration V1.0 Documentation CCDS Support - Goals

Goals

In FHIR STU3 standard, Goal resource describes the intended objective(s) for a patient, group or organization care, for example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.

Goal is generally an expressed desired health state to be achieved by a subject of care (or family/group) over a period or at a specific point of time. This desired target health state may be achieved as a result of health care intervention(s) or resulting from natural recovery over time. This resource is adapted to represent the CCDS element, goals.

Required or some important fields and parameters would be given in the following tables. Operations and parameters of this resource would also be listed.

Resource Element Fields

Name Description Type
identifier External Ids for this goal Identifier
status The status code code (GoalStatus)
category The category of the goal CodeableConcept (GoalCategory)
priority The priority of the goal CodeableConcept (GoalPriority)
description Code or text describing goal CodeableConcept (SNOMED CT Clinical Findings)
subject Who this goal is intended for References (Patient | Group | Organization)
start When goal pursuit begins GoalStartEvent:
startDate: date
startCodeableConcept: CodeableConcept
target Target outcome for the goal BackboneElement
statusDate When goal status took effect date
statusReason Reason for current status string

Get Goals by Patient

GET https://evalfhir.directmdemail.com/fhir/baseDstu3/Goal?patient={id}

Example:

GET https://evalfhir.directmdemail.com/fhir/baseDstu3/Goal?patient=726
                {
    "resourceType": "Bundle",
    "id": "2a3891e6-d111-454b-8eac-9793aa0925e3",
    "meta": {
        "lastUpdated": "2017-12-26T14:03:19.882-06:00"
    },
    "type": "searchset",
    "total": 2,
    "link": [
        {
            "relation": "self",
            "url": "https://evalfhir.directmdemail.com/fhir/baseDstu3/Goal?patient=726"
        }
    ],
    "entry": [
        {
            "fullUrl": "https://evalfhir.directmdemail.com/fhir/baseDstu3/Goal/787",
            "resource": {
                "resourceType": "Goal",
                "id": "787",
                "meta": {
                    "versionId": "1",
                    "lastUpdated": "2017-12-26T09:21:57.000-06:00"
                },
                "text": {
                    "status": "additional",
                    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Need to gain more energy to do regular activities.</div>"
                },
                "subject": {
                    "reference": "Patient/726"
                }
            },
            "search": {
                "mode": "match"
            }
        },
        {
            "fullUrl": "https://evalfhir.directmdemail.com/fhir/baseDstu3/Goal/786",
            "resource": {
                "resourceType": "Goal",
                "id": "786",
                "meta": {
                    "versionId": "1",
                    "lastUpdated": "2017-12-26T09:21:57.000-06:00"
                },
                "text": {
                    "status": "additional",
                    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Get rid of intermittent fever that is occurring every few weeks.</div>"
                },
                "subject": {
                    "reference": "Patient/726"
                }
            },
            "search": {
                "mode": "match"
            }
        }
    ]
}
                
    

For this resource, users are able to search using parameters like start-date, patient, and target-date etc. Important searching parameters would be listed in the following table.

Parameter Name Description Type Required
_id The Id of the certain resource string False
identifier The unique identifier for this goal string False
start-date The start date of the goal dateTime False
target-date The target date for the goal to reach on or before dateTime False
patient The Id representing the specific patient related with this resource integer True (If the query is concerning a specific patient)
subject The Id for the corresponding subject integer True (If the query is concerning a specific patient)

Search Goals With Specific Date

This following request format indicates how to get goals on a specific date, using parameter date.

GET https://evalfhir.directmdemail.com/fhir/baseDstu3//Goal?patient={id}&start-date=>={dateTime}&start-date=<={dateTime}

Example:

GET https://evalfhir.directmdemail.com/fhir/baseDstu3//Goal?patient=56&start-date=>=2015-06-22&start-date=<=2015-06-22
        {
    "resourceType": "Bundle",
    "id": "396fbb3e-99e3-45f5-9649-8d07fd1b2000",
    "meta": {
        "lastUpdated": "2018-02-14T18:05:58.869-06:00"
    },
    "type": "searchset",
    "total": 2,
    "link": [
        {
            "relation": "self",
            "url": "https://evalfhir.directmdemail.com/fhir/baseDstu3//Goal?patient=56&start-date=%3E%3D2015-06-22&start-date=%3C%3D2015-06-22"
        }
    ],
    "entry": [
        {
            "fullUrl": "https://evalfhir.directmdemail.com/fhir/baseDstu3//Goal/117",
            "resource": {
                "resourceType": "Goal",
                "id": "117",
                "meta": {
                    "versionId": "1",
                    "lastUpdated": "2018-02-14T17:15:14.000-06:00"
                },
                "text": {
                    "status": "additional",
                    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Need to gain more energy to do regular activities.</div>"
                },
                "subject": {
                    "reference": "Patient/56",
                    "display": "Alice Jones Newman"
                },
                "startDate": "2015-06-22"
            },
            "search": {
                "mode": "match"
            }
        },
        {
            "fullUrl": "https://evalfhir.directmdemail.com/fhir/baseDstu3//Goal/116",
            "resource": {
                "resourceType": "Goal",
                "id": "116",
                "meta": {
                    "versionId": "1",
                    "lastUpdated": "2018-02-14T17:15:14.000-06:00"
                },
                "text": {
                    "status": "additional",
                    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Get rid of intermittent fever that is occurring every few weeks.</div>"
                },
                "subject": {
                    "reference": "Patient/56",
                    "display": "Alice Jones Newman"
                },
                "startDate": "2015-06-22"
            },
            "search": {
                "mode": "match"
            }
        }
    ]
}
        
    

Search Goals With a Date Range

The request format would be like:

GET https://evalfhir.directmdemail.com/fhir/baseDstu3//Goal?patient={id}&start-date=>={dateTime}&start-date=<{dateTime (later than previous dateTIme)}

Example:

GET https://evalfhir.directmdemail.com/fhir/baseDstu3//Goal?patient=56&start-date=>=2015-06-20&start-date=<=2015-07-22
        {
    "resourceType": "Bundle",
    "id": "fb013153-6649-4d25-84c1-8fa841d63528",
    "meta": {
        "lastUpdated": "2018-02-14T18:12:43.003-06:00"
    },
    "type": "searchset",
    "total": 2,
    "link": [
        {
            "relation": "self",
            "url": "https://evalfhir.directmdemail.com/fhir/baseDstu3//Goal?patient=56&start-date=%3E%3D2015-06-20&start-date=%3C%3D2015-07-22"
        }
    ],
    "entry": [
        {
            "fullUrl": "https://evalfhir.directmdemail.com/fhir/baseDstu3//Goal/117",
            "resource": {
                "resourceType": "Goal",
                "id": "117",
                "meta": {
                    "versionId": "1",
                    "lastUpdated": "2018-02-14T17:15:14.000-06:00"
                },
                "text": {
                    "status": "additional",
                    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Need to gain more energy to do regular activities.</div>"
                },
                "subject": {
                    "reference": "Patient/56",
                    "display": "Alice Jones Newman"
                },
                "startDate": "2015-06-22"
            },
            "search": {
                "mode": "match"
            }
        },
        {
            "fullUrl": "https://evalfhir.directmdemail.com/fhir/baseDstu3//Goal/116",
            "resource": {
                "resourceType": "Goal",
                "id": "116",
                "meta": {
                    "versionId": "1",
                    "lastUpdated": "2018-02-14T17:15:14.000-06:00"
                },
                "text": {
                    "status": "additional",
                    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Get rid of intermittent fever that is occurring every few weeks.</div>"
                },
                "subject": {
                    "reference": "Patient/56",
                    "display": "Alice Jones Newman"
                },
                "startDate": "2015-06-22"
            },
            "search": {
                "mode": "match"
            }
        }
    ]
}