goals

Create Goal

post
/organizations/{organizationId}/fhir/4/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/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*This is a Goal resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(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.
extensionarray(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.
modifierExtensionarray(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).
identifierarray(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.
lifecycleStatusproposed|planned|accepted|active|on-hold|completed|cancelled|entered-in-error|rejectedThe state of the goal throughout its lifecycle.
achievementStatusCodeableConceptDescribes the progression, or lack thereof, towards the goal against the target.
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".
subject*ReferenceIdentifies 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.
targetarray(Goal_Target)Indicates what should be done by when.
statusDatedateIdentifies 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 Goal

patch
/organizations/{organizationId}/fhir/4/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/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*This is a Goal resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(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.
extensionarray(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.
modifierExtensionarray(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).
identifierarray(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.
lifecycleStatusproposed|planned|accepted|active|on-hold|completed|cancelled|entered-in-error|rejectedThe state of the goal throughout its lifecycle.
achievementStatusCodeableConceptDescribes the progression, or lack thereof, towards the goal against the target.
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".
subject*ReferenceIdentifies 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.
targetarray(Goal_Target)Indicates what should be done by when.
statusDatedateIdentifies 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

Read Goal

get
/organizations/{organizationId}/fhir/4/Goal/{resourceId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Goal

get
/organizations/{organizationId}/fhir/4/Goal/{resourceId}/_history

Request

Headers

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

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Goal

get
/organizations/{organizationId}/fhir/4/Goal/{resourceId}/_history/{versionId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Goal

delete
/organizations/{organizationId}/fhir/4/Goal/{resourceId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Goal

get
/organizations/{organizationId}/fhir/4/Goal

Request

Headers

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

Query params

_idstring
_languagestring
achievement-statusstring
categorystring
identifierstring
lifecycle-statusstring
patientstring
start-datestring
subjectstring
target-datestring

Params

organizationId*string|stringid|slug

Response

Search History Goal

get
/organizations/{organizationId}/fhir/4/Goal/_history

Request

Headers

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

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

Search Post Goal

post
/organizations/{organizationId}/fhir/4/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
achievement-statusstring
categorystring
identifierstring
lifecycle-statusstring
patientstring
start-datestring
subjectstring
target-datestring

Params

organizationId*string|stringid|slug

Body

resourceType*This is a Goal resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(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.
extensionarray(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.
modifierExtensionarray(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).
identifierarray(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.
lifecycleStatusproposed|planned|accepted|active|on-hold|completed|cancelled|entered-in-error|rejectedThe state of the goal throughout its lifecycle.
achievementStatusCodeableConceptDescribes the progression, or lack thereof, towards the goal against the target.
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".
subject*ReferenceIdentifies 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.
targetarray(Goal_Target)Indicates what should be done by when.
statusDatedateIdentifies 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

Update Goal

put
/organizations/{organizationId}/fhir/4/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/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*This is a Goal resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(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.
extensionarray(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.
modifierExtensionarray(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).
identifierarray(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.
lifecycleStatusproposed|planned|accepted|active|on-hold|completed|cancelled|entered-in-error|rejectedThe state of the goal throughout its lifecycle.
achievementStatusCodeableConceptDescribes the progression, or lack thereof, towards the goal against the target.
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".
subject*ReferenceIdentifies 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.
targetarray(Goal_Target)Indicates what should be done by when.
statusDatedateIdentifies 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