Skip to content
This repository has been archived by the owner on May 7, 2024. It is now read-only.

Commit

Permalink
OHAIUAD-205005: Style edits.
Browse files Browse the repository at this point in the history
  • Loading branch information
cldeitrich committed Dec 12, 2023
1 parent d20968e commit 1b71c31
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 18 deletions.
16 changes: 8 additions & 8 deletions content/millennium/dstu2/care-provision/goal.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: Goal | DSTU 2 API

## Overview

The Goal resource describes intended objectives for a patient. A Goal is typically expressed as a desired outcome or health state to be achieved by a patient over a period or at a specific point in time. A Goal may address preventative health or mitigation of a diagnosis or problem. Goals can be non-health care related (e.g. dance at a wedding).
The Goal resource describes intended objectives for a patient. A goal is typically expressed as a desired outcome or health state to be achieved by a patient over a period or at a specific point in time. A goal may address preventative health or mitigation of a diagnosis or problem. Goals can be nonhealthcare related (for example, dance at a wedding).

The following fields are returned if valued:

Expand All @@ -36,7 +36,7 @@ The common [errors] and [OperationOutcomes] may be returned.

## Search

Search for Goals that meet supplied query parameters:
Search for goals that meet supplied query parameters.

GET /Goal?:parameters

Expand All @@ -48,16 +48,16 @@ Search for Goals that meet supplied query parameters:

Name | Required? | Type | Description
-------------------|------------------|---------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
`_id` | Conditionally | [`token`] | The logical resource ID associated with the Goal. This parameter is required if `patient` or `subject` are not used. Example: `_id=7891`
`_id` | Conditionally | [`token`] | The logical resource ID associated with the goal. This parameter is required if `patient` or `subject` are not used. Example: `_id=7891`
`patient` | Conditionally | [`reference`] | The patient who has the goal. This parameter is required if `_id` or `subject` are not used. Example: `patient=12345`
`subject:Patient` | Condtionally | [`reference`] | The subject who this goal is intended for. Must represent a Patient resource. May use the `:Patient` modifier. This parameter is required if `_id` or `patient` are not used. Example: `subject=Patient/12345` or `subject:Patient=12345`
`targetdate` | No | [`date`] | A date or date range from which to find Goals. Example: `targetdate=ge2016-10-01&targetdate=le2016-12-01`
`targetdate` | No | [`date`] | A date or date range from which to find goals. Example: `targetdate=ge2016-10-01&targetdate=le2016-12-01`

Notes:

* The `targetdate` parameter
* The `targetdate` parameter:
* May be provided once with a prefix to imply a date range or without a prefix to search for goals at a specific date.
* Alternately it may be provided twice with `le`, `lt`, `ge`, or `gt` prefixes to search for goals within specific range. The date and prefix pairs must create a closed range.
* Alternatively, it may be provided twice with `le`, `lt`, `ge`, or `gt` prefixes to search for goals within a specific range. The date and prefix pairs must create a closed range.

### Headers

Expand All @@ -74,7 +74,7 @@ Notes:
<%= headers status: 200 %>
<%= json(:dstu2_goal_bundle) %>

### Example Search by Id
### Example Search by ID

#### Request

Expand All @@ -87,7 +87,7 @@ Notes:

## Retrieve by ID

List an individual Goal by its ID:
List an individual goal by its ID.

GET /Goal/:ID

Expand Down
20 changes: 10 additions & 10 deletions content/millennium/r4/clinical/care-provision/goal.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ title: Goal | R4 API

## Overview

The Goal resource describes intended objectives for a patient. A Goal is typically expressed as a desired outcome or health state to be achieved by a patient over a period or at a specific point in time. A Goal may address preventative health or mitigation of a diagnosis or problem. Goals can be non-health care related (e.g. dance at a wedding).
The Goal resource describes intended objectives for a patient. A goal is typically expressed as a desired outcome or health state to be achieved by a patient over a period or at a specific point in time. A goal may address preventative health or mitigation of a diagnosis or problem. Goals can be nonhealthcare related (for example, dance at a wedding).

* The following [HL7® FHIR® US Core Implementation Guide STU 4.0.0](https://hl7.org/fhir/us/core/STU4/) Profiles are supported by this resource:
* This resource supports the following [HL7 FHIR US Core Implementation Guide STU 4.0.0](https://hl7.org/fhir/us/core/STU4/) profiles:

* [US Core Goal Profile](http://hl7.org/fhir/us/core/STU4/StructureDefinition-us-core-goal.html)

Expand Down Expand Up @@ -47,7 +47,7 @@ The common [errors] and [OperationOutcomes] may be returned.

## Search

Search for Goals that meet supplied query parameters:
Search for goals that meet supplied query parameters.

GET /Goal?:parameters

Expand All @@ -59,20 +59,20 @@ Search for Goals that meet supplied query parameters:

Name | Required? | Type | Description
-------------------|----------------------------|---------------|---------------------------------------------------------------------------------------------------------------
`_id` | Conditionally | [`token`] | The logical resource ID associated with the Goal. This parameter is required if `patient` is not used. Example: `_id=7891`
`_id` | Conditionally | [`token`] | The logical resource ID associated with the goal. This parameter is required if `patient` is not used. Example: `_id=7891`
`patient` | Conditionally | [`reference`] | The patient who has the goal. This parameter is required if `_id` is not used. Example: `patient=12345`
`target-date` | No | [`date`] | A date or date range from which to find Goals. Example: `target-date=ge2016-10-01&target-date=le2016-12-01`
`target-date` | No | [`date`] | A date or date range from which to find goals. Example: `target-date=ge2016-10-01&target-date=le2016-12-01`
`_revinclude` | No | [`token`] | Provenance resource entries to be returned as part of the bundle. Example:_revinclude=Provenance:target

Notes:

* The `target-date` parameter
* The `target-date` parameter:
* May be provided once with a prefix to imply a date range or without a prefix to search for goals at a specific date.
* Alternately it may be provided twice with `le`, `lt`, `ge`, or `gt` prefixes to search for goals within specific range. The date and prefix pairs must create a closed range.
* Alternatively, it may be provided twice with `le`, `lt`, `ge`, or `gt` prefixes to search for goals within a specific range. The date and prefix pairs must create a closed range.
* The `_revinclude` parameter:
* May be provided once with the value `Provenance:target`. Example: `_revinclude=Provenance:target`
* May be provided once with the `Provenance:target` value. Example: `_revinclude=Provenance:target`
* May be provided with the `_id/patient` parameter. Example: `_id=178866310&_revinclude=Provenance:target`
* If provided in a request to the closed endpoint, the OAuth2 token must include the `user/Provenance.read` scope. Currently `patient/Provenance.read` is not supported and hence `_revinclude` cannot be utilised for patient persona.
* If provided in a request to the closed endpoint, the OAuth2 token must include the `user/Provenance.read` scope. Currently, `patient/Provenance.read` is not supported; hence, `_revinclude` cannot be used for patient persona.


### Headers
Expand Down Expand Up @@ -139,7 +139,7 @@ Notes:

## Retrieve by ID

List an individual Goal by its ID:
List an individual goal by its ID.

GET /Goal/:ID

Expand Down

0 comments on commit 1b71c31

Please sign in to comment.