HDR FHIR API

GET Immunization Resource Bundle

get

/oracle-fhir-server/fhir/Immunization

This endpoint supports the retrieval of Immunization resource list.It returns Bundle of Immunization 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)

Vaccination (non)-Administration Date
identifier(optional): string

Business identifier
location(optional): string

The service delivery location or facility in which the vaccine was / was to be administered
lot-number(optional): string

Vaccine Lot Number
manufacturer(optional): string

Vaccine Manufacturer
patient(optional): string

The patient for the vaccination record
performer(optional): string

The practitioner or organization who played a role in the vaccination
reaction(optional): string

Additional information on reaction
reaction-date(optional): string(date)

When reaction started
reason-code(optional): string

Reason why the vaccine was administered
reason-reference(optional): string

Why immunization occurred
series(optional): string

The series being followed by the provider
status(optional): string

Immunization event status
status-reason(optional): string

Reason why the vaccine was not administered
target-disease(optional): string

The target disease the dose is being administered against
vaccine-code(optional): string

Vaccine Product Administered

Response

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object Immunization

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

Nested Schema : Immunization

Type: object

Show Source

doseQuantity: object Immunization_doseQuantity
education: array education

Minimum Number of Items: 1

Unique Items Required: true
encounter: object Account_coverage
expirationDate: string

Minimum Length: 1
fundingSource: object Basic_code
id: string

Minimum Length: 1
identifier: array identifier

Minimum Number of Items: 1

Unique Items Required: true
isSubpotent: boolean
location: object Account_coverage
lotNumber: string

Minimum Length: 1
manufacturer: object Account_coverage
meta: object Account_meta
note: array note

Minimum Number of Items: 1

Unique Items Required: true
occurrenceDateTime: string

Minimum Length: 1
patient: object Account_coverage
performer: array performer

Minimum Number of Items: 1

Unique Items Required: true
primarySource: boolean
programEligibility: array programEligibility

Minimum Number of Items: 1

Unique Items Required: true
reasonCode: array reasonCode

Minimum Number of Items: 1

Unique Items Required: true
resourceType: string

Minimum Length: 1
route: object ActivityDefinition_valueCodeableConcept
site: object ActivityDefinition_valueCodeableConcept
status: string

Minimum Length: 1
text: object Account_text
vaccineCode: object ActivityDefinition_code_1

{
    "type":"object",
    "required":[
        "doseQuantity",
        "education",
        "encounter",
        "expirationDate",
        "fundingSource",
        "id",
        "identifier",
        "isSubpotent",
        "location",
        "lotNumber",
        "manufacturer",
        "meta",
        "note",
        "occurrenceDateTime",
        "patient",
        "performer",
        "primarySource",
        "programEligibility",
        "reasonCode",
        "resourceType",
        "route",
        "site",
        "status",
        "text",
        "vaccineCode"
    ],
    "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
        },
        "vaccineCode":{
            "$ref":"#/definitions/ActivityDefinition_code_1"
        },
        "patient":{
            "$ref":"#/definitions/Account_coverage"
        },
        "encounter":{
            "$ref":"#/definitions/Account_coverage"
        },
        "occurrenceDateTime":{
            "type":"string",
            "minLength":1
        },
        "primarySource":{
            "type":"boolean"
        },
        "location":{
            "$ref":"#/definitions/Account_coverage"
        },
        "manufacturer":{
            "$ref":"#/definitions/Account_coverage"
        },
        "lotNumber":{
            "type":"string",
            "minLength":1
        },
        "expirationDate":{
            "type":"string",
            "minLength":1
        },
        "site":{
            "$ref":"#/definitions/ActivityDefinition_valueCodeableConcept"
        },
        "route":{
            "$ref":"#/definitions/ActivityDefinition_valueCodeableConcept"
        },
        "doseQuantity":{
            "$ref":"#/definitions/Immunization_doseQuantity"
        },
        "performer":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Immunization_performer"
            },
            "minItems":1
        },
        "note":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ActivityDefinition_topic"
            },
            "minItems":1
        },
        "reasonCode":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ActivityDefinition_jurisdiction"
            },
            "minItems":1
        },
        "isSubpotent":{
            "type":"boolean"
        },
        "education":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Immunization_education"
            },
            "minItems":1
        },
        "programEligibility":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ActivityDefinition_jurisdiction"
            },
            "minItems":1
        },
        "fundingSource":{
            "$ref":"#/definitions/Basic_code"
        },
        "meta":{
            "$ref":"#/definitions/Account_meta"
        }
    },
    "description":""
}

Nested Schema : Immunization_doseQuantity

Type: object

Show Source

code: string

Minimum Length: 1
system: string

Minimum Length: 1
value: number

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

Nested Schema : education

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Immunization_education

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

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

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Immunization_performer

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

Nested Schema : programEligibility

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

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

Type: object

Show Source

documentType: string

Minimum Length: 1
presentationDate: string

Minimum Length: 1
publicationDate: string

Minimum Length: 1

{
    "required":[
        "documentType",
        "presentationDate",
        "publicationDate"
    ],
    "properties":{
        "documentType":{
            "type":"string",
            "minLength":1
        },
        "publicationDate":{
            "type":"string",
            "minLength":1
        },
        "presentationDate":{
            "type":"string",
            "minLength":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 : 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 : ActivityDefinition_topic

Type: object

Show Source

text: string

Minimum Length: 1

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

Nested Schema : Immunization_performer

Type: object

Show Source

actor(optional): object Account_coverage
function(optional): object Basic_code

{
    "properties":{
        "function":{
            "$ref":"#/definitions/Basic_code"
        },
        "actor":{
            "$ref":"#/definitions/Account_coverage"
        }
    }
}

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