ID

39906

Description

This is a complete version of the resource Immunziation. FHIR version R4 (v4.0.0). FHIR is a platform specification that defines a set of capabilities use across the healthcare process, in all jurisdictions, and in lots of different context. https://www.hl7.org/fhir/resourcelist.html Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party. The Immunization resource is intended to cover the recording of current and historical administration of vaccines to patients across all healthcare disciplines in all care settings and all regions. This includes immunization of both humans and animals but does not include the administration of non-vaccine agents, even those that may have or claim to have immunological effects. While the terms "immunization" and "vaccination" are not clinically identical, for the purposes of the FHIR resources, the terms are used synonymously.

Link

https://www.hl7.org/fhir/resourcelist.html

Keywords

Versions (2)
  1. 3/2/20 3/2/20 -
  2. 3/2/20 3/2/20 -
Copyright Holder

HL7 FHIR

Uploaded on

March 2, 2020

DOI

To request one please log in.

License

Creative Commons BY-NC 4.0
Model comments :

You can comment on the data model here. Via the speech bubbles at the itemgroups and items you can add comments to those specificially.

Back to model comments
Itemgroup comments for :

Item comments for :

In order to download data models you must be logged in. Please log in or register for free.

FHIR v4.0.0

English

Resource Immunization

1 forms  
  1. StudyEvent: ODM
    1. Resource Immunization
Immunization
Description

Immunization

Alias
UMLS CUI-1
C0020971
A unique identifier assigned to this immunization record.
Description

This is a business identifier, not a resource identifier

Data type

text

Alias
UMLS CUI [1,1]
C0020971
UMLS CUI [1,2]
C0600091
Indicates the current status of the immunization event
Description

Immunization.status

Data type

text

Alias
UMLS CUI [1,1]
C0020971
UMLS CUI [1,2]
C0449438
Indicates the reason the immunization event was not performed
Description

The corresponding value set can be found at https://www.hl7.org/fhir/valueset-immunization-status-reason.html

Data type

text

Alias
UMLS CUI [1,1]
C0020971
UMLS CUI [1,2]
C0449438
UMLS CUI [1,3]
C0566251
Vaccine that was administered or was to be administered
Description

The corresponding value set can be found at https://www.hl7.org/fhir/valueset-vaccine-code.html

Data type

text

Alias
UMLS CUI [1,1]
C0020971
UMLS CUI [1,2]
C0042210
UMLS CUI [1,3]
C0805701
The patient who either received or did not receive the immunization
Description

Immunization.patient

Data type

text

Alias
UMLS CUI [1,1]
C0020971
UMLS CUI [1,2]
C0030705
Encounter at which the immunization was performed
Description

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

Data type

text

Alias
UMLS CUI [1,1]
C0020971
UMLS CUI [1,2]
C1947978
Date vaccine administered or was to be administered
Description

Immunization.occurrence[x]

Data type

datetime

Alias
UMLS CUI [1,1]
C0020971
UMLS CUI [1,2]
C1264639
The date the occurrence of the immunization was first captured in the record
Description

The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.

Data type

datetime

Alias
UMLS CUI [1,1]
C0020971
UMLS CUI [1,2]
C3669169
Indication that the content of the record is based on the information from the person who administered the vaccine
Description

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.

Data type

boolean

Alias
UMLS CUI [1,1]
C0020971
UMLS CUI [1,2]
C0205225
UMLS CUI [1,3]
C0683836
Source of the data when the report of the immunization event is not based on information from the person who administered the vaccine
Description

The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.

Data type

text

Alias
UMLS CUI [1,1]
C0020971
UMLS CUI [1,2]
C0684224
UMLS CUI [1,3]
C0011001
The service delivery location where the vaccine administration occurred.
Description

Immunization.location

Data type

text

Alias
UMLS CUI [1,1]
C0020971
UMLS CUI [1,2]
C0450429
UMLS CUI [1,3]
C1515974
Name of vaccine manufacturer. Name of vaccine manufacturer. Name of vaccine manufacturer.
Description

Immunization.manufacturer

Data type

text

Alias
UMLS CUI [1,1]
C0020971
UMLS CUI [1,2]
C0947322
Lot number of the vaccine product.
Description

