HDR FHIR API

GET ImmunizationEvaluation Resource Bundle

get

/oracle-fhir-server/fhir/ImmunizationEvaluation

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

Request

Query Parameters

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

The ID of the resource
_language(optional): string

The language of the resource
date(optional): string(date)

Date the evaluation was generated
dose-status(optional): string

The status of the dose relative to published recommendations
identifier(optional): string

ID of the evaluation
immunization-event(optional): string

The vaccine administration event being evaluated
patient(optional): string

The patient being evaluated
status(optional): string

Immunization evaluation status
target-disease(optional): string

The vaccine preventable disease being evaluated against

Response

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object ImmunizationEvaluation

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

Nested Schema : ImmunizationEvaluation

Type: object

Show Source

authority: object Account_coverage
date: string

Minimum Length: 1
doseNumberPositiveInt: number
doseStatus: object ActivityDefinition_valueCodeableConcept
id: string

Minimum Length: 1
identifier: array identifier

Minimum Number of Items: 1

Unique Items Required: true
immunizationEvent: object Account_coverage
meta: object Account_meta
patient: object Account_coverage
resourceType: string

Minimum Length: 1
series: string

Minimum Length: 1
seriesDosesPositiveInt: number
status: string

Minimum Length: 1
targetDisease: object Basic_code
text: object Account_text

{
    "type":"object",
    "required":[
        "authority",
        "date",
        "doseNumberPositiveInt",
        "doseStatus",
        "id",
        "identifier",
        "immunizationEvent",
        "meta",
        "patient",
        "resourceType",
        "series",
        "seriesDosesPositiveInt",
        "status",
        "targetDisease",
        "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/Account_identifier"
            },
            "minItems":1
        },
        "status":{
            "type":"string",
            "minLength":1
        },
        "patient":{
            "$ref":"#/definitions/Account_coverage"
        },
        "date":{
            "type":"string",
            "minLength":1
        },
        "authority":{
            "$ref":"#/definitions/Account_coverage"
        },
        "targetDisease":{
            "$ref":"#/definitions/Basic_code"
        },
        "immunizationEvent":{
            "$ref":"#/definitions/Account_coverage"
        },
        "doseStatus":{
            "$ref":"#/definitions/ActivityDefinition_valueCodeableConcept"
        },
        "series":{
            "type":"string",
            "minLength":1
        },
        "doseNumberPositiveInt":{
            "type":"number"
        },
        "seriesDosesPositiveInt":{
            "type":"number"
        },
        "meta":{
            "$ref":"#/definitions/Account_meta"
        }
    },
    "description":""
}

Nested Schema : Account_coverage

Type: object

Show Source

reference: string

Minimum Length: 1

{
    "required":[
        "reference"
    ],
    "properties":{
        "reference":{
            "type":"string",
            "minLength":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 : identifier

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Account_identifier

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

Type: object

Show Source

system: string

Minimum Length: 1
value: string

Minimum Length: 1

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