HDR FHIR API

GET Goal Resource Bundle

get

/oracle-fhir-server/fhir/Goal

This endpoint supports the retrieval of Goal resource list.It returns Bundle of Goal resource.

Request

Query Parameters

_format(optional): string
_id(optional): string

The ID of the resource
_language(optional): string

The language of the resource
achievement-status(optional): string

in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable
category(optional): string

E.g. Treatment, dietary, behavioral, etc.
identifier(optional): string

External Ids for this goal
lifecycle-status(optional): string

proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected
patient(optional): string

Who this goal is intended for
start-date(optional): string(date)

When goal pursuit begins
subject(optional): string

Who this goal is intended for
target-date(optional): string(date)

Reach goal on or before

Response

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object Goal

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Goal"
    }
}

Nested Schema : Goal

Type: object

Show Source

addresses: array addresses

Minimum Number of Items: 1

Unique Items Required: true
category: array category

Minimum Number of Items: 1

Unique Items Required: true
description: object ActivityDefinition_topic
expressedBy: object Account_subject
id: string

Minimum Length: 1
identifier: array identifier

Minimum Number of Items: 1

Unique Items Required: true
lifecycleStatus: string

Minimum Length: 1
meta: object Account_meta
outcomeReference: array outcomeReference

Minimum Number of Items: 1

Unique Items Required: true
priority: object Account_type
resourceType: string

Minimum Length: 1
startDate: string

Minimum Length: 1
statusDate: string

Minimum Length: 1
statusReason: string

Minimum Length: 1
subject: object Account_subject
target: array target

Minimum Number of Items: 1

Unique Items Required: true
text: object Account_text

{
    "type":"object",
    "required":[
        "addresses",
        "category",
        "description",
        "expressedBy",
        "id",
        "identifier",
        "lifecycleStatus",
        "meta",
        "outcomeReference",
        "priority",
        "resourceType",
        "startDate",
        "statusDate",
        "statusReason",
        "subject",
        "target",
        "text"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "minLength":1
        },
        "id":{
            "type":"string",
            "minLength":1
        },
        "text":{
            "$ref":"#/definitions/Account_text"
        },
        "identifier":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/AuditEvent_who_identifier"
            },
            "minItems":1
        },
        "lifecycleStatus":{
            "type":"string",
            "minLength":1
        },
        "category":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ActivityDefinition_jurisdiction"
            },
            "minItems":1
        },
        "priority":{
            "$ref":"#/definitions/Account_type"
        },
        "description":{
            "$ref":"#/definitions/ActivityDefinition_topic"
        },
        "subject":{
            "$ref":"#/definitions/Account_subject"
        },
        "startDate":{
            "type":"string",
            "minLength":1
        },
        "target":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Goal_target"
            },
            "minItems":1
        },
        "statusDate":{
            "type":"string",
            "minLength":1
        },
        "statusReason":{
            "type":"string",
            "minLength":1
        },
        "expressedBy":{
            "$ref":"#/definitions/Account_subject"
        },
        "addresses":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/AuditEvent_source_observer"
            },
            "minItems":1
        },
        "outcomeReference":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_subject"
            },
            "minItems":1
        },
        "meta":{
            "$ref":"#/definitions/Account_meta"
        }
    },
    "description":""
}

Nested Schema : addresses

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object AuditEvent_source_observer

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/AuditEvent_source_observer"
    },
    "minItems":1
}

Nested Schema : category

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ActivityDefinition_jurisdiction

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/ActivityDefinition_jurisdiction"
    },
    "minItems":1
}

Nested Schema : ActivityDefinition_topic

Type: object

Show Source

text: string

Minimum Length: 1

{
    "required":[
        "text"
    ],
    "properties":{
        "text":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : Account_subject

Type: object

Show Source

display: string

Minimum Length: 1
reference: string

Minimum Length: 1

{
    "required":[
        "display",
        "reference"
    ],
    "properties":{
        "reference":{
            "type":"string",
            "minLength":1
        },
        "display":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : identifier

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object AuditEvent_who_identifier

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/AuditEvent_who_identifier"
    },
    "minItems":1
}

Nested Schema : Account_meta

Type: object

Show Source

tag: array tag

Minimum Number of Items: 1

Unique Items Required: true

{
    "required":[
        "tag"
    ],
    "properties":{
        "tag":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_type_coding"
            },
            "minItems":1
        }
    }
}

