HDR FHIR API

GET Questionnaire Resource Bundle

get

/oracle-fhir-server/fhir/Questionnaire

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

Request

Query Parameters

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

The ID of the resource
_language(optional): string

The language of the resource
code(optional): string

A code that corresponds to one of its items in the questionnaire
context(optional): string

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

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

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

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

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

The questionnaire publication date
definition(optional): string

ElementDefinition - details for the item
description(optional): string

The description of the questionnaire
effective(optional): string(date)

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

External identifier for the questionnaire
jurisdiction(optional): string

Intended jurisdiction for the questionnaire
name(optional): string

Computationally friendly name of the questionnaire
publisher(optional): string

Name of the publisher of the questionnaire
status(optional): string

The current status of the questionnaire
subject-type(optional): string

Resource that can be subject of QuestionnaireResponse
title(optional): string

The human-friendly name of the questionnaire
url(optional): string

The uri that identifies the questionnaire
version(optional): string

The business version of the questionnaire

Response

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object Questionnaire

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

Nested Schema : Questionnaire

Type: object

Show Source

date: string

Minimum Length: 1
id: string

Minimum Length: 1
item: array item

Minimum Number of Items: 1

Unique Items Required: true
resourceType: string

Minimum Length: 1
status: string

Minimum Length: 1
subjectType: array subjectType
text: object Account_text
title: string

Minimum Length: 1
url: string

Minimum Length: 1

{
    "type":"object",
    "required":[
        "date",
        "id",
        "item",
        "resourceType",
        "status",
        "subjectType",
        "text",
        "title",
        "url"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "minLength":1
        },
        "id":{
            "type":"string",
            "minLength":1
        },
        "text":{
            "$ref":"#/definitions/Account_text"
        },
        "url":{
            "type":"string",
            "minLength":1
        },
        "title":{
            "type":"string",
            "minLength":1
        },
        "status":{
            "type":"string",
            "minLength":1
        },
        "subjectType":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                }
            }
        },
        "date":{
            "type":"string",
            "minLength":1
        },
        "item":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Questionnaire_item_4"
            },
            "minItems":1
        }
    },
    "description":""
}

Nested Schema : item

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Questionnaire_item_4

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

Nested Schema : subjectType

Type: array

Show Source

Array of: object items

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

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

Type: object

Show Source

code(optional): array code

Minimum Number of Items: 1

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

Minimum Number of Items: 1

Unique Items Required: true
linkId: string

Minimum Length: 1
type: string

Minimum Length: 1

{
    "required":[
        "linkId",
        "type"
    ],
    "properties":{
        "linkId":{
            "type":"string",
            "minLength":1
        },
        "code":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ActivityDefinition_code"
            },
            "minItems":1
        },
        "type":{
            "type":"string",
            "minLength":1
        },
        "item":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Questionnaire_item_3"
            },
            "minItems":1
        }
    }
}

Nested Schema : code

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

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Questionnaire_item_3

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

Type: object

Show Source

answerValueSet: string

Minimum Length: 1
code(optional): array code

Minimum Number of Items: 1

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

Minimum Number of Items: 1

Unique Items Required: true
linkId: string

Minimum Length: 1
prefix: string

Minimum Length: 1
type: string

Minimum Length: 1

{
    "required":[
        "answerValueSet",
        "linkId",
        "prefix",
        "type"
    ],
    "properties":{
        "linkId":{
            "type":"string",
            "minLength":1
        },
        "code":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ActivityDefinition_code"
            },
            "minItems":1
        },
        "prefix":{
            "type":"string",
            "minLength":1
        },
        "type":{
            "type":"string",
            "minLength":1
        },
        "answerValueSet":{
            "type":"string",
            "minLength":1
        },
        "item":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Questionnaire_item_2"
            },
            "minItems":1
        }
    }
}

Nested Schema : code

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

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Questionnaire_item_2

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

Nested Schema : Questionnaire_item_2

Type: object

Show Source

code(optional): array code

Minimum Number of Items: 1

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

Minimum Number of Items: 1

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

Minimum Number of Items: 1

Unique Items Required: true
linkId: string

Minimum Length: 1
type: string

Minimum Length: 1

{
    "required":[
        "linkId",
        "type"
    ],
    "properties":{
        "linkId":{
            "type":"string",
            "minLength":1
        },
        "code":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ActivityDefinition_code"
            },
            "minItems":1
        },
        "type":{
            "type":"string",
            "minLength":1
        },
        "enableWhen":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Questionnaire_enableWhen"
            },
            "minItems":1
        },
        "item":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Questionnaire_item_1"
            },
            "minItems":1
        }
    }
}

Nested Schema : code

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

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Questionnaire_enableWhen

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

Nested Schema : item

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Questionnaire_item_1

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

Nested Schema : Questionnaire_enableWhen

Type: object

Show Source

answerCoding(optional): object ActivityDefinition_code
operator: string

Minimum Length: 1
question: string

Minimum Length: 1

{
    "required":[
        "operator",
        "question"
    ],
    "properties":{
        "question":{
            "type":"string",
            "minLength":1
        },
        "operator":{
            "type":"string",
            "minLength":1
        },
        "answerCoding":{
            "$ref":"#/definitions/ActivityDefinition_code"
        }
    }
}

Nested Schema : Questionnaire_item_1

Type: object

Show Source

answerValueSet: string

Minimum Length: 1
code(optional): array code

Minimum Number of Items: 1

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

Minimum Number of Items: 1

Unique Items Required: true
linkId: string

Minimum Length: 1
prefix: string

Minimum Length: 1
type: string

Minimum Length: 1

{
    "required":[
        "answerValueSet",
        "linkId",
        "prefix",
        "type"
    ],
    "properties":{
        "linkId":{
            "type":"string",
            "minLength":1
        },
        "code":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ActivityDefinition_code"
            },
            "minItems":1
        },
        "prefix":{
            "type":"string",
            "minLength":1
        },
        "type":{
            "type":"string",
            "minLength":1
        },
        "answerValueSet":{
            "type":"string",
            "minLength":1
        },
        "item":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Questionnaire_item"
            },
            "minItems":1
        }
    }
}

Nested Schema : code

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

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Questionnaire_item

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

Nested Schema : Questionnaire_item

Type: object

Show Source

answerValueSet: string

Minimum Length: 1
code(optional): array code

Minimum Number of Items: 1

Unique Items Required: true
linkId: string

Minimum Length: 1
prefix: string

Minimum Length: 1
type: string

Minimum Length: 1

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

Nested Schema : code

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

Type: object

Show Source

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