ID

39907

Description

The form corresponds to an incomplete version of FHIR Resource Immunization, v4.0.1. It contains all data elements that query a medical issue. The file was created for analysis purposes. https://www.hl7.org/fhir/resourcelist.html 28.11.2019

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.1

English

Resource Immunization (3)

1 forms  
Immunization
Description

Immunization

Alias
UMLS CUI-1
C0020971
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
UMLS CUI [1,3]
C0445106
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
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
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
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
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]
C0566251
UMLS CUI [1,2]
C0020971
UMLS CUI [1,3]
C0178602
UMLS CUI [1,4]
C2609410
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]
C0877248
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]
C0877248
Self-reported indicator.
Description

Immunization.reaction.reported

Data type

boolean

Alias
UMLS CUI [1,1]
C0020971
UMLS CUI [1,2]
C0877248
UMLS CUI [1,3]
C2700446
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]
C5197682
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]
C5190418
UMLS CUI [1,4]
C0034866
Back to the top of the page

Similar models

Resource Immunization (3)

1 forms
Name
Type
Description | Question | Decode (Coded Value)
Data type
Alias
Item Group
Immunization
C0020971 (UMLS CUI-1)
Item
Indicates the current status of the immunization event
text
C0020971 (UMLS CUI [1,1])
C0449438 (UMLS CUI [1,2])
C0445106 (UMLS CUI [1,3])
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.occurrence[x]
Item
Date vaccine administered or was to be administered
datetime
C0020971 (UMLS CUI [1,1])
C1264639 (UMLS CUI [1,2])
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.reasonCode
Item
Reasons why the vaccine was administered.
text
C0020971 (UMLS CUI [1,1])
C0566251 (UMLS CUI [1,2])
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
C0566251 (UMLS CUI [1,1])
C0020971 (UMLS CUI [1,2])
C0178602 (UMLS CUI [1,3])
C2609410 (UMLS CUI [1,4])
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)
Immunization.reaction.date
Item
Date of reaction to the immunization
datetime
C0020971 (UMLS CUI [1,1])
C0011008 (UMLS CUI [1,2])
C0877248 (UMLS CUI [1,3])
Immunization.reaction.detail
Item
Details of the reaction.
text
C0020971 (UMLS CUI [1,1])
C1522508 (UMLS CUI [1,2])
C0877248 (UMLS CUI [1,3])
Immunization.reaction.reported
Item
Self-reported indicator.
boolean
C0020971 (UMLS CUI [1,1])
C0877248 (UMLS CUI [1,2])
C2700446 (UMLS CUI [1,3])
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])
C5197682 (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])
C5190418 (UMLS CUI [1,3])
C0034866 (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