Jump to

• Request
• Response

Get a list of immunizations

get

/Immunization

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

Retrieves a list of immunizations that meet the supplied query parameters.

Request

Query Parameters

• _id: string
  The logical resource ID.
• _revinclude: string
  The related Provenance resources to include in the search bundle.

  Allowed Values: [ "Provenance:target" ]
• patient: string
  The patient who received or did not receive the immunization.

Header Parameters

• accept(required): string

  The media type to be requested.

  Example: application/fhir+json

• authorization(required): string
  The credentials to authenticate a consumer to the service. This should be the OAuth2 Bearer Token.

There's no request body for this operation.

Back to Top

Response

200 Response

Successful search response.

Body ()

Root Schema : schema

Type: object

Show Source

• entry: array entry
• id(required): string
• link: array link
• resourceType(required): string
  Allowed Values: [ "Bundle" ]
• type(required): string

{
    "type":"object",
    "required":[
        "resourceType",
        "id",
        "type"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "Bundle"
            ]
        },
        "id":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "link":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BundleLink"
            }
        },
        "entry":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "fullUrl":{
                        "type":"string",
                        "format":"uri"
                    },
                    "resource":{
                        "$ref":"#/components/schemas/Immunization"
                    },
                    "search":{
                        "$ref":"#/components/schemas/Search"
                    }
                }
            }
        }
    }
}

Nested Schema : entry

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "fullUrl":{
                "type":"string",
                "format":"uri"
            },
            "resource":{
                "$ref":"#/components/schemas/Immunization"
            },
            "search":{
                "$ref":"#/components/schemas/Search"
            }
        }
    }
}

Nested Schema : link

Type: array

Show Source

• Array of: object BundleLink

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/BundleLink"
    }
}

Nested Schema : items

Type: object

Show Source

• fullUrl: string (uri)
• resource: object Immunization
• search: object Search

{
    "type":"object",
    "properties":{
        "fullUrl":{
            "type":"string",
            "format":"uri"
        },
        "resource":{
            "$ref":"#/components/schemas/Immunization"
        },
        "search":{
            "$ref":"#/components/schemas/Search"
        }
    }
}

Nested Schema : Immunization

Type: object

Show Source

• id(required): string
• occurrenceDateTime(required): string (date-time)
  (USCDI) The vaccine administration date.
• patient(required): patient
  (USCDI) The patient who was immunized.
• performer: array performer
  The individual who performed the event.
• primarySource: boolean
  (USCDI) The context the data was recorded in.
• resourceType(required): string
  Allowed Values: [ "Immunization" ]
• status(required): string
  (USCDI) The following values are supported:

  • completed
  • entered-in-error
  • not-done
• statusReason: statusReason
  (USCDI) The reason why the immunization was not done.
• vaccineCode(required): vaccineCode
  (USCDI) The vaccine product type (bind to vaccines administered [CVX]).

{
    "type":"object",
    "required":[
        "resourceType",
        "id",
        "status",
        "vaccineCode",
        "patient",
        "occurrenceDateTime"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "Immunization"
            ]
        },
        "id":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"(USCDI) The following values are supported:\n  <ul>\n    <li><code>completed</code></li>\n    <li><code>entered-in-error</code></li>\n    <li><code>not-done</code></li>\n  </ul>\n"
        },
        "statusReason":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/CodeableConcept"
                }
            ],
            "description":"(USCDI) The reason why the immunization was not done."
        },
        "vaccineCode":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/CodeableConcept"
                }
            ],
            "description":"(USCDI) The vaccine product type (bind to vaccines administered [CVX])."
        },
        "patient":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Reference"
                }
            ],
            "description":"(USCDI) The patient who was immunized."
        },
        "occurrenceDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"(USCDI) The vaccine administration date."
        },
        "primarySource":{
            "type":"boolean",
            "description":"(USCDI) The context the data was recorded in."
        },
        "performer":{
            "type":"array",
            "description":"The individual who performed the event.",
            "items":{
                "$ref":"#/components/schemas/ImmunizationPerformer"
            }
        }
    }
}

Nested Schema : Search

Type: object

Show Source

• mode: string

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

Nested Schema : patient

(USCDI) The patient who was immunized.

Match All

(USCDI) The patient who was immunized.

Show Source

• object Reference

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Reference"
        }
    ],
    "description":"(USCDI) The patient who was immunized."
}

Nested Schema : performer

Type: array

The individual who performed the event.

Show Source

• Array of: object ImmunizationPerformer

{
    "type":"array",
    "description":"The individual who performed the event.",
    "items":{
        "$ref":"#/components/schemas/ImmunizationPerformer"
    }
}

Nested Schema : statusReason

(USCDI) The reason why the immunization was not done.

Match All

(USCDI) The reason why the immunization was not done.

Show Source

• object CodeableConcept

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CodeableConcept"
        }
    ],
    "description":"(USCDI) The reason why the immunization was not done."
}

Nested Schema : vaccineCode

(USCDI) The vaccine product type (bind to vaccines administered [CVX]).

Match All

(USCDI) The vaccine product type (bind to vaccines administered [CVX]).

Show Source

• object CodeableConcept

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CodeableConcept"
        }
    ],
    "description":"(USCDI) The vaccine product type (bind to vaccines administered [CVX])."
}

Nested Schema : Reference

Type: object

Show Source

• reference: string
• type: string

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

Nested Schema : ImmunizationPerformer

Type: object

Show Source

• actor(required): actor
  The individual or organization who performed the event.

{
    "type":"object",
    "required":[
        "actor"
    ],
    "properties":{
        "actor":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Reference"
                }
            ],
            "description":"The individual or organization who performed the event."
        }
    }
}

Nested Schema : actor

The individual or organization who performed the event.

Match All

The individual or organization who performed the event.

Show Source

• object Reference

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Reference"
        }
    ],
    "description":"The individual or organization who performed the event."
}

Nested Schema : CodeableConcept

Type: object

Show Source

• coding: array coding
• text: string

{
    "type":"object",
    "properties":{
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            }
        },
        "text":{
            "type":"string"
        }
    }
}

Nested Schema : coding

Type: array

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    }
}

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string (uri)

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string",
            "format":"uri"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        }
    }
}

Nested Schema : BundleLink

Type: object

Show Source

• relation: string
  Allowed Values: [ "self", "next", "previous" ]
• url: string (uri)

{
    "type":"object",
    "properties":{
        "relation":{
            "type":"string",
            "enum":[
                "self",
                "next",
                "previous"
            ]
        },
        "url":{
            "type":"string",
            "format":"uri"
        }
    }
}

Default Response

An OperationOutcome describing any error that occurred.

Body ()

Root Schema : OperationOutcome

Type: object

Show Source

• issue(required): array issue
• resourceType(required): string
  Allowed Values: [ "OperationOutcome" ]

{
    "type":"object",
    "required":[
        "resourceType",
        "issue"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "OperationOutcome"
            ]
        },
        "issue":{
            "type":"array",
            "items":{
                "type":"object",
                "required":[
                    "severity",
                    "code"
                ],
                "properties":{
                    "severity":{
                        "type":"string"
                    },
                    "code":{
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : issue

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "required":[
            "severity",
            "code"
        ],
        "properties":{
            "severity":{
                "type":"string"
            },
            "code":{
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• code(required): string
• severity(required): string

{
    "type":"object",
    "required":[
        "severity",
        "code"
    ],
    "properties":{
        "severity":{
            "type":"string"
        },
        "code":{
            "type":"string"
        }
    }
}

Back to Top