HDR FHIR API

GET CarePlan Resource Bundle

get

/oracle-fhir-server/fhir/CarePlan

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

Request

Query Parameters

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

The ID of the resource
_language(optional): string

The language of the resource
activity-code(optional): string

Detail type of activity
activity-date(optional): string(date)

Specified date occurs within period specified by CarePlan.activity.detail.scheduled[x]
activity-reference(optional): string

Activity details defined in specific resource
based-on(optional): string

Fulfills CarePlan
care-team(optional): string

Who's involved in plan?
category(optional): string

Type of plan
condition(optional): string

Health issues this plan addresses
date(optional): string(date)

Time period plan covers
encounter(optional): string

Encounter created as part of
goal(optional): string

Desired outcome of plan
identifier(optional): string

External Ids for this plan
instantiates-canonical(optional): string

Instantiates FHIR protocol or definition
instantiates-uri(optional): string

Instantiates external protocol or definition
intent(optional): string

proposal | plan | order | option
part-of(optional): string

Part of referenced CarePlan
patient(optional): string

Who the care plan is for
performer(optional): string

Matches if the practitioner is listed as a performer in any of the "simple" activities. (For performers of the detailed activities, chain through the activitydetail search parameter.)
replaces(optional): string

CarePlan replaced by this CarePlan
status(optional): string

draft | active | suspended | completed | entered-in-error | cancelled | unknown
subject(optional): string

Who the care plan is for

Response

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object CarePlan

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

Nested Schema : CarePlan

Type: object

Show Source

activity: array activity

Minimum Number of Items: 1

Unique Items Required: true
addresses: array addresses

Minimum Number of Items: 1

Unique Items Required: true
author: object Account_subject
basedOn: array basedOn

Minimum Number of Items: 1

Unique Items Required: true
careTeam: array careTeam

Minimum Number of Items: 1

Unique Items Required: true
category: array category

Minimum Number of Items: 1

Unique Items Required: true
contained: array contained

Minimum Number of Items: 1

Unique Items Required: true
created: string

Minimum Length: 1
description: string

Minimum Length: 1
encounter: object Account_coverage
goal: array goal

Minimum Number of Items: 1

Unique Items Required: true
id: string

Minimum Length: 1
identifier: array identifier

Minimum Number of Items: 1

Unique Items Required: true
instantiatesUri: array instantiatesUri
intent: string

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

Minimum Number of Items: 1

Unique Items Required: true
period: object CarePlan_period
replaces: array replaces

Minimum Number of Items: 1

Unique Items Required: true
resourceType: string

Minimum Length: 1
status: string

Minimum Length: 1
subject: object Account_subject
text: object Account_text

{
    "type":"object",
    "required":[
        "activity",
        "addresses",
        "author",
        "basedOn",
        "careTeam",
        "category",
        "contained",
        "created",
        "description",
        "encounter",
        "goal",
        "id",
        "identifier",
        "instantiatesUri",
        "intent",
        "meta",
        "partOf",
        "period",
        "replaces",
        "resourceType",
        "status",
        "subject",
        "text"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "minLength":1
        },
        "id":{
            "type":"string",
            "minLength":1
        },
        "text":{
            "$ref":"#/definitions/Account_text"
        },
        "contained":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/CarePlan_contained"
            },
            "minItems":1
        },
        "identifier":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/AuditEvent_who_identifier"
            },
            "minItems":1
        },
        "instantiatesUri":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                }
            }
        },
        "basedOn":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/AuditEvent_source_observer"
            },
            "minItems":1
        },
        "replaces":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/AuditEvent_source_observer"
            },
            "minItems":1
        },
        "partOf":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/AuditEvent_source_observer"
            },
            "minItems":1
        },
        "status":{
            "type":"string",
            "minLength":1
        },
        "intent":{
            "type":"string",
            "minLength":1
        },
        "category":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ActivityDefinition_topic"
            },
            "minItems":1
        },
        "description":{
            "type":"string",
            "minLength":1
        },
        "subject":{
            "$ref":"#/definitions/Account_subject"
        },
        "encounter":{
            "$ref":"#/definitions/Account_coverage"
        },
        "period":{
            "$ref":"#/definitions/CarePlan_period"
        },
        "created":{
            "type":"string",
            "minLength":1
        },
        "author":{
            "$ref":"#/definitions/Account_subject"
        },
        "careTeam":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_coverage"
            },
            "minItems":1
        },
        "addresses":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_subject"
            },
            "minItems":1
        },
        "goal":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_coverage"
            },
            "minItems":1
        },
        "activity":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/CarePlan_activity"
            },
            "minItems":1
        },
        "meta":{
            "$ref":"#/definitions/Account_meta"
        }
    },
    "description":""
}