Immunization.lotNumber

Data type

text

Alias
UMLS CUI [1,1]
C0020971
UMLS CUI [1,2]
C1115660
Date vaccine batch expires.
Description

Immunization.expirationDate

Data type

date

Alias
UMLS CUI [1,1]
C0020971
UMLS CUI [1,2]
C3669020
UMLS CUI [1,3]
C0042210
Body site where vaccine was administered.
Description

Immunization.site

Data type

text

Alias
UMLS CUI [1,1]
C0020971
UMLS CUI [1,2]
C1515974
The path by which the vaccine product is taken into the body.
Description

Immunization.route

Data type

text

Alias
UMLS CUI [1,1]
C0020971
UMLS CUI [1,2]
C0013153
The quantity of vaccine product that was administered.
Description

Immunization.doseQuantity

Data type

text

Alias
UMLS CUI [1,1]
C0020971
UMLS CUI [1,2]
C0001555
UMLS CUI [1,3]
C1265611
Extra information about the immunization that is not conveyed by the other attributes.
Description

Immunization.note

Data type

text

Alias
UMLS CUI [1,1]
C0020971
UMLS CUI [1,2]
C1317574
Reasons why the vaccine was administered.
Description

The corresponding value set can be found at https://www.hl7.org/fhir/valueset-immunization-reason.html

Data type

text

Alias
UMLS CUI [1,1]
C0020971
UMLS CUI [1,2]
C0566251
Condition, Observation or DiagnosticReport that supports why the immunization was administered.
Description

Immunization.reasonReference

Data type

text

Alias
UMLS CUI [1,1]
C0020971
UMLS CUI [1,2]
C0566251
UMLS CUI [1,3]
C3244318
Indication if a dose is considered to be subpotent
Description

Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.

Data type

text

Alias
UMLS CUI [1,1]
C0020971
UMLS CUI [1,2]
C0178602
UMLS CUI [1,3]
C2609410
Reason why a dose is considered to be subpotent.
Description

Immunization.subpotentReason

Data type

text

Alias
UMLS CUI [1,1]
C0020971
UMLS CUI [1,2]
C0178602
UMLS CUI [1,3]
C2609410
Indicates a patient's eligibility for a funding program.
Description

Immunization.programEligibility

Data type

text

Alias
UMLS CUI [1,1]
C0020971
UMLS CUI [1,2]
C4527252
UMLS CUI [1,3]
C0243098
UMLS CUI [1,4]
C2728259
Indicates the source of the vaccine actually administered
Description

Indicates the source of the vaccine actually administered. This may be different than the patient eligibility (e.g. the patient may be eligible for a publically purchased vaccine but due to inventory issues, vaccine purchased with private funds was actually administered).

Data type

text

Alias
UMLS CUI [1,1]
C0020971
UMLS CUI [1,2]
C0243098
UMLS CUI [1,3]
C0449416
Immunization.performer
Description

Immunization.performer

Alias
UMLS CUI-1
C0020971
UMLS CUI-2
C1550480
Describes the type of performance (e.g. ordering provider, administering provider, etc.)
Description

Immunization.performer.function

Data type

text

Alias
UMLS CUI [1,1]
C0020971
UMLS CUI [1,2]
C1550480
UMLS CUI [1,3]
C0597198
UMLS CUI [1,4]
C0332307
The practitioner or organization who performed the action.
Description

Immunization.performer.actor

Data type

text

Alias
UMLS CUI [1,1]
C0020971
UMLS CUI [1,2]
C1550480
UMLS CUI [1,3]
C0335083
Immunization Education
Description

Immunization Education

Alias
UMLS CUI-1
C0020971
UMLS CUI-2
C4266536
UMLS CUI-3
C1514812
Identifier of the material presented to the patient.
Description

Immunization.education.documentType

Data type

text

Alias
UMLS CUI [1,1]
C0020971
UMLS CUI [1,2]
C4266536
UMLS CUI [1,3]
C0600091
Reference pointer to the educational material given to the patient
Description

Reference pointer to the educational material given to the patient if the information was on line

Data type

text

Alias
UMLS CUI [1,1]
C0020971
UMLS CUI [1,2]
C4266536
UMLS CUI [1,3]
C1514812
Date the educational material was published.
Description

