goals

post
/organizations/{organizationId}/fhir/3/goal

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.

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

Params

organizationId*string|stringid|slug

Body

resourceType*stringGoalThis is a Goal resource
identifierarray(Identifier)This records identifiers associated with this care plan that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
statusstringproposed|accepted|planned|in-progress|on-target|ahead-of-target|behind-target|sustaining|achieved|on-hold|cancelled|entered-in-error|rejectedIndicates whether the goal has been reached and is still considered relevant.
categoryarray(CodeableConcept)Indicates a category the goal falls within.
priorityCodeableConceptIdentifies the mutually agreed level of importance associated with reaching/sustaining the goal.
description*CodeableConceptHuman-readable and/or coded description of a specific desired objective of care, such as "control blood pressure" or "negotiate an obstacle course" or "dance with child at wedding".
subjectReferenceIdentifies the patient, group or organization for whom the goal is being established.
startDatestringThe date or event after which the goal should begin being pursued.
startCodeableConceptCodeableConceptThe date or event after which the goal should begin being pursued.
targetGoal_TargetIndicates what should be done by when.
statusDatestringIdentifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.
statusReasonstringCaptures the reason for the current status.
expressedByReferenceIndicates whose goal this is - patient goal, practitioner goal, etc.
addressesarray(Reference)The identified conditions and other health record elements that are intended to be addressed by the goal.
notearray(Annotation)Any comments related to the goal.
outcomeCodearray(CodeableConcept)Identifies the change (or lack of change) at the point when the status of the goal is assessed.
outcomeReferencearray(Reference)Details of what's changed (or not changed).

Response

patch
/organizations/{organizationId}/fhir/3/goal/{resourceId}

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.

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringGoalThis is a Goal resource
identifierarray(Identifier)This records identifiers associated with this care plan that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
statusstringproposed|accepted|planned|in-progress|on-target|ahead-of-target|behind-target|sustaining|achieved|on-hold|cancelled|entered-in-error|rejectedIndicates whether the goal has been reached and is still considered relevant.
categoryarray(CodeableConcept)Indicates a category the goal falls within.
priorityCodeableConceptIdentifies the mutually agreed level of importance associated with reaching/sustaining the goal.
description*CodeableConceptHuman-readable and/or coded description of a specific desired objective of care, such as "control blood pressure" or "negotiate an obstacle course" or "dance with child at wedding".
subjectReferenceIdentifies the patient, group or organization for whom the goal is being established.
startDatestringThe date or event after which the goal should begin being pursued.
startCodeableConceptCodeableConceptThe date or event after which the goal should begin being pursued.
targetGoal_TargetIndicates what should be done by when.
statusDatestringIdentifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.
statusReasonstringCaptures the reason for the current status.
expressedByReferenceIndicates whose goal this is - patient goal, practitioner goal, etc.
addressesarray(Reference)The identified conditions and other health record elements that are intended to be addressed by the goal.
notearray(Annotation)Any comments related to the goal.
outcomeCodearray(CodeableConcept)Identifies the change (or lack of change) at the point when the status of the goal is assessed.
outcomeReferencearray(Reference)Details of what's changed (or not changed).

Response

get
/organizations/{organizationId}/fhir/3/goal/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

Params

organizationId*string|stringid|slug
resourceId*

Response

get
/organizations/{organizationId}/fhir/3/goal/{resourceId}/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

get
/organizations/{organizationId}/fhir/3/goal/{resourceId}/_history/{versionId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

delete
/organizations/{organizationId}/fhir/3/goal/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

Params

organizationId*string|stringid|slug
resourceId*

Response

get
/organizations/{organizationId}/fhir/3/goal

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
addressesstring
categorystring
identifierstring
patientstring
start-datestring
statusstring
subjectstring
target-datestring

Params

organizationId*string|stringid|slug

Response

get
/organizations/{organizationId}/fhir/3/goal/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

post
/organizations/{organizationId}/fhir/3/goal/_search

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.

Request

Headers

content-type*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
addressesstring
categorystring
identifierstring
patientstring
start-datestring
statusstring
subjectstring
target-datestring

Params

organizationId*string|stringid|slug

Body

resourceType*stringGoalThis is a Goal resource
identifierarray(Identifier)This records identifiers associated with this care plan that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
statusstringproposed|accepted|planned|in-progress|on-target|ahead-of-target|behind-target|sustaining|achieved|on-hold|cancelled|entered-in-error|rejectedIndicates whether the goal has been reached and is still considered relevant.
categoryarray(CodeableConcept)Indicates a category the goal falls within.
priorityCodeableConceptIdentifies the mutually agreed level of importance associated with reaching/sustaining the goal.
description*CodeableConceptHuman-readable and/or coded description of a specific desired objective of care, such as "control blood pressure" or "negotiate an obstacle course" or "dance with child at wedding".
subjectReferenceIdentifies the patient, group or organization for whom the goal is being established.
startDatestringThe date or event after which the goal should begin being pursued.
startCodeableConceptCodeableConceptThe date or event after which the goal should begin being pursued.
targetGoal_TargetIndicates what should be done by when.
statusDatestringIdentifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.
statusReasonstringCaptures the reason for the current status.
expressedByReferenceIndicates whose goal this is - patient goal, practitioner goal, etc.
addressesarray(Reference)The identified conditions and other health record elements that are intended to be addressed by the goal.
notearray(Annotation)Any comments related to the goal.
outcomeCodearray(CodeableConcept)Identifies the change (or lack of change) at the point when the status of the goal is assessed.
outcomeReferencearray(Reference)Details of what's changed (or not changed).

Response

put
/organizations/{organizationId}/fhir/3/goal/{resourceId}

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.

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringGoalThis is a Goal resource
identifierarray(Identifier)This records identifiers associated with this care plan that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
statusstringproposed|accepted|planned|in-progress|on-target|ahead-of-target|behind-target|sustaining|achieved|on-hold|cancelled|entered-in-error|rejectedIndicates whether the goal has been reached and is still considered relevant.
categoryarray(CodeableConcept)Indicates a category the goal falls within.
priorityCodeableConceptIdentifies the mutually agreed level of importance associated with reaching/sustaining the goal.
description*CodeableConceptHuman-readable and/or coded description of a specific desired objective of care, such as "control blood pressure" or "negotiate an obstacle course" or "dance with child at wedding".
subjectReferenceIdentifies the patient, group or organization for whom the goal is being established.
startDatestringThe date or event after which the goal should begin being pursued.
startCodeableConceptCodeableConceptThe date or event after which the goal should begin being pursued.
targetGoal_TargetIndicates what should be done by when.
statusDatestringIdentifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.
statusReasonstringCaptures the reason for the current status.
expressedByReferenceIndicates whose goal this is - patient goal, practitioner goal, etc.
addressesarray(Reference)The identified conditions and other health record elements that are intended to be addressed by the goal.
notearray(Annotation)Any comments related to the goal.
outcomeCodearray(CodeableConcept)Identifies the change (or lack of change) at the point when the status of the goal is assessed.
outcomeReferencearray(Reference)Details of what's changed (or not changed).

Response