API Endpoints

READ

The [patient|user|system]/Goal.read scope is required.

  GET /fhir/Goal/{id}

Parameter	Type	Description
id	string	Required. The logical id of the resource

Response Codes

Code	Description
200 OK	The requested Goal resource within the body of the HTTP response.
400 Bad Request	The server could not understand the request due to invalid syntax. The response body will contain a message property with the error description
404 Not Found	The requested resource does not exist.
500 Internal Server Error	An error occurred and the server doesn't know how to handle it. The response body will contain a message property with the error description

GET Search

The [patient|user|system]/Goal.read scope is required.

GET /fhir/Goal

Parameter	Type	Description
patient	reference	Required. Patient reference
_revinclude	string	Requests the server to include the associated resource(s) in the search results according to the specified search parameter. Supported values: Provenance:target

Response Codes

Code	Description
200 OK	The body of the response will contain a Bundle resource.
400 Bad Request	The server could not understand the request due to invalid syntax. The response body will contain a message property with the error description
404 Not Found	The requested resource does not exist.
500 Internal Server Error	An error occurred and the server doesn't know how to handle it. The response body will contain a message property with the error description

POST Search

The [patient|user|system]/Goal.read scope is required.

          POST /fhir/Goal/_search

Parameter	Type	Description
patient	reference	Required. Patient reference
_revinclude	string	Requests the server to include the associated resource(s) in the search results according to the specified search parameter. Supported values: Provenance:target