Immunization.education.publicationDate

Data type

datetime

Alias
UMLS CUI [1,1]
C0020971
UMLS CUI [1,2]
C4266536
UMLS CUI [1,3]
C0034036
UMLS CUI [1,4]
C0011008
Date the educational material was given to the patient.
Description

Immunization.education.presentationDate

Data type

datetime

Alias
UMLS CUI [1,1]
C0020971
UMLS CUI [1,2]
C4266536
UMLS CUI [1,3]
C0449450
UMLS CUI [1,4]
C0011008
Immunization reaction
Description

Immunization reaction

Alias
UMLS CUI-1
C0020971
UMLS CUI-2
C0443286
Date of reaction to the immunization
Description

Date of reaction to the immunization.

Data type

datetime

Alias
UMLS CUI [1,1]
C0020971
UMLS CUI [1,2]
C0011008
UMLS CUI [1,3]
C0443286
Details of the reaction.
Description

Immunization.reaction.detail

Data type

text

Alias
UMLS CUI [1,1]
C0020971
UMLS CUI [1,2]
C1522508
UMLS CUI [1,3]
C0443286
Self-reported indicator.
Description

Immunization.reaction.reported

Data type

boolean

Alias
UMLS CUI [1,1]
C0020971
UMLS CUI [1,2]
C0443286
UMLS CUI [1,3]
C4319718
Immunization.protocolApplied
Description

Immunization.protocolApplied

Alias
UMLS CUI-1
C0020971
UMLS CUI-2
C0008971
UMLS CUI-3
C4048755
One possible path to achieve presumed immunity against a disease
Description

One possible path to achieve presumed immunity against a disease - within the context of an authority.

Data type

text

Alias
UMLS CUI [1,1]
C0020971
UMLS CUI [1,2]
C0008971
UMLS CUI [1,3]
C4048755
UMLS CUI [1,4]
C0205549
Indicates the authority who published the protocol that is being followed.
Description

Immunization.protocolApplied.authority

Data type

text

Alias
UMLS CUI [1,1]
C0020971
UMLS CUI [1,2]
C0008971
UMLS CUI [1,3]
C4048755
UMLS CUI [1,4]
C0599437
The vaccine preventable disease the dose is being administered against.
Description

The corresponding value set can be found at https://www.hl7.org/fhir/valueset-immunization-target-disease.html

Data type

text

Alias
UMLS CUI [1,1]
C0020971
UMLS CUI [1,2]
C0008971
UMLS CUI [1,3]
C1521840
UMLS CUI [1,4]
C0012634
Nominal position in a series.
Description

Immunization.protocolApplied.doseNumber[x]

Data type

text

Alias
UMLS CUI [1,1]
C0020971
UMLS CUI [1,2]
C0008971
UMLS CUI [1,3]
C1115464
The recommended number of doses to achieve immunity.
Description

Immunization.protocolApplied.seriesDoses[x]

Data type

text

Alias
UMLS CUI [1,1]
C0020971
UMLS CUI [1,2]
C0008971
UMLS CUI [1,3]
C0205549
UMLS CUI [1,4]
C0678766
Back to the top of the page

Similar models

Resource Immunization

1 forms
  1. StudyEvent: ODM
    1. Resource Immunization
