Jump to

• Request
• Response

Get a goal by ID

get

/Goal/{id}

Note: The FHIR API endpoints described below are available for customers to deploy and use. Developers are welcome and encouraged to develop against the specifications in anticipation of customer deployment.

Retrieves an individual goal by the associated ID.

Request

Path Parameters

• id(required): string
  The logical resource ID.

Header Parameters

• accept(required): string

  The media type to be requested.

  Example: application/fhir+json

• authorization(required): string
  The OAuth 2.0 Bearer token used to authenticate the request.

There's no request body for this operation.

Back to Top

Response

200 Response

The successful retrieve response.

Body ()

Root Schema : Goal

Type: object

A desired health outcome for a patient.

Show Source

• _startDate: object ElementForGoal
• description(required): object CodeableConcept
• id(required): string
  The logical ID of the goal.
• lifecycleStatus(required): string
  Allowed Values: [ "proposed", "planned", "accepted", "active", "on-hold", "completed", "cancelled", "entered-in-error", "rejected" ]

  The current lifecycle state of the goal.
• meta: object meta
• resourceType(required): string
  Allowed Values: [ "Goal" ]
• startDate: string (date)
  The date on which the goal becomes active.
• subject(required): object ReferenceForGoal
• target(required): array target
  Minimum Number of Items: 1

  Maximum Number of Items: 1

  The target outcome for the goal.

{
    "type":"object",
    "description":"A desired health outcome for a patient.",
    "required":[
        "resourceType",
        "id",
        "lifecycleStatus",
        "description",
        "subject",
        "target"
    ],
    "additionalProperties":false,
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "Goal"
            ]
        },
        "id":{
            "type":"string",
            "description":"The logical ID of the goal."
        },
        "meta":{
            "type":"object",
            "properties":{
                "versionId":{
                    "type":"string",
                    "description":"The version-specific identifier."
                },
                "lastUpdated":{
                    "type":"string",
                    "format":"date-time",
                    "description":"The last update time."
                },
                "security":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/Coding"
                    }
                }
            }
        },
        "lifecycleStatus":{
            "type":"string",
            "enum":[
                "proposed",
                "planned",
                "accepted",
                "active",
                "on-hold",
                "completed",
                "cancelled",
                "entered-in-error",
                "rejected"
            ],
            "description":"The current lifecycle state of the goal."
        },
        "description":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "subject":{
            "$ref":"#/components/schemas/ReferenceForGoal"
        },
        "startDate":{
            "type":"string",
            "format":"date",
            "description":"The date on which the goal becomes active."
        },
        "_startDate":{
            "$ref":"#/components/schemas/ElementForGoal"
        },
        "target":{
            "type":"array",
            "minItems":1,
            "maxItems":1,
            "description":"The target outcome for the goal.",
            "items":{
                "$ref":"#/components/schemas/TargetForGoal"
            }
        }
    }
}

Nested Schema : ElementForGoal

Type: object

Show Source

• extension: array extension
  The additional element information.

{
    "type":"object",
    "additionalProperties":false,
    "properties":{
        "extension":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ExtensionForGoal"
            },
            "description":"The additional element information."
        }
    }
}

Nested Schema : CodeableConcept

Type: object

Show Source

• coding: array coding
  The terminology codings or data-absent-reason coding.
• id: string
• text: string
  The human-readable medication name.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            },
            "description":"The terminology codings or data-absent-reason coding."
        },
        "text":{
            "type":"string",
            "description":"The human-readable medication name."
        }
    }
}

Nested Schema : meta

Type: object

Show Source

• lastUpdated: string (date-time)
  The last update time.
• security: array security
• versionId: string
  The version-specific identifier.

{
    "type":"object",
    "properties":{
        "versionId":{
            "type":"string",
            "description":"The version-specific identifier."
        },
        "lastUpdated":{
            "type":"string",
            "format":"date-time",
            "description":"The last update time."
        },
        "security":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            }
        }
    }
}

Nested Schema : ReferenceForGoal

