Immunization - FHIR Resource (dstu2)


This Immunization Resource uses the FHIR API standard for access and structure.

Resource Attributes

AttributeField is listTypeDescription
datefalsedateTime Vaccination administration date
doseQuantityfalseQuantity Amount of vaccine administered
encounterfalseReference Encounter administered as part of
expirationDatefalsedate Vaccine expiration date
explanationfalseData Type Administration/non-administration reasons
identifiertrueIdentifier Business identifier
locationfalseReference Where vaccination occurred
lotNumberfalsestring Vaccine lot number
manufacturerfalseReference Vaccine manufacturer
notetrueAnnotation Vaccination notes
patientfalseReference Who was immunized
performerfalseReference Who administered vaccine
reactiontrueData Type Details of a reaction that follows immunization
reportedfalseboolean Indicates a self-reported record
requesterfalseReference Who ordered vaccination
routefalseCodeableConcept How vaccine entered body
sitefalseCodeableConcept Body site vaccine was administered
statusfalsecode in-progress | on-hold | completed | entered-in-error | stopped
vaccinationProtocoltrueData Type What protocol was followed
vaccineCodefalseCodeableConcept Vaccine product administered
wasNotGivenfalseboolean Flag for whether immunization was given

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 the like so:

https://api.1up.health/fhir/dstu2/Immunization?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
datedatedate
dose-sequencenumbervaccinationProtocol.doseSequence
identifiertextidentifier
locationreferencelocation
lot-numbertextlotNumber
manufacturerreferencemanufacturer
notgiventextwasNotGiven
patientreferencepatient
performerreferenceperformer
reactionreferencereaction.detail
reaction-datedatereaction.date
reasontextexplanation.reason
reason-not-giventextexplanation.reasonNotGiven
requesterreferencerequester
statustextstatus
vaccine-codetextvaccineCode