HDR FHIR API

GET PlanDefinition Resource Bundle

get

/oracle-fhir-server/fhir/PlanDefinition

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

Request

Query Parameters

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

The ID of the resource
_language(optional): string

The language of the resource
composed-of(optional): string

What resource is being referenced
context(optional): string

A use context assigned to the plan definition
context-quantity(optional): integer

A quantity- or range-valued use context assigned to the plan definition
context-type(optional): string

A type of use context assigned to the plan definition
context-type-quantity(optional): string

A use context type and quantity- or range-based value assigned to the plan definition
context-type-value(optional): string

A use context type and value assigned to the plan definition
date(optional): string(date)

The plan definition publication date
definition(optional): string

Activity or plan definitions used by plan definition
depends-on(optional): string

What resource is being referenced
derived-from(optional): string

What resource is being referenced
description(optional): string

The description of the plan definition
effective(optional): string(date)

The time during which the plan definition is intended to be in use
identifier(optional): string

External identifier for the plan definition
jurisdiction(optional): string

Intended jurisdiction for the plan definition
name(optional): string

Computationally friendly name of the plan definition
predecessor(optional): string

What resource is being referenced
publisher(optional): string

Name of the publisher of the plan definition
status(optional): string

The current status of the plan definition
successor(optional): string

What resource is being referenced
title(optional): string

The human-friendly name of the plan definition
topic(optional): string

Topics associated with the module
type(optional): string

The type of artifact the plan (e.g. order-set, eca-rule, protocol)
url(optional): string

The uri that identifies the plan definition
version(optional): string

The business version of the plan definition

Response

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object PlanDefinition

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

Nested Schema : PlanDefinition

Type: object

Show Source

action: array action

Minimum Number of Items: 1

Unique Items Required: true
approvalDate: string

Minimum Length: 1
author: array author

Minimum Number of Items: 1

Unique Items Required: true
contact: array contact

Minimum Number of Items: 1

Unique Items Required: true
contained: array contained

Minimum Number of Items: 1

Unique Items Required: true
copyright: string

Minimum Length: 1
date: string

Minimum Length: 1
description: string

Minimum Length: 1
effectivePeriod: object Account_servicePeriod
experimental: boolean
id: string

Minimum Length: 1
identifier: array identifier

Minimum Number of Items: 1

Unique Items Required: true
jurisdiction: array jurisdiction

Minimum Number of Items: 1

Unique Items Required: true
lastReviewDate: string

Minimum Length: 1
library: array library
name: string

Minimum Length: 1
publisher: string

Minimum Length: 1
purpose: string

Minimum Length: 1
relatedArtifact: array relatedArtifact

Minimum Number of Items: 1

Unique Items Required: true
resourceType: string

Minimum Length: 1
status: string

Minimum Length: 1
text: object Account_text
title: string

Minimum Length: 1
topic: array topic

Minimum Number of Items: 1

Unique Items Required: true
url: string

Minimum Length: 1
usage: string

Minimum Length: 1
useContext: array useContext

Minimum Number of Items: 1

Unique Items Required: true
version: string

Minimum Length: 1

{
    "type":"object",
    "required":[
        "action",
        "approvalDate",
        "author",
        "contact",
        "contained",
        "copyright",
        "date",
        "description",
        "effectivePeriod",
        "experimental",
        "id",
        "identifier",
        "jurisdiction",
        "lastReviewDate",
        "library",
        "name",
        "publisher",
        "purpose",
        "relatedArtifact",
        "resourceType",
        "status",
        "text",
        "title",
        "topic",
        "url",
        "usage",
        "useContext",
        "version"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "minLength":1
        },
        "id":{
            "type":"string",
            "minLength":1
        },
        "text":{
            "$ref":"#/definitions/Account_text"
        },
        "contained":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/PlanDefinition_contained"
            },
            "minItems":1
        },
        "url":{
            "type":"string",
            "minLength":1
        },
        "identifier":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ActivityDefinition_identifier"
            },
            "minItems":1
        },
        "version":{
            "type":"string",
            "minLength":1
        },
        "name":{
            "type":"string",
            "minLength":1
        },
        "title":{
            "type":"string",
            "minLength":1
        },
        "status":{
            "type":"string",
            "minLength":1
        },
        "experimental":{
            "type":"boolean"
        },
        "date":{
            "type":"string",
            "minLength":1
        },
        "publisher":{
            "type":"string",
            "minLength":1
        },
        "contact":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ActivityDefinition_contact"
            },
            "minItems":1
        },
        "description":{
            "type":"string",
            "minLength":1
        },
        "useContext":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ActivityDefinition_useContext"
            },
            "minItems":1
        },
        "jurisdiction":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ActivityDefinition_jurisdiction"
            },
            "minItems":1
        },
        "purpose":{
            "type":"string",
            "minLength":1
        },
        "usage":{
            "type":"string",
            "minLength":1
        },
        "copyright":{
            "type":"string",
            "minLength":1
        },
        "approvalDate":{
            "type":"string",
            "minLength":1
        },
        "lastReviewDate":{
            "type":"string",
            "minLength":1
        },
        "effectivePeriod":{
            "$ref":"#/definitions/Account_servicePeriod"
        },
        "topic":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ActivityDefinition_topic"
            },
            "minItems":1
        },
        "author":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ActivityDefinition_author"
            },
            "minItems":1
        },
        "relatedArtifact":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ActivityDefinition_relatedArtifact"
            },
            "minItems":1
        },
        "library":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                }
            }
        },
        "action":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/PlanDefinition_action_2"
            },
            "minItems":1
        }
    },
    "description":""
}