Name
Type
Description | Question | Decode (Coded Value)
Data type
Alias
Item Group
Immunization
C0020971 (UMLS CUI-1)
Immunization.identifier
Item
A unique identifier assigned to this immunization record.
text
C0020971 (UMLS CUI [1,1])
C0600091 (UMLS CUI [1,2])
Item
Indicates the current status of the immunization event
text
C0020971 (UMLS CUI [1,1])
C0449438 (UMLS CUI [1,2])
Immunization.status
Code List
Indicates the current status of the immunization event
CL Item
Completed (completed)
The event has now concluded. (Comment:en)
CL Item
Entered in Error (entered-in-error)
This electronic record should never have existed, though it is possible that real-world decisions were based on it. (If real-world activity has occurred, the status should be "cancelled" rather than "entered-in-error".). (Comment:en)
CL Item
Not Done (not-done)
The event was terminated prior to any activity beyond preparation. I.e. The 'main' activity has not yet begun. The boundary between preparatory and the 'main' activity is context-specific. (Comment:en)
Item
Indicates the reason the immunization event was not performed
text
C0020971 (UMLS CUI [1,1])
C0449438 (UMLS CUI [1,2])
C0566251 (UMLS CUI [1,3])
Immunization.status
Code List
Indicates the reason the immunization event was not performed
CL Item
Completed (completed)
The event has now concluded. (Comment:en)
CL Item
Entered in Error (entered-in-error)
This electronic record should never have existed, though it is possible that real-world decisions were based on it. (If real-world activity has occurred, the status should be "cancelled" rather than "entered-in-error".). (Comment:en)
CL Item
Not Done (not-done)
The event was terminated prior to any activity beyond preparation. I.e. The 'main' activity has not yet begun. The boundary between preparatory and the 'main' activity is context-specific. (Comment:en)
Immunization.vaccineCode
Item
Vaccine that was administered or was to be administered
text
C0020971 (UMLS CUI [1,1])
C0042210 (UMLS CUI [1,2])
C0805701 (UMLS CUI [1,3])
Immunization.patient
Item
The patient who either received or did not receive the immunization
text
C0020971 (UMLS CUI [1,1])
C0030705 (UMLS CUI [1,2])
Immunization.encounter
Item
Encounter at which the immunization was performed
text
C0020971 (UMLS CUI [1,1])
C1947978 (UMLS CUI [1,2])
Immunization.occurrence[x]
Item
Date vaccine administered or was to be administered
datetime
C0020971 (UMLS CUI [1,1])
C1264639 (UMLS CUI [1,2])
Immunization.recorded
Item
The date the occurrence of the immunization was first captured in the record
datetime
C0020971 (UMLS CUI [1,1])
C3669169 (UMLS CUI [1,2])
Immunization.primarySource
Item
Indication that the content of the record is based on the information from the person who administered the vaccine
boolean
C0020971 (UMLS CUI [1,1])
C0205225 (UMLS CUI [1,2])
C0683836 (UMLS CUI [1,3])
Item
Source of the data when the report of the immunization event is not based on information from the person who administered the vaccine
text
C0020971 (UMLS CUI [1,1])
C0684224 (UMLS CUI [1,2])
C0011001 (UMLS CUI [1,3])
Immunization.reportOrigin
Code List
Source of the data when the report of the immunization event is not based on information from the person who administered the vaccine
CL Item
Other Provider (provider)
The data for the immunization event originated with another provider. (Comment:en)
CL Item
Written Record (record)
The data for the immunization event originated with a written record for the patient. (Comment:en)
CL Item
Parent/Guardian/Patient Recall (recall)
The data for the immunization event originated from the recollection of the patient or parent/guardian of the patient. (Comment:en)
CL Item
School Record (school)
The data for the immunization event originated with a school record for the patient. (Comment:en)
Item
The service delivery location where the vaccine administration occurred.
text
C0020971 (UMLS CUI [1,1])
C0450429 (UMLS CUI [1,2])
C1515974 (UMLS CUI [1,3])
Immunization.reportOrigin
Code List
The service delivery location where the vaccine administration occurred.
Immunization.manufacturer
Item
Name of vaccine manufacturer. Name of vaccine manufacturer. Name of vaccine manufacturer.
text
C0020971 (UMLS CUI [1,1])
C0947322 (UMLS CUI [1,2])
Immunization.lotNumber
Item
Lot number of the vaccine product.
text
C0020971 (UMLS CUI [1,1])
C1115660 (UMLS CUI [1,2])
Immunization.expirationDate
Item
Date vaccine batch expires.
date
C0020971 (UMLS CUI [1,1])
C3669020 (UMLS CUI [1,2])
C0042210 (UMLS CUI [1,3])
Item
Body site where vaccine was administered.
text
C0020971 (UMLS CUI [1,1])
C1515974 (UMLS CUI [1,2])
Immunization.site
Code List
Body site where vaccine was administered.
CL Item
Left arm (LA)
Left arm (Comment:en)
CL Item
Right arm (RA)
Right arm (Comment:en)
Item
The path by which the vaccine product is taken into the body.
text
C0020971 (UMLS CUI [1,1])
C0013153 (UMLS CUI [1,2])
Immunization.site
Code List
The path by which the vaccine product is taken into the body.
CL Item
Injection, intradermal  (IDINJ)
CL Item
Injection, intramuscular  (IM)
CL Item
Inhalation, nasal  (NASINHLC)
CL Item
Injection, intravenous  (IVINJ)
CL Item
Swallow, oral  (PO)
CL Item
SQ Injection, subcutaneous  (SQ Injection, subcutaneous )
CL Item
TRNSDERM Transdermal  (TRNSDERM Transdermal )
Item
The quantity of vaccine product that was administered.
text
C0020971 (UMLS CUI [1,1])
C0001555 (UMLS CUI [1,2])
C1265611 (UMLS CUI [1,3])
Immunization.site
Code List
The quantity of vaccine product that was administered.
CL Item
Injection, intradermal  (IDINJ)
CL Item
Injection, intramuscular  (IM)
CL Item
Inhalation, nasal  (NASINHLC)
CL Item
Injection, intravenous  (IVINJ)
CL Item
Swallow, oral  (PO)
CL Item
TRNSDERM  (TRNSDERM Transdermal )
CL Item
Injection, subcutaneous  (SQ)
Immunization.note
Item
Extra information about the immunization that is not conveyed by the other attributes.
text
C0020971 (UMLS CUI [1,1])
C1317574 (UMLS CUI [1,2])
Immunization.reasonCode
Item
Reasons why the vaccine was administered.
text
C0020971 (UMLS CUI [1,1])
C0566251 (UMLS CUI [1,2])
Immunization.reasonReference
Item
Condition, Observation or DiagnosticReport that supports why the immunization was administered.
text
C0020971 (UMLS CUI [1,1])
C0566251 (UMLS CUI [1,2])
C3244318 (UMLS CUI [1,3])
Immunization.isSubpotent
Item
Indication if a dose is considered to be subpotent
text
C0020971 (UMLS CUI [1,1])
C0178602 (UMLS CUI [1,2])
C2609410 (UMLS CUI [1,3])
Item
Reason why a dose is considered to be subpotent.
text
C0020971 (UMLS CUI [1,1])
C0178602 (UMLS CUI [1,2])
C2609410 (UMLS CUI [1,3])
Immunization.subpotentReason
Code List
Reason why a dose is considered to be subpotent.
CL Item
Partial Dose  (partial)
The full volume of the dose was not administered to the patient. (Comment:en)
CL Item
Cold Chain Break  (coldchainbreak)
The vaccine experienced a cold chain break. (Comment:en)
CL Item
Manufacturer Recall  (recall)
The vaccine was recalled by the manufacturer. (Comment:en)
Item
Indicates a patient's eligibility for a funding program.
text
C0020971 (UMLS CUI [1,1])
C4527252 (UMLS CUI [1,2])
C0243098 (UMLS CUI [1,3])
C2728259 (UMLS CUI [1,4])
Immunization.subpotentReason
Code List
Indicates a patient's eligibility for a funding program.
CL Item
Not Eligible  (ineligible)
The patient is not eligible for the funding program. (Comment:en)
CL Item
Uninsured  (uninsured)
The patient is eligible for the funding program because they are uninsured. (Comment:en)
Item
Indicates the source of the vaccine actually administered
text
C0020971 (UMLS CUI [1,1])
C0243098 (UMLS CUI [1,2])
C0449416 (UMLS CUI [1,3])
Immunization.subpotentReason
Code List
Indicates the source of the vaccine actually administered
CL Item
Private  (private)
The vaccine was purchased with private funds. (Comment:en)
CL Item
Public  (public)
The vaccine was purchased with public funds. (Comment:en)
Item Group
Immunization.performer
C0020971 (UMLS CUI-1)
C1550480 (UMLS CUI-2)
Item
Describes the type of performance (e.g. ordering provider, administering provider, etc.)
text
C0020971 (UMLS CUI [1,1])
C1550480 (UMLS CUI [1,2])
C0597198 (UMLS CUI [1,3])
C0332307 (UMLS CUI [1,4])
Immunization.performer.function
Code List
Describes the type of performance (e.g. ordering provider, administering provider, etc.)
CL Item
Ordering Provider (OP)
CL Item
Administering Provider  (AP)
Immunization.performer.actor
Item
The practitioner or organization who performed the action.
text
C0020971 (UMLS CUI [1,1])
C1550480 (UMLS CUI [1,2])
C0335083 (UMLS CUI [1,3])
Item Group
Immunization Education
C0020971 (UMLS CUI-1)
C4266536 (UMLS CUI-2)
C1514812 (UMLS CUI-3)
Immunization.education.documentType
Item
Identifier of the material presented to the patient.
text
C0020971 (UMLS CUI [1,1])
C4266536 (UMLS CUI [1,2])
C0600091 (UMLS CUI [1,3])
Immunization.education.reference
Item
Reference pointer to the educational material given to the patient
text
C0020971 (UMLS CUI [1,1])
C4266536 (UMLS CUI [1,2])
C1514812 (UMLS CUI [1,3])
Immunization.education.publicationDate
Item
Date the educational material was published.
datetime
C0020971 (UMLS CUI [1,1])
C4266536 (UMLS CUI [1,2])
C0034036 (UMLS CUI [1,3])
C0011008 (UMLS CUI [1,4])
Immunization.education.presentationDate
Item
Date the educational material was given to the patient.
datetime
C0020971 (UMLS CUI [1,1])
C4266536 (UMLS CUI [1,2])
C0449450 (UMLS CUI [1,3])
C0011008 (UMLS CUI [1,4])
Item Group
Immunization reaction
C0020971 (UMLS CUI-1)
C0443286 (UMLS CUI-2)
Immunization.reaction.date
Item
Date of reaction to the immunization
datetime
C0020971 (UMLS CUI [1,1])
C0011008 (UMLS CUI [1,2])
C0443286 (UMLS CUI [1,3])
Immunization.reaction.detail
Item
Details of the reaction.
text
C0020971 (UMLS CUI [1,1])
C1522508 (UMLS CUI [1,2])
C0443286 (UMLS CUI [1,3])
Immunization.reaction.reported
Item
Self-reported indicator.
boolean
C0020971 (UMLS CUI [1,1])
C0443286 (UMLS CUI [1,2])
C4319718 (UMLS CUI [1,3])
Item Group
Immunization.protocolApplied
C0020971 (UMLS CUI-1)
C0008971 (UMLS CUI-2)
C4048755 (UMLS CUI-3)
Immunization.protocolApplied.series
Item
One possible path to achieve presumed immunity against a disease
text
C0020971 (UMLS CUI [1,1])
C0008971 (UMLS CUI [1,2])
C4048755 (UMLS CUI [1,3])
C0205549 (UMLS CUI [1,4])
Immunization.protocolApplied.authority
Item
Indicates the authority who published the protocol that is being followed.
text
C0020971 (UMLS CUI [1,1])
C0008971 (UMLS CUI [1,2])
C4048755 (UMLS CUI [1,3])
C0599437 (UMLS CUI [1,4])
Immunization.protocolApplied.targetDisease
Item
The vaccine preventable disease the dose is being administered against.
text
C0020971 (UMLS CUI [1,1])
C0008971 (UMLS CUI [1,2])
C1521840 (UMLS CUI [1,3])
C0012634 (UMLS CUI [1,4])
Immunization.protocolApplied.doseNumber[x]
Item
Nominal position in a series.
text
C0020971 (UMLS CUI [1,1])
C0008971 (UMLS CUI [1,2])
C1115464 (UMLS CUI [1,3])
Immunization.protocolApplied.seriesDoses[x]
Item
The recommended number of doses to achieve immunity.
text
C0020971 (UMLS CUI [1,1])
C0008971 (UMLS CUI [1,2])
C0205549 (UMLS CUI [1,3])
C0678766 (UMLS CUI [1,4])
Back to the top of the page 

Contact

Please use this form for feedback, questions and suggestions for improvements.

Fields marked with * are required.

Help

Do you need help on how to use the search function? Please watch the corresponding tutorial video for more details and learn how to use the search function most efficiently.

Watch Tutorial