Type: object

Show Source

• reference(required): string
  The relative patient reference.
• type(required): string
  Allowed Values: [ "Patient" ]

  The referenced resource type.

{
    "type":"object",
    "additionalProperties":false,
    "required":[
        "type",
        "reference"
    ],
    "properties":{
        "type":{
            "type":"string",
            "enum":[
                "Patient"
            ],
            "description":"The referenced resource type."
        },
        "reference":{
            "type":"string",
            "description":"The relative patient reference."
        }
    }
}

Nested Schema : target

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 1

The target outcome for the goal.

Show Source

• Array of: object TargetForGoal

{
    "type":"array",
    "minItems":1,
    "maxItems":1,
    "description":"The target outcome for the goal.",
    "items":{
        "$ref":"#/components/schemas/TargetForGoal"
    }
}

Nested Schema : extension

Type: array

The additional element information.

Show Source

• Array of: object ExtensionForGoal

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ExtensionForGoal"
    },
    "description":"The additional element information."
}

Nested Schema : ExtensionForGoal

Type: object

Show Source

• url(required): string (uri)
  The extension definition URL.
• valueCode(required): string
  The coded extension value.

{
    "type":"object",
    "additionalProperties":false,
    "required":[
        "url",
        "valueCode"
    ],
    "properties":{
        "url":{
            "type":"string",
            "format":"uri",
            "description":"The extension definition URL."
        },
        "valueCode":{
            "type":"string",
            "description":"The coded extension value."
        }
    }
}

Nested Schema : coding

Type: array

The terminology codings or data-absent-reason coding.

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    },
    "description":"The terminology codings or data-absent-reason coding."
}

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string
• userSelected: boolean

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        },
        "userSelected":{
            "type":"boolean"
        }
    }
}

Nested Schema : security

Type: array

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    }
}

Nested Schema : TargetForGoal

Type: object

Show Source

• _dueDate: object ElementForGoal
• dueDate: string (date)
  The target completion date.

{
    "type":"object",
    "additionalProperties":false,
    "properties":{
        "dueDate":{
            "type":"string",
            "format":"date",
            "description":"The target completion date."
        },
        "_dueDate":{
            "$ref":"#/components/schemas/ElementForGoal"
        }
    }
}

Default Response

An OperationOutcome describing any error that occurred.

Body ()

Root Schema : OperationOutcome

Type: object

The FHIR OperationOutcome.

Show Source

• issue: array issue
  The OperationOutcome issues.
• resourceType: string
  Allowed Values: [ "OperationOutcome" ]

  The FHIR resource type.

{
    "type":"object",
    "description":"The FHIR OperationOutcome.",
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "OperationOutcome"
            ],
            "description":"The FHIR resource type."
        },
        "issue":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OperationOutcomeIssue"
            },
            "description":"The OperationOutcome issues."
        }
    }
}

Nested Schema : issue

Type: array

The OperationOutcome issues.

Show Source

• Array of: object OperationOutcomeIssue

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/OperationOutcomeIssue"
    },
    "description":"The OperationOutcome issues."
}

Nested Schema : OperationOutcomeIssue

Type: object

Show Source

• code: string
• details: object CodeableConcept
• diagnostics: string
• expression: array expression
• severity: string

{
    "type":"object",
    "properties":{
        "severity":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "details":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "diagnostics":{
            "type":"string"
        },
        "expression":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : CodeableConcept

Type: object

Show Source

• coding: array coding
  The terminology codings or data-absent-reason coding.
• id: string
• text: string
  The human-readable medication name.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            },
            "description":"The terminology codings or data-absent-reason coding."
        },
        "text":{
            "type":"string",
            "description":"The human-readable medication name."
        }
    }
}

Nested Schema : expression

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : coding

Type: array

The terminology codings or data-absent-reason coding.

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    },
    "description":"The terminology codings or data-absent-reason coding."
}

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string
• userSelected: boolean

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        },
        "userSelected":{
            "type":"boolean"
        }
    }
}

Back to Top