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*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params

Params


organizationId*	string\|string		id\|slug

Body


resourceType*	string	Goal	This is a Goal resource
identifier	array(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).
status	string	proposed\|accepted\|planned\|in-progress\|on-target\|ahead-of-target\|behind-target\|sustaining\|achieved\|on-hold\|cancelled\|entered-in-error\|rejected	Indicates whether the goal has been reached and is still considered relevant.
category	array(CodeableConcept)		Indicates a category the goal falls within.
priority	CodeableConcept		Identifies the mutually agreed level of importance associated with reaching/sustaining the goal.
description*	CodeableConcept		Human-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".
subject	Reference		Identifies the patient, group or organization for whom the goal is being established.
startDate	string		The date or event after which the goal should begin being pursued.
startCodeableConcept	CodeableConcept		The date or event after which the goal should begin being pursued.
target	Goal_Target		Indicates what should be done by when.
statusDate	string		Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.
statusReason	string		Captures the reason for the current status.
expressedBy	Reference		Indicates whose goal this is - patient goal, practitioner goal, etc.
addresses	array(Reference)		The identified conditions and other health record elements that are intended to be addressed by the goal.
note	array(Annotation)		Any comments related to the goal.
outcomeCode	array(CodeableConcept)		Identifies the change (or lack of change) at the point when the status of the goal is assessed.
outcomeReference	array(Reference)		Details of what's changed (or not changed).

Response

200 400 401 404

patch

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

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params

Params


organizationId*	string\|string		id\|slug
resourceId*

Body


resourceType*	string	Goal	This is a Goal resource
identifier	array(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).
status	string	proposed\|accepted\|planned\|in-progress\|on-target\|ahead-of-target\|behind-target\|sustaining\|achieved\|on-hold\|cancelled\|entered-in-error\|rejected	Indicates whether the goal has been reached and is still considered relevant.
category	array(CodeableConcept)		Indicates a category the goal falls within.
priority	CodeableConcept		Identifies the mutually agreed level of importance associated with reaching/sustaining the goal.
description*	CodeableConcept		Human-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".
subject	Reference		Identifies the patient, group or organization for whom the goal is being established.
startDate	string		The date or event after which the goal should begin being pursued.
startCodeableConcept	CodeableConcept		The date or event after which the goal should begin being pursued.
target	Goal_Target		Indicates what should be done by when.
statusDate	string		Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.
statusReason	string		Captures the reason for the current status.
expressedBy	Reference		Indicates whose goal this is - patient goal, practitioner goal, etc.
addresses	array(Reference)		The identified conditions and other health record elements that are intended to be addressed by the goal.
note	array(Annotation)		Any comments related to the goal.
outcomeCode	array(CodeableConcept)		Identifies the change (or lack of change) at the point when the status of the goal is assessed.
outcomeReference	array(Reference)		Details of what's changed (or not changed).

Response

200 400 401 404

get

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

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 400 401 404

get

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

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_count	string
_since	string

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 400 401 404

get

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

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params

Params


organizationId*	string\|string	id\|slug
resourceId*
versionId*

Response

200 400 401 404

delete

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

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 400 401 404

get

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

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_id	string
_language	string
addresses	string
category	string
identifier	string
patient	string
start-date	string
status	string
subject	string
target-date	string

Params


organizationId*	string\|string		id\|slug

Response

200 400 401 404

get

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

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_count	string
_since	string

Params


organizationId*	string\|string		id\|slug

Response

200 400 401 404

post

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

Request

Headers


content-type*	string	application/json\|application/x-www-form-urlencoded	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_id	string
_language	string
addresses	string
category	string
identifier	string
patient	string
start-date	string
status	string
subject	string
target-date	string

Params


organizationId*	string\|string		id\|slug

Body


resourceType*	string	Goal	This is a Goal resource
identifier	array(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).
status	string	proposed\|accepted\|planned\|in-progress\|on-target\|ahead-of-target\|behind-target\|sustaining\|achieved\|on-hold\|cancelled\|entered-in-error\|rejected	Indicates whether the goal has been reached and is still considered relevant.
category	array(CodeableConcept)		Indicates a category the goal falls within.
priority	CodeableConcept		Identifies the mutually agreed level of importance associated with reaching/sustaining the goal.
description*	CodeableConcept		Human-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".
subject	Reference		Identifies the patient, group or organization for whom the goal is being established.
startDate	string		The date or event after which the goal should begin being pursued.
startCodeableConcept	CodeableConcept		The date or event after which the goal should begin being pursued.
target	Goal_Target		Indicates what should be done by when.
statusDate	string		Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.
statusReason	string		Captures the reason for the current status.
expressedBy	Reference		Indicates whose goal this is - patient goal, practitioner goal, etc.
addresses	array(Reference)		The identified conditions and other health record elements that are intended to be addressed by the goal.
note	array(Annotation)		Any comments related to the goal.
outcomeCode	array(CodeableConcept)		Identifies the change (or lack of change) at the point when the status of the goal is assessed.
outcomeReference	array(Reference)		Details of what's changed (or not changed).

Response

200 400 401 404

put

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

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params

Params


organizationId*	string\|string		id\|slug
resourceId*

Body


resourceType*	string	Goal	This is a Goal resource
identifier	array(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).
status	string	proposed\|accepted\|planned\|in-progress\|on-target\|ahead-of-target\|behind-target\|sustaining\|achieved\|on-hold\|cancelled\|entered-in-error\|rejected	Indicates whether the goal has been reached and is still considered relevant.
category	array(CodeableConcept)		Indicates a category the goal falls within.
priority	CodeableConcept		Identifies the mutually agreed level of importance associated with reaching/sustaining the goal.
description*	CodeableConcept		Human-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".
subject	Reference		Identifies the patient, group or organization for whom the goal is being established.
startDate	string		The date or event after which the goal should begin being pursued.
startCodeableConcept	CodeableConcept		The date or event after which the goal should begin being pursued.
target	Goal_Target		Indicates what should be done by when.
statusDate	string		Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.
statusReason	string		Captures the reason for the current status.
expressedBy	Reference		Indicates whose goal this is - patient goal, practitioner goal, etc.
addresses	array(Reference)		The identified conditions and other health record elements that are intended to be addressed by the goal.
note	array(Annotation)		Any comments related to the goal.
outcomeCode	array(CodeableConcept)		Identifies the change (or lack of change) at the point when the status of the goal is assessed.
outcomeReference	array(Reference)		Details of what's changed (or not changed).

Response

200 400 401 404