Nested Schema : outcomeReference

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Account_subject

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/Account_subject"
    },
    "minItems":1
}

Nested Schema : Account_type

Type: object

Show Source

coding: array coding

Minimum Number of Items: 1

Unique Items Required: true
text: string

Minimum Length: 1

{
    "required":[
        "coding",
        "text"
    ],
    "properties":{
        "coding":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_type_coding"
            },
            "minItems":1
        },
        "text":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : target

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Goal_target

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/Goal_target"
    },
    "minItems":1
}

Nested Schema : Account_text

Type: object

Show Source

div: string

Minimum Length: 1
status: string

Minimum Length: 1

{
    "required":[
        "div",
        "status"
    ],
    "properties":{
        "status":{
            "type":"string",
            "minLength":1
        },
        "div":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : AuditEvent_source_observer

Type: object

Show Source

display: string

Minimum Length: 1

{
    "required":[
        "display"
    ],
    "properties":{
        "display":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : ActivityDefinition_jurisdiction

Type: object

Show Source

coding(optional): array coding

Minimum Number of Items: 1

Unique Items Required: true

{
    "properties":{
        "coding":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ActivityDefinition_code"
            },
            "minItems":1
        }
    }
}

Nested Schema : coding

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ActivityDefinition_code

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/ActivityDefinition_code"
    },
    "minItems":1
}

Nested Schema : ActivityDefinition_code

Type: object

Show Source

code: string

Minimum Length: 1
system: string

Minimum Length: 1

{
    "required":[
        "code",
        "system"
    ],
    "properties":{
        "system":{
            "type":"string",
            "minLength":1
        },
        "code":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : AuditEvent_who_identifier

Type: object

Show Source

value: string

Minimum Length: 1

{
    "required":[
        "value"
    ],
    "properties":{
        "value":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : tag

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Account_type_coding

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/Account_type_coding"
    },
    "minItems":1
}

Nested Schema : Account_type_coding

Type: object

Show Source

code: string

Minimum Length: 1
display: string

Minimum Length: 1
system: string

Minimum Length: 1

{
    "required":[
        "code",
        "display",
        "system"
    ],
    "properties":{
        "system":{
            "type":"string",
            "minLength":1
        },
        "code":{
            "type":"string",
            "minLength":1
        },
        "display":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : coding

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Account_type_coding

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/Account_type_coding"
    },
    "minItems":1
}

Nested Schema : Goal_target

Type: object

Show Source

detailRange(optional): object Goal_detailRange
dueDate: string

Minimum Length: 1
measure(optional): object ActivityDefinition_valueCodeableConcept

{
    "required":[
        "dueDate"
    ],
    "properties":{
        "measure":{
            "$ref":"#/definitions/ActivityDefinition_valueCodeableConcept"
        },
        "detailRange":{
            "$ref":"#/definitions/Goal_detailRange"
        },
        "dueDate":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : Goal_detailRange

Type: object

Show Source

high: object FamilyMemberHistory_onsetAge
low: object FamilyMemberHistory_onsetAge

{
    "required":[
        "high",
        "low"
    ],
    "properties":{
        "low":{
            "$ref":"#/definitions/FamilyMemberHistory_onsetAge"
        },
        "high":{
            "$ref":"#/definitions/FamilyMemberHistory_onsetAge"
        }
    }
}

Nested Schema : ActivityDefinition_valueCodeableConcept

Type: object

Show Source

coding: array coding

Minimum Number of Items: 1

Unique Items Required: true

{
    "required":[
        "coding"
    ],
    "properties":{
        "coding":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_type_coding"
            },
            "minItems":1
        }
    }
}

Nested Schema : FamilyMemberHistory_onsetAge

Type: object

Show Source

code: string

Minimum Length: 1
system: string

Minimum Length: 1
unit: string

Minimum Length: 1
value: number

{
    "required":[
        "code",
        "system",
        "unit",
        "value"
    ],
    "properties":{
        "value":{
            "type":"number"
        },
        "unit":{
            "type":"string",
            "minLength":1
        },
        "system":{
            "type":"string",
            "minLength":1
        },
        "code":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : coding

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Account_type_coding

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/Account_type_coding"
    },
    "minItems":1
}