Immunization - FHIR Resource (dstu2)
This Immunization Resource uses the FHIR API standard for access and structure.
Validate an Immunization FHIR Resource (dstu2)
Immunization Attributes
AttributeField is listTypeDescription
Description: in-progress | on-hold | completed | entered-in-error | stopped
FHIR Version: dstu2
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": Learn more about the (Immunization) status FHIR attribute
Description: Amount of vaccine administered
FHIR Version: dstu2
Attribute Type : Quantity
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"doseQuantity": Learn more about the (Immunization) doseQuantity FHIR attribute
Description: Who administered vaccine
FHIR Version: dstu2
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"performer": Learn more about the (Immunization) performer FHIR attribute
Description: Who was immunized
FHIR Version: dstu2
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"patient": Learn more about the (Immunization) patient FHIR attribute
Description: What protocol was followed
FHIR Version: dstu2
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"vaccinationProtocol": Learn more about the (Immunization) vaccinationProtocol FHIR attribute
Description: Business identifier
FHIR Version: dstu2
Attribute Type : Identifier
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": Learn more about the (Immunization) identifier FHIR attribute
Description: Details of a reaction that follows immunization
FHIR Version: dstu2
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"reaction": Learn more about the (Immunization) reaction FHIR attribute
Description: Administration/non-administration reasons
FHIR Version: dstu2
Attribute Type : Data Type
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"explanation": Learn more about the (Immunization) explanation FHIR attribute
Description: Flag for whether immunization was given
FHIR Version: dstu2
Attribute Type : boolean
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"wasNotGiven": Learn more about the (Immunization) wasNotGiven FHIR attribute
Description: Body site vaccine was administered
FHIR Version: dstu2
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"site": Learn more about the (Immunization) site FHIR attribute
Description: Vaccine product administered
FHIR Version: dstu2
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"vaccineCode": Learn more about the (Immunization) vaccineCode FHIR attribute
Description: Vaccination notes
FHIR Version: dstu2
Attribute Type : Annotation
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"note": Learn more about the (Immunization) note FHIR attribute
Description: Indicates a self-reported record
FHIR Version: dstu2
Attribute Type : boolean
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"reported": Learn more about the (Immunization) reported FHIR attribute
Description: Vaccine lot number
FHIR Version: dstu2
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"lotNumber": Learn more about the (Immunization) lotNumber FHIR attribute
Description: Where vaccination occurred
FHIR Version: dstu2
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"location": Learn more about the (Immunization) location FHIR attribute
Description: Who ordered vaccination
FHIR Version: dstu2
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"requester": Learn more about the (Immunization) requester FHIR attribute
Description: Vaccination administration date
FHIR Version: dstu2
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"date": Learn more about the (Immunization) date FHIR attribute
Description: Vaccine manufacturer
FHIR Version: dstu2
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"manufacturer": Learn more about the (Immunization) manufacturer FHIR attribute
Description: How vaccine entered body
FHIR Version: dstu2
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"route": Learn more about the (Immunization) route FHIR attribute
Description: Encounter administered as part of
FHIR Version: dstu2
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"encounter": Learn more about the (Immunization) encounter FHIR attribute
Description: Vaccine expiration date
FHIR Version: dstu2
Attribute Type : date
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"expirationDate": Learn more about the (Immunization) expirationDate FHIR attribute
Immunization Structure
{
"resourceType" : "Immunization",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // Business identifier
"status" : "<code>", // R! in-progress | on-hold | completed | entered-in-error | stopped
"date" : "<dateTime>", // Vaccination administration date
"vaccineCode" : { CodeableConcept }, // R! Vaccine product administered
"patient" : { Reference(Patient) }, // R! Who was immunized
"wasNotGiven" : <boolean>, // R! Flag for whether immunization was given
"reported" : <boolean>, // R! Indicates a self-reported record
"performer" : { Reference(Practitioner) }, // Who administered vaccine
"requester" : { Reference(Practitioner) }, // Who ordered vaccination
"encounter" : { Reference(Encounter) }, // Encounter administered as part of
"manufacturer" : { Reference(Organization) }, // Vaccine manufacturer
"location" : { Reference(Location) }, // Where vaccination occurred
"lotNumber" : "<string>", // Vaccine lot number
"expirationDate" : "<date>", // Vaccine expiration date
"site" : { CodeableConcept }, // Body site vaccine was administered
"route" : { CodeableConcept }, // How vaccine entered body
"doseQuantity" : { Quantity(SimpleQuantity) }, // Amount of vaccine administered
"note" : [{ Annotation }], // Vaccination notes
"explanation" : { // Administration/non-administration reasons
"reason" : [{ CodeableConcept }], // Why immunization occurred
"reasonNotGiven" : [{ CodeableConcept }] // Why immunization did not occur
},
"reaction" : [{ // Details of a reaction that follows immunization
"date" : "<dateTime>", // When reaction started
"detail" : { Reference(Observation) }, // Additional information on reaction
"reported" : <boolean> // Indicates self-reported reaction
}],
"vaccinationProtocol" : [{ // What protocol was followed
"doseSequence" : "<positiveInt>", // R! Dose number within series
"description" : "<string>", // Details of vaccine protocol
"authority" : { Reference(Organization) }, // Who is responsible for protocol
"series" : "<string>", // Name of vaccine series
"seriesDoses" : "<positiveInt>", // Recommended number of doses for immunity
"targetDisease" : [{ CodeableConcept }], // R! Disease immunized against
"doseStatus" : { CodeableConcept }, // R! Indicates if dose counts towards immunity
"doseStatusReason" : { CodeableConcept } // Why dose does (not) count
}]
}
Immunization Search Parameters
The following search parameters can be used to query Immunization resources. Just submit them like so:
https://api.1up.health/fhir/dstu2/Immunization?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
date | date | date |
dose-sequence | number | vaccinationProtocol.doseSequence |
identifier | text | identifier |
location | reference | location |
lot-number | text | lotNumber |
manufacturer | reference | manufacturer |
notgiven | text | wasNotGiven |
patient | reference | patient |
performer | reference | performer |
reaction | reference | reaction.detail |
reaction-date | date | reaction.date |
reason | text | explanation.reason |
reason-not-given | text | explanation.reasonNotGiven |
requester | reference | requester |
status | text | status |
vaccine-code | text | vaccineCode |