Nested Schema : action

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object PlanDefinition_action_2

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

Nested Schema : author

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ActivityDefinition_author

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

Nested Schema : contact

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ActivityDefinition_contact

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

Nested Schema : contained

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object PlanDefinition_contained

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

Nested Schema : Account_servicePeriod

Type: object

Show Source

end: string

Minimum Length: 1
start: string

Minimum Length: 1

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

Nested Schema : identifier

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ActivityDefinition_identifier

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

Nested Schema : jurisdiction

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

Type: array

Show Source

Array of: object items

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

Nested Schema : relatedArtifact

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ActivityDefinition_relatedArtifact

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

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

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ActivityDefinition_useContext

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

Nested Schema : PlanDefinition_action_2

Type: object

Show Source

action(optional): array action

Minimum Number of Items: 1

Unique Items Required: true
title: string

Minimum Length: 1

{
    "required":[
        "title"
    ],
    "properties":{
        "title":{
            "type":"string",
            "minLength":1
        },
        "action":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/PlanDefinition_action_1"
            },
            "minItems":1
        }
    }
}

Nested Schema : action

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object PlanDefinition_action_1

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

Nested Schema : PlanDefinition_action_1

Type: object

Show Source

action(optional): array action

Minimum Number of Items: 1

Unique Items Required: true
groupingBehavior: string

Minimum Length: 1
selectionBehavior: string

Minimum Length: 1
title: string

Minimum Length: 1

{
    "required":[
        "groupingBehavior",
        "selectionBehavior",
        "title"
    ],
    "properties":{
        "title":{
            "type":"string",
            "minLength":1
        },
        "groupingBehavior":{
            "type":"string",
            "minLength":1
        },
        "selectionBehavior":{
            "type":"string",
            "minLength":1
        },
        "action":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/PlanDefinition_action"
            },
            "minItems":1
        }
    }
}

Nested Schema : action

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object PlanDefinition_action

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

Nested Schema : PlanDefinition_action

Type: object

Show Source

definitionCanonical: string

Minimum Length: 1
dynamicValue(optional): array dynamicValue

Minimum Number of Items: 1

Unique Items Required: true
textEquivalent: string

Minimum Length: 1

{
    "required":[
        "definitionCanonical",
        "textEquivalent"
    ],
    "properties":{
        "textEquivalent":{
            "type":"string",
            "minLength":1
        },
        "definitionCanonical":{
            "type":"string",
            "minLength":1
        },
        "dynamicValue":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/PlanDefinition_dynamicValue"
            },
            "minItems":1
        }
    }
}

Nested Schema : dynamicValue

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object PlanDefinition_dynamicValue

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

Nested Schema : PlanDefinition_dynamicValue

Type: object

Show Source

expression(optional): object ActivityDefinition_timingTiming_valueExpression
path: string

Minimum Length: 1

{
    "required":[
        "path"
    ],
    "properties":{
        "path":{
            "type":"string",
            "minLength":1
        },
        "expression":{
            "$ref":"#/definitions/ActivityDefinition_timingTiming_valueExpression"
        }
    }
}

Nested Schema : ActivityDefinition_timingTiming_valueExpression

Type: object

Show Source

expression: string

Minimum Length: 1
language: string

Minimum Length: 1

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

Nested Schema : ActivityDefinition_author

Type: object

