goals
Create 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+fhir | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Params
organizationId* | string|string | id|slug |
Body
resourceType* | This is a Goal resource | ||
id | id | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |
meta | Meta | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | |
implicitRules | uri | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | |
language | code | The base language in which the resource is written. | |
text | Narrative | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | |
contained | array(ResourceList) | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | |
extension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |
modifierExtension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |
identifier | array(Identifier) | Business identifiers assigned to this goal by the performer or other systems which remain constant as the resource is updated and propagates from server to server. | |
lifecycleStatus | proposed|planned|accepted|active|on-hold|completed|cancelled|entered-in-error|rejected | The state of the goal throughout its lifecycle. | |
achievementStatus | CodeableConcept | Describes the progression, or lack thereof, towards the goal against the target. | |
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 | array(Goal_Target) | Indicates what should be done by when. | |
statusDate | date | 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
Patch 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-patch+json | application/json-patch+json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Params
organizationId* | string|string | id|slug | |
resourceId* |
Body
resourceType* | This is a Goal resource | ||
id | id | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |
meta | Meta | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | |
implicitRules | uri | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | |
language | code | The base language in which the resource is written. | |
text | Narrative | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | |
contained | array(ResourceList) | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | |
extension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |
modifierExtension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |
identifier | array(Identifier) | Business identifiers assigned to this goal by the performer or other systems which remain constant as the resource is updated and propagates from server to server. | |
lifecycleStatus | proposed|planned|accepted|active|on-hold|completed|cancelled|entered-in-error|rejected | The state of the goal throughout its lifecycle. | |
achievementStatus | CodeableConcept | Describes the progression, or lack thereof, towards the goal against the target. | |
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 | array(Goal_Target) | Indicates what should be done by when. | |
statusDate | date | 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
Read Goal
Request
Headers
content-type* | string | application/json|application/json+fhir | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Params
organizationId* | string|string | id|slug | |
resourceId* |
Response
Read History Goal
Request
Headers
content-type* | string | application/json|application/json+fhir | 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
Read Version Goal
Request
Headers
content-type* | string | application/json|application/json+fhir | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Params
organizationId* | string|string | id|slug | |
resourceId* | |||
versionId* |
Response
Remove Goal
Request
Headers
content-type* | string | application/json|application/json+fhir | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Params
organizationId* | string|string | id|slug | |
resourceId* |
Response
Search Get Goal
Request
Headers
content-type* | string | application/json|application/json+fhir | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Query params
_id | string | ||
_language | string | ||
achievement-status | string | ||
category | string | ||
identifier | string | ||
lifecycle-status | string | ||
patient | string | ||
start-date | string | ||
subject | string | ||
target-date | string |
Params
organizationId* | string|string | id|slug |
Response
Search History Goal
Request
Headers
content-type* | string | application/json|application/json+fhir | 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
Search Post 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/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 | ||
achievement-status | string | ||
category | string | ||
identifier | string | ||
lifecycle-status | string | ||
patient | string | ||
start-date | string | ||
subject | string | ||
target-date | string |
Params
organizationId* | string|string | id|slug |
Body
resourceType* | This is a Goal resource | ||
id | id | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |
meta | Meta | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | |
implicitRules | uri | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | |
language | code | The base language in which the resource is written. | |
text | Narrative | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | |
contained | array(ResourceList) | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | |
extension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |
modifierExtension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |
identifier | array(Identifier) | Business identifiers assigned to this goal by the performer or other systems which remain constant as the resource is updated and propagates from server to server. | |
lifecycleStatus | proposed|planned|accepted|active|on-hold|completed|cancelled|entered-in-error|rejected | The state of the goal throughout its lifecycle. | |
achievementStatus | CodeableConcept | Describes the progression, or lack thereof, towards the goal against the target. | |
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 | array(Goal_Target) | Indicates what should be done by when. | |
statusDate | date | 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
Update 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+fhir | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Params
organizationId* | string|string | id|slug | |
resourceId* |
Body
resourceType* | This is a Goal resource | ||
id | id | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |
meta | Meta | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | |
implicitRules | uri | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | |
language | code | The base language in which the resource is written. | |
text | Narrative | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | |
contained | array(ResourceList) | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | |
extension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |
modifierExtension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |
identifier | array(Identifier) | Business identifiers assigned to this goal by the performer or other systems which remain constant as the resource is updated and propagates from server to server. | |
lifecycleStatus | proposed|planned|accepted|active|on-hold|completed|cancelled|entered-in-error|rejected | The state of the goal throughout its lifecycle. | |
achievementStatus | CodeableConcept | Describes the progression, or lack thereof, towards the goal against the target. | |
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 | array(Goal_Target) | Indicates what should be done by when. | |
statusDate | date | 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). |