Immunization Conditional Update

put

Immunization Conditional Update

The conditional update interaction is used to update an existing Immunization based on some identification criteria, rather than by logical id.

FHIR documentation for Immunization.

HTTP Basic

OAuth 2.0

API Key

Reset

Make a request and see the response.

Make a request and see the response.

Response Error Details

  • HTTP Code
    Error Code
    Description
  • 400
    400

    Immunization could not be parsed or failed basic FHIR validation rules (or multiple matches were found).

  • 403
    403

    Not Authorized.

  • 412
    412

    The given criteria is not selective enough.

Environment URL
Live

https://fhirsandbox-prod.apigee.net/fhir/v1/Immunization

Name Values Description
Authorization

Specify access token for API in the given format: Bearer [access_token].

Accept

The Accept request-header field can be used to specify certain media types which are acceptable for the response.

Content-Type
(required)

Specifies the format of data in body

Name Values Description
_content

Search the contents of the resource's data using a fulltext search

_id

The resource identity

_language

The resource language

_lastUpdated

Only return resources which were last updated as specified by the given range. The date parameter format is yyyy-mm-ddThh:nn:ss(TZ). The prefixes >, >=, <= and < may be used on the parameter value.

_lastUpdated

Only return resources which were last updated as specified by the given range. The date parameter format is yyyy-mm-ddThh:nn:ss(TZ). Two dates can be used to specify an interval. The prefixes >, >=, <= and < may be used on the parameter value.

_profile

Search for resources which have the given profile

_security

Search for resources which have the given security labels

_tag

Search for resources which have the given tag

_text

Search the contents of the resource's narrative using a fulltext search

date

Vaccination (non)-Administration Date. The date parameter format is yyyy-mm-ddThh:nn:ss(TZ). The prefixes >, >=, <= and < may be used on the parameter value.

date

Vaccination (non)-Administration Date. The date parameter format is yyyy-mm-ddThh:nn:ss(TZ). Two dates can be used to specify an interval. The prefixes >, >=, <= and < may be used on the parameter value.

dose-sequence

Dose number within series

identifier

Business identifier

location

The service delivery location or facility in which the vaccine was / was to be administered

lot-number

Vaccine Lot Number

manufacturer

Vaccine Manufacturer

notgiven

Administrations which were not given

patient

The patient for the vaccination record

performer

The practitioner who administered the vaccination

reaction

Additional information on reaction

reaction-date

When reaction started. The date parameter format is yyyy-mm-ddThh:nn:ss(TZ). The prefixes >, >=, <= and < may be used on the parameter value.

reaction-date

When reaction started. The date parameter format is yyyy-mm-ddThh:nn:ss(TZ). Two dates can be used to specify an interval. The prefixes >, >=, <= and < may be used on the parameter value.

reason

Why immunization occurred

reason-not-given

Explanation of reason vaccination was not administered

requester

The practitioner who ordered the vaccination

status

Immunization event status

vaccine-code

Vaccine Product Administered

The request body should be a valid data payload.

Working...