Immunization $ImmunizationSummary


FHIR Operation: $ImmunizationSummary

HTTP Method: GET

URL: [base URL]/Immunization/$ImmunizationSummary?patient=[patient health number]


Invocations

URL: [base]/Immunization/$ImmunizationSummary

Parameters (In)

NameCardinalityTypeDocumentation
patient1..1Id

The provinical patient health number to retrieve the immunization summary on.

Return Values (Out)

NameCardinalityTypeDocumentation
bundle1..1Bundle

The immunization summary as a bundle (of type 'searchset') containing the following resources (if any): Immunization, ImmunizationRecommendation, AdverseEvent, Condition, OperationOutcome.

There will be one Immunization resource for each immunization, special consideration, or deferral. There will be one ImmunizationRecommendation resource for each recommended immunization. There will be one AdverseEvent resource for each adverse event following immunization. There will be one Condition resource for each active risk factor (other health related issue that may affect the immunization schedule).

The OperationOutcome resource will contain any errors or warnings.