Immunization search-type

Request Fields and Example
patient
[string]

The patient to whom the immunization was administered

patient.identifier
[string]

One or more external identifiers for the patient

occurrenceDateTime
[string]

The occurrence date-time of immunization (non-)administration

status
[string]

The status of the immunization: completed | entered-in-error | not-done

post/Immunization/_search
Response Fields and Example

Response to an Immunization search operation

resourceType
required, string

Identifies the type of the resource

Value: Bundle
type
required, string

Identifies this bundle as a response to a search

Value: searchset
total
required, number

The total number of matches

entry
[Immunization, Other]

A resource matching the search criteria or related to a matching resource

Any of:
resource
required, object

A record of an immunization that was administered to a patient

resourceType
required, string

Identifies the type of the resource

Value: Immunization
status
required, string

Indicates the current status of the immunization event.

Possible Values: completed, entered-in-error, not-done
vaccineCode
required, object

Vaccine that was administered or was to be administered.

coding
[object]

A reference to a code defined by a terminology system.

system
string

The identification of the code system that defines the meaning of the symbol in the code.

code
string

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

text
string

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

patient
required, object

The patient who either received or did not receive the immunization.

Must be a resource of type Patient.

reference
string

A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.

occurrenceDateTime
required, string

Date vaccine administered or was to be administered.

id
string

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

identifier
[object]

A unique identifier assigned to this immunization record.

extension
[Boolean, String, CodeableConcept, Coding, HumanName, Reference]

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

One of:
url
required, string

Source of the definition for the extension code - a logical name or a URL.

valueBoolean
boolean

A single value for the extension.

use
string

The purpose of this identifier.

Possible Values: usual, official, temp, secondary, old (If known)
system
string

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

value
string

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

statusReason
object

Indicates the reason the immunization event was not performed.

text
string

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

encounter
object

The visit or admission or other contact between patient and health care provider the immunization was performed as part of.

Must be a resource of type Encounter.

reference
string

A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.

primarySource
boolean

An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded.

We do not support or retain this field in our database; however, we will pass the field through to your connection if the field exists in your request.

manufacturer
object

Name of vaccine manufacturer.

Must be a resource of type Organization.

display
string

Plain text narrative that identifies the resource in addition to the resource reference.

lotNumber
string

Lot number of the vaccine product.

route
object

The path by which the vaccine product is taken into the body.

coding
[object]

A reference to a code defined by a terminology system.

system
string

The identification of the code system that defines the meaning of the symbol in the code.

code
string

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

text
string

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

doseQuantity

The quantity of vaccine product that was administered.

See http://hl7.org/fhir/StructureDefinition/SimpleQuantity for more information

search
required, object

Information about the search process that lead to the creation of this entry.

mode
required, string

Identifies the Immunization as matching the search parameters

Value: match