Goal
Semantical type
The FHIR resource type is also used as semantical type of the resource. Include the FHIR resource name Goal into your applications access filter if you need to use this resource.
Resource owner
If the resource contains a subject which is a Patient or Practitioner that user is the owner of the resource. Otherwise the creator of the resource is the owner.
Default value for “subject”
If a resource with no subject field is send to MIDATA, the backend will set the subject to the current user.
Read
Read a single Goal by id.
Request:
[GET] /fhir/Goal/<id>
Read specific version
Read a specific version of a single Goal by id.
Request:
[GET] /fhir/Goal/<id>/_history/<version>
Retrieve history
Retrieve all versions of a single resource.
Request:
[GET] /fhir/Goal/<id>/_history
Search
Search for resources of type Goal
Request:
[GET] /fhir/Goal?searchParams
List of supported search parameters:
Supported query parameters:
| Name | Type | Description |
|---|---|---|
| _id | string | The resource identity |
| _lastUpdated | date | Only return resources which were last updated as specified by the given range |
| _page | string | |
| achievement-status | token | in-progress - improving - worsening - no-change - achieved - sustaining - not-achieved - no-progress - not-attainable |
| category | token | E.g. Treatment, dietary, behavioral, etc. |
| identifier | token | External Ids for this goal |
| lifecycle-status | token | proposed - planned - accepted - active - on-hold - completed - cancelled - entered-in-error - rejected |
| patient | reference | Who this goal is intended for |
| start-date | date | When goal pursuit begins |
| subject | reference | Who this goal is intended for |
| target-date | date | Reach goal on or before |
Create
Create a new resource of type Goal.
Request:
[POST] /fhir/Goal
Update
Updates a resource of type Goal.
Request:
[PUT] /fhir/Goal/<id>