HDR FHIR API

GET ImmunizationRecommendation Resource Bundle

get

/oracle-fhir-server/fhir/ImmunizationRecommendation

This endpoint supports the retrieval of ImmunizationRecommendation resource list.It returns Bundle of ImmunizationRecommendation 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 recommendation(s) created
identifier(optional): string

Business identifier
information(optional): string

Patient observations supporting recommendation
patient(optional): string

Who this profile is for
status(optional): string

Vaccine recommendation status
support(optional): string

Past immunizations supporting recommendation
target-disease(optional): string

Disease to be immunized against
vaccine-type(optional): string

Vaccine or vaccine group recommendation applies to

Response

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object ImmunizationRecommendation

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

Nested Schema : ImmunizationRecommendation

Type: object

Show Source

authority: object Account_coverage
date: string

Minimum Length: 1
id: string

Minimum Length: 1
identifier: array identifier

Minimum Number of Items: 1

Unique Items Required: true
meta: object Account_meta
patient: object Account_coverage
recommendation: array recommendation

Minimum Number of Items: 1

Unique Items Required: true
resourceType: string

Minimum Length: 1
text: object Account_text

{
    "type":"object",
    "required":[
        "authority",
        "date",
        "id",
        "identifier",
        "meta",
        "patient",
        "recommendation",
        "resourceType",
        "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
        },
        "patient":{
            "$ref":"#/definitions/Account_coverage"
        },
        "date":{
            "type":"string",
            "minLength":1
        },
        "authority":{
            "$ref":"#/definitions/Account_coverage"
        },
        "recommendation":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ImmunizationRecommendation_recommendation"
            },
            "minItems":1
        },
        "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 : 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 : recommendation

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ImmunizationRecommendation_recommendation

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

Type: object

Show Source

dateCriterion(optional): array dateCriterion

Minimum Number of Items: 1

Unique Items Required: true
description: string

Minimum Length: 1
doseNumberPositiveInt: number
forecastStatus(optional): object ActivityDefinition_topic
series: string

Minimum Length: 1
seriesDosesPositiveInt: number
supportingImmunization(optional): array supportingImmunization

Minimum Number of Items: 1

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

Minimum Number of Items: 1

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

Minimum Number of Items: 1

Unique Items Required: true

{
    "required":[
        "description",
        "doseNumberPositiveInt",
        "series",
        "seriesDosesPositiveInt"
    ],
    "properties":{
        "vaccineCode":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/AdverseEvent_category"
            },
            "minItems":1
        },
        "forecastStatus":{
            "$ref":"#/definitions/ActivityDefinition_topic"
        },
        "dateCriterion":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ImmunizationRecommendation_dateCriterion"
            },
            "minItems":1
        },
        "description":{
            "type":"string",
            "minLength":1
        },
        "series":{
            "type":"string",
            "minLength":1
        },
        "doseNumberPositiveInt":{
            "type":"number"
        },
        "seriesDosesPositiveInt":{
            "type":"number"
        },
        "supportingImmunization":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_coverage"
            },
            "minItems":1
        },
        "supportingPatientInformation":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_coverage"
            },
            "minItems":1
        }
    }
}

Nested Schema : dateCriterion

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ImmunizationRecommendation_dateCriterion

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

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

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

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

Type: object

Show Source

code(optional): object ActivityDefinition_valueCodeableConcept
value: string

Minimum Length: 1

{
    "required":[
        "value"
    ],
    "properties":{
        "code":{
            "$ref":"#/definitions/ActivityDefinition_valueCodeableConcept"
        },
        "value":{
            "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 : 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 : 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
}