Show Source

name: string

Minimum Length: 1
telecom(optional): array telecom

Minimum Number of Items: 1

Unique Items Required: true

{
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "type":"string",
            "minLength":1
        },
        "telecom":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ActivityDefinition_telecom"
            },
            "minItems":1
        }
    }
}

Nested Schema : telecom

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ActivityDefinition_telecom

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

Nested Schema : ActivityDefinition_telecom

Type: object

Show Source

system: string

Minimum Length: 1
use: string

Minimum Length: 1
value: string

Minimum Length: 1

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

Nested Schema : ActivityDefinition_contact

Type: object

Show Source

telecom(optional): array telecom

Minimum Number of Items: 1

Unique Items Required: true

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

Nested Schema : telecom

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ActivityDefinition_telecom

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

Nested Schema : PlanDefinition_contained

Type: object

Show Source

code(optional): object ActivityDefinition_code_1
description: string

Minimum Length: 1
id: string

Minimum Length: 1
kind: string

Minimum Length: 1
participant(optional): array participant

Minimum Number of Items: 1

Unique Items Required: true
resourceType: string

Minimum Length: 1
status: string

Minimum Length: 1
timingTiming(optional): object ActivityDefinition_timingTiming

{
    "required":[
        "description",
        "id",
        "kind",
        "resourceType",
        "status"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "minLength":1
        },
        "id":{
            "type":"string",
            "minLength":1
        },
        "status":{
            "type":"string",
            "minLength":1
        },
        "description":{
            "type":"string",
            "minLength":1
        },
        "kind":{
            "type":"string",
            "minLength":1
        },
        "code":{
            "$ref":"#/definitions/ActivityDefinition_code_1"
        },
        "timingTiming":{
            "$ref":"#/definitions/ActivityDefinition_timingTiming"
        },
        "participant":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ActivityDefinition_participant"
            },
            "minItems":1
        }
    }
}

Nested Schema : ActivityDefinition_code_1

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/ActivityDefinition_code"
            },
            "minItems":1
        },
        "text":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : participant

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ActivityDefinition_participant

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

Nested Schema : ActivityDefinition_timingTiming

Type: object

Show Source

_event: array _event

Minimum Number of Items: 1

Unique Items Required: true

{
    "required":[
        "_event"
    ],
    "properties":{
        "_event":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ActivityDefinition_timingTiming__event"
            },
            "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 : ActivityDefinition_participant

Type: object

Show Source

type: string

Minimum Length: 1

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

Nested Schema : _event

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ActivityDefinition_timingTiming__event

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

Nested Schema : ActivityDefinition_timingTiming__event

Type: object

Show Source

extension(optional): array extension

Minimum Number of Items: 1

Unique Items Required: true

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

Nested Schema : extension

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ActivityDefinition_timingTiming_extension

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

Nested Schema : ActivityDefinition_timingTiming_extension

Type: object

Show Source

url: string

Minimum Length: 1
valueExpression(optional): object ActivityDefinition_timingTiming_valueExpression

{
    "required":[
        "url"
    ],
    "properties":{
        "url":{
            "type":"string",
            "minLength":1
        },
        "valueExpression":{
            "$ref":"#/definitions/ActivityDefinition_timingTiming_valueExpression"
        }
    }
}

Nested Schema : ActivityDefinition_identifier

Type: object

Show Source

system: string

Minimum Length: 1
use: string

Minimum Length: 1
value: string

Minimum Length: 1

{
    "required":[
        "system",
        "use",
        "value"
    ],
    "properties":{
        "use":{
            "type":"string",
            "minLength":1
        },
        "system":{
            "type":"string",
            "minLength":1
        },
        "value":{
            "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 : items

Type: object

Show Source

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

Nested Schema : ActivityDefinition_relatedArtifact

Type: object

Show Source

display: string

Minimum Length: 1
type: string

Minimum Length: 1
url: string

Minimum Length: 1

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

Nested Schema : ActivityDefinition_topic

Type: object

Show Source

text: string

Minimum Length: 1

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

Nested Schema : ActivityDefinition_useContext

Type: object

Show Source

code(optional): object ActivityDefinition_code
valueCodeableConcept(optional): object ActivityDefinition_valueCodeableConcept

{
    "properties":{
        "code":{
            "$ref":"#/definitions/ActivityDefinition_code"
        },
        "valueCodeableConcept":{
            "$ref":"#/definitions/ActivityDefinition_valueCodeableConcept"
        }
    }
}

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