The Immunization resource implements the FHIR R4 Immunization specification and US Core v3.1.1 Immunization profile

Fields

Name Type Cardinality Required Description
identifier Identifier 0..*   Business identifier
status code 1..1 * completed | entered-in-error | not-done - Binding
statusReason boolean 0..1   Reason not done - Binding
vaccineCode CodeableConcept 1..1 * Vaccine product administered - Binding
patient Reference(US Core Patient Profile) 1..1 * Who was immunized
encounter Reference 0..1   Encounter immunization was part of
occurrenceDateTime dateTime 1..1 * Vaccination administration date - either occurenceDateTime or occurenceString must be set
occurrenceString string 1..1 * Vaccination administration date - either occurenceDateTime or occurenceString must be set
recorded dateTime 0..1   When the immunization was first captured in the subject’s record
primarySource boolean 1..1 * Indicates context the data was recorded in
reportOrigin CodeableConcept 0..1   Indicates the source of a secondarily reported record
location Reference 0..1   Where vaccination occurred
manufacturer Reference 0..1   Vaccine manufacturer
lotNumber string 0..1   Vaccine lot number
expirationDate date 0..1   Vaccine expiration date
site CodeableConcept 0..1   Body site vaccine was administered
route CodeableConcept 0..1   How vaccine entered body
doseQuantity Quantity 0..1   Amount of vaccine administered
performer BackboneElement 0..*   Who performed event
note Annotation 0..*   Additional immunization notes
reasonCode CodeableConcept 0..*   Why immunization occurred
reasonReference Reference 0..*   Why immunization occurred
isSubpotent boolean 0..1   Dose potency
subpotentReason CodeableConcept 0..*   Reason for being subpotent
education BackboneElement 0..1   Educational material presented to patient + Rule: One of documentType or reference SHALL be present
programEligibility CodeableConcept 0..*   Patient eligibility for a vaccination program
fundingSource CodeableConcept 0..*   Funding source for the vaccine
reaction BackboneElement 0..*   Details of a reaction that follows immunization
protocolApplied BackboneElement 0..*   Protocol followed by the provider

Interactions

Read

Get an Immunization entry by id

GET /Immunization/:id

Example

Request

https://r4cert.medicasoft.us/api/fhir/Immunization/01dbb131-ef5b-f8f8-2fe6-a2853dc6ea47

Response

{
  "resourceType": "Immunization",
  "status": "completed",
  "vaccineCode": {
    "coding": [
      {
        "code": "140",
        "system": "http://hl7.org/fhir/sid/cvx",
        "display": "Influenza, seasonal, injectable, preservative free"
      }
    ],
    "text": "Influenza, seasonal, injectable, preservative free"
  },
  "patient": {
    "reference": "Patient/bcfa83df-ee8c-9721-cc07-bdcfc2b1e3f2"
  },
  "encounter": {
    "reference": "Encounter/ed359fa9-1fd0-f5c6-b1fc-410dfe5dd539"
  },
  "occurrenceDateTime": "1950-12-26T23:56:44-05:00",
  "primarySource": true,
  "location": {
    "reference": "Location/df0f291d-5acc-5ab7-ff4d-5ec65f385eb9",
    "display": "PCP5851"
  },
  "id": "01dbb131-ef5b-f8f8-2fe6-a2853dc6ea47"
}

Query Immunization resources

GET /Immunization?:query_parameters

Parameters

Name Type Description
date date Vaccination (non)-Administration Date
identifier token Business identifier
location reference The service delivery location or facility in which the vaccine was / was to be administered
lot-number string Vaccine Lot Number
manufacturer reference Vaccine Manufacturer
patient reference The patient for the vaccination record
performer reference The practitioner who played a role in the vaccination
reaction reference Additional information on reaction
reaction-date date When reaction started
reason-code token Reason why the vaccine was administered
reason-reference reference Why immunization occurred
series string The series being followed by the provider
status token Immunization event status
status-reason token Reason why the vaccine was not administered
target-disease token The target disease the dose is being administered against
vaccine-code token Vaccine Product Administered
_include undefined Immunization:manufacturer | Immunization:patient | Immunization:location | Immunization:encounter
_revinclude   Provenance:target

Errors

Code Description
400 Invalid parameters
404 Resource not found