Nested Schema : activity

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object CarePlan_activity

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

Nested Schema : addresses

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_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 : basedOn

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 : careTeam

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Account_coverage

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

Nested Schema : category

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ActivityDefinition_topic

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

Nested Schema : contained

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object CarePlan_contained

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

Nested Schema : Account_coverage

Type: object

Show Source

reference: string

Minimum Length: 1

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

Nested Schema : goal

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Account_coverage

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/Account_coverage"
    },
    "minItems":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 : instantiatesUri

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
        }
    }
}

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 : partOf

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 : CarePlan_period

Type: object

Show Source

end: string

Minimum Length: 1

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

Nested Schema : replaces

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 : 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 : CarePlan_activity

Type: object

Show Source

detail(optional): object CarePlan_detail
outcomeCodeableConcept(optional): array outcomeCodeableConcept

Minimum Number of Items: 1

Unique Items Required: true
outcomeReference(optional): array outcomeReference

Minimum Number of Items: 1

Unique Items Required: true

{
    "properties":{
        "outcomeCodeableConcept":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/AdverseEvent_category"
            },
            "minItems":1
        },
        "outcomeReference":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_subject"
            },
            "minItems":1
        },
        "detail":{
            "$ref":"#/definitions/CarePlan_detail"
        }
    }
}

Nested Schema : CarePlan_detail

Type: object

Show Source

code: object ActivityDefinition_valueCodeableConcept
doNotPerform: boolean
location: object AuditEvent_source_observer
performer: array performer

Minimum Number of Items: 1

Unique Items Required: true
scheduledTiming: object CarePlan_detail_scheduledTiming
status: string

Minimum Length: 1
statusReason: object ActivityDefinition_topic

{
    "required":[
        "code",
        "doNotPerform",
        "location",
        "performer",
        "scheduledTiming",
        "status",
        "statusReason"
    ],
    "properties":{
        "code":{
            "$ref":"#/definitions/ActivityDefinition_valueCodeableConcept"
        },
        "status":{
            "type":"string",
            "minLength":1
        },
        "statusReason":{
            "$ref":"#/definitions/ActivityDefinition_topic"
        },
        "doNotPerform":{
            "type":"boolean"
        },
        "scheduledTiming":{
            "$ref":"#/definitions/CarePlan_detail_scheduledTiming"
        },
        "location":{
            "$ref":"#/definitions/AuditEvent_source_observer"
        },
        "performer":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_subject"
            },
            "minItems":1
        }
    }
}

Nested Schema : outcomeCodeableConcept

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object AdverseEvent_category

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/AdverseEvent_category"
    },
    "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 : 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 : AuditEvent_source_observer

Type: object

Show Source

display: string

Minimum Length: 1

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

Nested Schema : performer

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 : CarePlan_detail_scheduledTiming

Type: object

Show Source

repeat: object CarePlan_detail_scheduledTiming_repeat

{
    "required":[
        "repeat"
    ],
    "properties":{
        "repeat":{
            "$ref":"#/definitions/CarePlan_detail_scheduledTiming_repeat"
        }
    }
}

Nested Schema : ActivityDefinition_topic

Type: object

Show Source

text: string

Minimum Length: 1

{
    "required":[
        "text"
    ],
    "properties":{
        "text":{
            "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 : 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 : CarePlan_detail_scheduledTiming_repeat

Type: object

Show Source

frequency: number
period: number
periodUnit: string

Minimum Length: 1

{
    "required":[
        "frequency",
        "period",
        "periodUnit"
    ],
    "properties":{
        "frequency":{
            "type":"number"
        },
        "period":{
            "type":"number"
        },
        "periodUnit":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : AdverseEvent_category

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/Account_type_coding"
            },
            "minItems":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 : CarePlan_contained

Type: object

Show Source

clinicalStatus(optional): object Basic_code
code(optional): object ActivityDefinition_topic
id: string

Minimum Length: 1
resourceType: string

Minimum Length: 1
subject(optional): object Account_subject
verificationStatus(optional): object Basic_code

{
    "required":[
        "id",
        "resourceType"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "minLength":1
        },
        "id":{
            "type":"string",
            "minLength":1
        },
        "clinicalStatus":{
            "$ref":"#/definitions/Basic_code"
        },
        "verificationStatus":{
            "$ref":"#/definitions/Basic_code"
        },
        "code":{
            "$ref":"#/definitions/ActivityDefinition_topic"
        },
        "subject":{
            "$ref":"#/definitions/Account_subject"
        }
    }
}

Nested Schema : Basic_code

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/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 : items

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

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
}