Immunization
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.
Columns
Header row
# |
path |
type |
required |
description |
0 |
resourceType |
string |
* |
Resource type identifier. Must be string "Immunization" |
1 |
|
integer |
* |
Number of subrows |
2 |
id |
string |
* |
Logical id of this artifact |
3 |
status |
code |
|
completed | entered-in-error | not-done |
|
statusReason |
CodeableConcept |
|
Reason not done |
|
statusReason.coding |
Coding |
|
Code defined by a terminology system |
4 |
statusReason.coding.system |
uri |
|
Identity of the terminology system |
5 |
statusReason.coding.version |
string |
|
Version of the system - if relevant |
6 |
statusReason.coding.code |
code |
|
Symbol in syntax defined by the system |
7 |
statusReason.coding.display |
string |
|
Representation defined by the system |
8 |
statusReason.coding.userSelected |
boolean |
|
If this coding was chosen directly by the user |
9 |
statusReason.text |
string |
|
Plain text representation of the concept |
|
vaccineCode |
CodeableConcept |
|
Vaccine product administered |
|
vaccineCode.coding |
Coding |
|
Code defined by a terminology system |
10 |
vaccineCode.coding.system |
uri |
|
Identity of the terminology system |
11 |
vaccineCode.coding.version |
string |
|
Version of the system - if relevant |
12 |
vaccineCode.coding.code |
code |
|
Symbol in syntax defined by the system |
13 |
vaccineCode.coding.display |
string |
|
Representation defined by the system |
14 |
vaccineCode.coding.userSelected |
boolean |
|
If this coding was chosen directly by the user |
15 |
vaccineCode.text |
string |
|
Plain text representation of the concept |
|
patient |
Reference |
|
Who was immunized |
16 |
patient.reference |
string |
|
Literal reference, Relative, internal or absolute URL |
17 |
patient.type |
uri |
|
Type the reference refers to (e.g. "Patient") |
|
patient.identifier |
Identifier |
|
Logical reference, when literal reference is not known |
18 |
patient.identifier.use |
code |
|
usual | official | temp | secondary | old (If known) |
|
patient.identifier.type |
CodeableConcept |
|
Description of identifier |
|
patient.identifier.type.coding |
Coding |
|
Code defined by a terminology system |
19 |
patient.identifier.type.coding.system |
uri |
|
Identity of the terminology system |
20 |
patient.identifier.type.coding.version |
string |
|
Version of the system - if relevant |
21 |
patient.identifier.type.coding.code |
code |
|
Symbol in syntax defined by the system |
22 |
patient.identifier.type.coding.display |
string |
|
Representation defined by the system |
23 |
patient.identifier.type.coding.userSelected |
boolean |
|
If this coding was chosen directly by the user |
24 |
patient.identifier.type.text |
string |
|
Plain text representation of the concept |
25 |
patient.identifier.system |
uri |
|
The namespace for the identifier value |
26 |
patient.identifier.value |
string |
|
The value that is unique |
|
patient.identifier.period |
Period |
|
Time period when id is/was valid for use |
27 |
patient.identifier.period.start |
dateTime |
|
Starting time with inclusive boundary |
28 |
patient.identifier.period.end |
dateTime |
|
End time with inclusive boundary, if not ongoing |
29 |
patient.display |
string |
|
Text alternative for the resource |
|
encounter |
Reference |
|
Encounter immunization was part of |
30 |
encounter.reference |
string |
|
Literal reference, Relative, internal or absolute URL |
31 |
encounter.type |
uri |
|
Type the reference refers to (e.g. "Patient") |
|
encounter.identifier |
Identifier |
|
Logical reference, when literal reference is not known |
32 |
encounter.identifier.use |
code |
|
usual | official | temp | secondary | old (If known) |
|
encounter.identifier.type |
CodeableConcept |
|
Description of identifier |
|
encounter.identifier.type.coding |
Coding |
|
Code defined by a terminology system |
33 |
encounter.identifier.type.coding.system |
uri |
|
Identity of the terminology system |
34 |
encounter.identifier.type.coding.version |
string |
|
Version of the system - if relevant |
35 |
encounter.identifier.type.coding.code |
code |
|
Symbol in syntax defined by the system |
36 |
encounter.identifier.type.coding.display |
string |
|
Representation defined by the system |
37 |
encounter.identifier.type.coding.userSelected |
boolean |
|
If this coding was chosen directly by the user |
38 |
encounter.identifier.type.text |
string |
|
Plain text representation of the concept |
39 |
encounter.identifier.system |
uri |
|
The namespace for the identifier value |
40 |
encounter.identifier.value |
string |
|
The value that is unique |
|
encounter.identifier.period |
Period |
|
Time period when id is/was valid for use |
41 |
encounter.identifier.period.start |
dateTime |
|
Starting time with inclusive boundary |
42 |
encounter.identifier.period.end |
dateTime |
|
End time with inclusive boundary, if not ongoing |
43 |
encounter.display |
string |
|
Text alternative for the resource |
|
occurrence[x] |
|
|
Vaccine administration date |
44 |
occurrenceDateTime |
dateTime |
|
|
45 |
occurrenceString |
string |
|
|
46 |
recorded |
dateTime |
|
When the immunization was first captured in the subject's record |
47 |
primarySource |
boolean |
|
Indicates context the data was recorded in |
|
reportOrigin |
CodeableConcept |
|
Indicates the source of a secondarily reported record |
|
reportOrigin.coding |
Coding |
|
Code defined by a terminology system |
48 |
reportOrigin.coding.system |
uri |
|
Identity of the terminology system |
49 |
reportOrigin.coding.version |
string |
|
Version of the system - if relevant |
50 |
reportOrigin.coding.code |
code |
|
Symbol in syntax defined by the system |
51 |
reportOrigin.coding.display |
string |
|
Representation defined by the system |
52 |
reportOrigin.coding.userSelected |
boolean |
|
If this coding was chosen directly by the user |
53 |
reportOrigin.text |
string |
|
Plain text representation of the concept |
|
location |
Reference |
|
Where immunization occurred |
54 |
location.reference |
string |
|
Literal reference, Relative, internal or absolute URL |
55 |
location.type |
uri |
|
Type the reference refers to (e.g. "Patient") |
|
location.identifier |
Identifier |
|
Logical reference, when literal reference is not known |
56 |
location.identifier.use |
code |
|
usual | official | temp | secondary | old (If known) |
|
location.identifier.type |
CodeableConcept |
|
Description of identifier |
|
location.identifier.type.coding |
Coding |
|
Code defined by a terminology system |
57 |
location.identifier.type.coding.system |
uri |
|
Identity of the terminology system |
58 |
location.identifier.type.coding.version |
string |
|
Version of the system - if relevant |
59 |
location.identifier.type.coding.code |
code |
|
Symbol in syntax defined by the system |
60 |
location.identifier.type.coding.display |
string |
|
Representation defined by the system |
61 |
location.identifier.type.coding.userSelected |
boolean |
|
If this coding was chosen directly by the user |
62 |
location.identifier.type.text |
string |
|
Plain text representation of the concept |
63 |
location.identifier.system |
uri |
|
The namespace for the identifier value |
64 |
location.identifier.value |
string |
|
The value that is unique |
|
location.identifier.period |
Period |
|
Time period when id is/was valid for use |
65 |
location.identifier.period.start |
dateTime |
|
Starting time with inclusive boundary |
66 |
location.identifier.period.end |
dateTime |
|
End time with inclusive boundary, if not ongoing |
67 |
location.display |
string |
|
Text alternative for the resource |
|
manufacturer |
Reference |
|
Vaccine manufacturer |
68 |
manufacturer.reference |
string |
|
Literal reference, Relative, internal or absolute URL |
69 |
manufacturer.type |
uri |
|
Type the reference refers to (e.g. "Patient") |
|
manufacturer.identifier |
Identifier |
|
Logical reference, when literal reference is not known |
70 |
manufacturer.identifier.use |
code |
|
usual | official | temp | secondary | old (If known) |
|
manufacturer.identifier.type |
CodeableConcept |
|
Description of identifier |
|
manufacturer.identifier.type.coding |
Coding |
|
Code defined by a terminology system |
71 |
manufacturer.identifier.type.coding.system |
uri |
|
Identity of the terminology system |
72 |
manufacturer.identifier.type.coding.version |
string |
|
Version of the system - if relevant |
73 |
manufacturer.identifier.type.coding.code |
code |
|
Symbol in syntax defined by the system |
74 |
manufacturer.identifier.type.coding.display |
string |
|
Representation defined by the system |
75 |
manufacturer.identifier.type.coding.userSelected |
boolean |
|
If this coding was chosen directly by the user |
76 |
manufacturer.identifier.type.text |
string |
|
Plain text representation of the concept |
77 |
manufacturer.identifier.system |
uri |
|
The namespace for the identifier value |
78 |
manufacturer.identifier.value |
string |
|
The value that is unique |
|
manufacturer.identifier.period |
Period |
|
Time period when id is/was valid for use |
79 |
manufacturer.identifier.period.start |
dateTime |
|
Starting time with inclusive boundary |
80 |
manufacturer.identifier.period.end |
dateTime |
|
End time with inclusive boundary, if not ongoing |
81 |
manufacturer.display |
string |
|
Text alternative for the resource |
82 |
lotNumber |
string |
|
Vaccine lot number |
83 |
expirationDate |
date |
|
Vaccine expiration date |
|
site |
CodeableConcept |
|
Body site vaccine was administered |
|
site.coding |
Coding |
|
Code defined by a terminology system |
84 |
site.coding.system |
uri |
|
Identity of the terminology system |
85 |
site.coding.version |
string |
|
Version of the system - if relevant |
86 |
site.coding.code |
code |
|
Symbol in syntax defined by the system |
87 |
site.coding.display |
string |
|
Representation defined by the system |
88 |
site.coding.userSelected |
boolean |
|
If this coding was chosen directly by the user |
89 |
site.text |
string |
|
Plain text representation of the concept |
|
route |
CodeableConcept |
|
How vaccine entered body |
|
route.coding |
Coding |
|
Code defined by a terminology system |
90 |
route.coding.system |
uri |
|
Identity of the terminology system |
91 |
route.coding.version |
string |
|
Version of the system - if relevant |
92 |
route.coding.code |
code |
|
Symbol in syntax defined by the system |
93 |
route.coding.display |
string |
|
Representation defined by the system |
94 |
route.coding.userSelected |
boolean |
|
If this coding was chosen directly by the user |
95 |
route.text |
string |
|
Plain text representation of the concept |
|
doseQuantity |
Quantity |
|
Amount of vaccine administered |
96 |
doseQuantity.value |
decimal |
|
Numerical value (with implicit precision) |
97 |
doseQuantity.unit |
string |
|
Unit representation |
98 |
doseQuantity.system |
uri |
|
System that defines coded unit form |
99 |
doseQuantity.code |
code |
|
Coded form of the unit |
100 |
isSubpotent |
boolean |
|
Dose potency |
|
fundingSource |
CodeableConcept |
|
Funding source for the vaccine |
|
fundingSource.coding |
Coding |
|
Code defined by a terminology system |
101 |
fundingSource.coding.system |
uri |
|
Identity of the terminology system |
102 |
fundingSource.coding.version |
string |
|
Version of the system - if relevant |
103 |
fundingSource.coding.code |
code |
|
Symbol in syntax defined by the system |
104 |
fundingSource.coding.display |
string |
|
Representation defined by the system |
105 |
fundingSource.coding.userSelected |
boolean |
|
If this coding was chosen directly by the user |
106 |
fundingSource.text |
string |
|
Plain text representation of the concept |
Row identifier
# |
path |
type |
required |
description |
0 |
|
string |
* |
Subrow identifier. Must be string "identifier" |
|
identifier |
Identifier |
|
Business identifier |
1 |
identifier.use |
code |
|
usual | official | temp | secondary | old (If known) |
|
identifier.type |
CodeableConcept |
|
Description of identifier |
|
identifier.type.coding |
Coding |
|
Code defined by a terminology system |
2 |
identifier.type.coding.system |
uri |
|
Identity of the terminology system |
3 |
identifier.type.coding.version |
string |
|
Version of the system - if relevant |
4 |
identifier.type.coding.code |
code |
|
Symbol in syntax defined by the system |
5 |
identifier.type.coding.display |
string |
|
Representation defined by the system |
6 |
identifier.type.coding.userSelected |
boolean |
|
If this coding was chosen directly by the user |
7 |
identifier.type.text |
string |
|
Plain text representation of the concept |
8 |
identifier.system |
uri |
|
The namespace for the identifier value |
9 |
identifier.value |
string |
|
The value that is unique |
|
identifier.period |
Period |
|
Time period when id is/was valid for use |
10 |
identifier.period.start |
dateTime |
|
Starting time with inclusive boundary |
11 |
identifier.period.end |
dateTime |
|
End time with inclusive boundary, if not ongoing |
Row performer
# |
path |
type |
required |
description |
0 |
|
string |
* |
Subrow identifier. Must be string "performer" |
|
performer |
|
|
Who performed event |
|
performer.function |
CodeableConcept |
|
What type of performance was done |
|
performer.function.coding |
Coding |
|
Code defined by a terminology system |
1 |
performer.function.coding.system |
uri |
|
Identity of the terminology system |
2 |
performer.function.coding.version |
string |
|
Version of the system - if relevant |
3 |
performer.function.coding.code |
code |
|
Symbol in syntax defined by the system |
4 |
performer.function.coding.display |
string |
|
Representation defined by the system |
5 |
performer.function.coding.userSelected |
boolean |
|
If this coding was chosen directly by the user |
6 |
performer.function.text |
string |
|
Plain text representation of the concept |
|
performer.actor |
Reference |
|
Individual or organization who was performing |
7 |
performer.actor.reference |
string |
|
Literal reference, Relative, internal or absolute URL |
8 |
performer.actor.type |
uri |
|
Type the reference refers to (e.g. "Patient") |
|
performer.actor.identifier |
Identifier |
|
Logical reference, when literal reference is not known |
9 |
performer.actor.identifier.use |
code |
|
usual | official | temp | secondary | old (If known) |
|
performer.actor.identifier.type |
CodeableConcept |
|
Description of identifier |
|
performer.actor.identifier.type.coding |
Coding |
|
Code defined by a terminology system |
10 |
performer.actor.identifier.type.coding.system |
uri |
|
Identity of the terminology system |
11 |
performer.actor.identifier.type.coding.version |
string |
|
Version of the system - if relevant |
12 |
performer.actor.identifier.type.coding.code |
code |
|
Symbol in syntax defined by the system |
13 |
performer.actor.identifier.type.coding.display |
string |
|
Representation defined by the system |
14 |
performer.actor.identifier.type.coding.userSelected |
boolean |
|
If this coding was chosen directly by the user |
15 |
performer.actor.identifier.type.text |
string |
|
Plain text representation of the concept |
16 |
performer.actor.identifier.system |
uri |
|
The namespace for the identifier value |
17 |
performer.actor.identifier.value |
string |
|
The value that is unique |
|
performer.actor.identifier.period |
Period |
|
Time period when id is/was valid for use |
18 |
performer.actor.identifier.period.start |
dateTime |
|
Starting time with inclusive boundary |
19 |
performer.actor.identifier.period.end |
dateTime |
|
End time with inclusive boundary, if not ongoing |
20 |
performer.actor.display |
string |
|
Text alternative for the resource |
Row note
# |
path |
type |
required |
description |
0 |
|
string |
* |
Subrow identifier. Must be string "note" |
|
note |
Annotation |
|
Additional immunization notes |
|
note.author[x] |
|
|
Individual responsible for the annotation |
|
note.authorReference |
Reference |
|
|
1 |
note.authorReference.reference |
string |
|
Literal reference, Relative, internal or absolute URL |
2 |
note.authorReference.type |
uri |
|
Type the reference refers to (e.g. "Patient") |
|
note.authorReference.identifier |
Identifier |
|
Logical reference, when literal reference is not known |
3 |
note.authorReference.identifier.use |
code |
|
usual | official | temp | secondary | old (If known) |
|
note.authorReference.identifier.type |
CodeableConcept |
|
Description of identifier |
|
note.authorReference.identifier.type.coding |
Coding |
|
Code defined by a terminology system |
4 |
note.authorReference.identifier.type.coding.system |
uri |
|
Identity of the terminology system |
5 |
note.authorReference.identifier.type.coding.version |
string |
|
Version of the system - if relevant |
6 |
note.authorReference.identifier.type.coding.code |
code |
|
Symbol in syntax defined by the system |
7 |
note.authorReference.identifier.type.coding.display |
string |
|
Representation defined by the system |
8 |
note.authorReference.identifier.type.coding.userSelected |
boolean |
|
If this coding was chosen directly by the user |
9 |
note.authorReference.identifier.type.text |
string |
|
Plain text representation of the concept |
10 |
note.authorReference.identifier.system |
uri |
|
The namespace for the identifier value |
11 |
note.authorReference.identifier.value |
string |
|
The value that is unique |
|
note.authorReference.identifier.period |
Period |
|
Time period when id is/was valid for use |
12 |
note.authorReference.identifier.period.start |
dateTime |
|
Starting time with inclusive boundary |
13 |
note.authorReference.identifier.period.end |
dateTime |
|
End time with inclusive boundary, if not ongoing |
14 |
note.authorReference.display |
string |
|
Text alternative for the resource |
15 |
note.authorString |
string |
|
|
16 |
note.time |
dateTime |
|
When the annotation was made |
17 |
note.text |
markdown |
|
The annotation - text content (as markdown) |
Row reasonCode
# |
path |
type |
required |
description |
0 |
|
string |
* |
Subrow identifier. Must be string "reasonCode" |
|
reasonCode |
CodeableConcept |
|
Why immunization occurred |
|
reasonCode.coding |
Coding |
|
Code defined by a terminology system |
1 |
reasonCode.coding.system |
uri |
|
Identity of the terminology system |
2 |
reasonCode.coding.version |
string |
|
Version of the system - if relevant |
3 |
reasonCode.coding.code |
code |
|
Symbol in syntax defined by the system |
4 |
reasonCode.coding.display |
string |
|
Representation defined by the system |
5 |
reasonCode.coding.userSelected |
boolean |
|
If this coding was chosen directly by the user |
6 |
reasonCode.text |
string |
|
Plain text representation of the concept |
Row reasonReference
# |
path |
type |
required |
description |
0 |
|
string |
* |
Subrow identifier. Must be string "reasonReference" |
|
reasonReference |
Reference |
|
Why immunization occurred |
1 |
reasonReference.reference |
string |
|
Literal reference, Relative, internal or absolute URL |
2 |
reasonReference.type |
uri |
|
Type the reference refers to (e.g. "Patient") |
|
reasonReference.identifier |
Identifier |
|
Logical reference, when literal reference is not known |
3 |
reasonReference.identifier.use |
code |
|
usual | official | temp | secondary | old (If known) |
|
reasonReference.identifier.type |
CodeableConcept |
|
Description of identifier |
|
reasonReference.identifier.type.coding |
Coding |
|
Code defined by a terminology system |
4 |
reasonReference.identifier.type.coding.system |
uri |
|
Identity of the terminology system |
5 |
reasonReference.identifier.type.coding.version |
string |
|
Version of the system - if relevant |
6 |
reasonReference.identifier.type.coding.code |
code |
|
Symbol in syntax defined by the system |
7 |
reasonReference.identifier.type.coding.display |
string |
|
Representation defined by the system |
8 |
reasonReference.identifier.type.coding.userSelected |
boolean |
|
If this coding was chosen directly by the user |
9 |
reasonReference.identifier.type.text |
string |
|
Plain text representation of the concept |
10 |
reasonReference.identifier.system |
uri |
|
The namespace for the identifier value |
11 |
reasonReference.identifier.value |
string |
|
The value that is unique |
|
reasonReference.identifier.period |
Period |
|
Time period when id is/was valid for use |
12 |
reasonReference.identifier.period.start |
dateTime |
|
Starting time with inclusive boundary |
13 |
reasonReference.identifier.period.end |
dateTime |
|
End time with inclusive boundary, if not ongoing |
14 |
reasonReference.display |
string |
|
Text alternative for the resource |
Row subpotentReason
# |
path |
type |
required |
description |
0 |
|
string |
* |
Subrow identifier. Must be string "subpotentReason" |
|
subpotentReason |
CodeableConcept |
|
Reason for being subpotent |
|
subpotentReason.coding |
Coding |
|
Code defined by a terminology system |
1 |
subpotentReason.coding.system |
uri |
|
Identity of the terminology system |
2 |
subpotentReason.coding.version |
string |
|
Version of the system - if relevant |
3 |
subpotentReason.coding.code |
code |
|
Symbol in syntax defined by the system |
4 |
subpotentReason.coding.display |
string |
|
Representation defined by the system |
5 |
subpotentReason.coding.userSelected |
boolean |
|
If this coding was chosen directly by the user |
6 |
subpotentReason.text |
string |
|
Plain text representation of the concept |
Row education
# |
path |
type |
required |
description |
0 |
|
string |
* |
Subrow identifier. Must be string "education" |
|
education |
|
|
Educational material presented to patient |
1 |
education.documentType |
string |
|
Educational material document identifier |
2 |
education.reference |
uri |
|
Educational material reference pointer |
3 |
education.publicationDate |
dateTime |
|
Educational material publication date |
4 |
education.presentationDate |
dateTime |
|
Educational material presentation date |
Row programEligibility
# |
path |
type |
required |
description |
0 |
|
string |
* |
Subrow identifier. Must be string "programEligibility" |
|
programEligibility |
CodeableConcept |
|
Patient eligibility for a vaccination program |
|
programEligibility.coding |
Coding |
|
Code defined by a terminology system |
1 |
programEligibility.coding.system |
uri |
|
Identity of the terminology system |
2 |
programEligibility.coding.version |
string |
|
Version of the system - if relevant |
3 |
programEligibility.coding.code |
code |
|
Symbol in syntax defined by the system |
4 |
programEligibility.coding.display |
string |
|
Representation defined by the system |
5 |
programEligibility.coding.userSelected |
boolean |
|
If this coding was chosen directly by the user |
6 |
programEligibility.text |
string |
|
Plain text representation of the concept |
Row reaction
# |
path |
type |
required |
description |
0 |
|
string |
* |
Subrow identifier. Must be string "reaction" |
|
reaction |
|
|
Details of a reaction that follows immunization |
1 |
reaction.date |
dateTime |
|
When reaction started |
|
reaction.detail |
Reference |
|
Additional information on reaction |
2 |
reaction.detail.reference |
string |
|
Literal reference, Relative, internal or absolute URL |
3 |
reaction.detail.type |
uri |
|
Type the reference refers to (e.g. "Patient") |
|
reaction.detail.identifier |
Identifier |
|
Logical reference, when literal reference is not known |
4 |
reaction.detail.identifier.use |
code |
|
usual | official | temp | secondary | old (If known) |
|
reaction.detail.identifier.type |
CodeableConcept |
|
Description of identifier |
|
reaction.detail.identifier.type.coding |
Coding |
|
Code defined by a terminology system |
5 |
reaction.detail.identifier.type.coding.system |
uri |
|
Identity of the terminology system |
6 |
reaction.detail.identifier.type.coding.version |
string |
|
Version of the system - if relevant |
7 |
reaction.detail.identifier.type.coding.code |
code |
|
Symbol in syntax defined by the system |
8 |
reaction.detail.identifier.type.coding.display |
string |
|
Representation defined by the system |
9 |
reaction.detail.identifier.type.coding.userSelected |
boolean |
|
If this coding was chosen directly by the user |
10 |
reaction.detail.identifier.type.text |
string |
|
Plain text representation of the concept |
11 |
reaction.detail.identifier.system |
uri |
|
The namespace for the identifier value |
12 |
reaction.detail.identifier.value |
string |
|
The value that is unique |
|
reaction.detail.identifier.period |
Period |
|
Time period when id is/was valid for use |
13 |
reaction.detail.identifier.period.start |
dateTime |
|
Starting time with inclusive boundary |
14 |
reaction.detail.identifier.period.end |
dateTime |
|
End time with inclusive boundary, if not ongoing |
15 |
reaction.detail.display |
string |
|
Text alternative for the resource |
16 |
reaction.reported |
boolean |
|
Indicates self-reported reaction |
Row protocolApplied
# |
path |
type |
required |
description |
0 |
|
string |
* |
Subrow identifier. Must be string "protocolApplied" |
|
protocolApplied |
|
|
Protocol followed by the provider |
1 |
protocolApplied.series |
string |
|
Name of vaccine series |
|
protocolApplied.authority |
Reference |
|
Who is responsible for publishing the recommendations |
2 |
protocolApplied.authority.reference |
string |
|
Literal reference, Relative, internal or absolute URL |
3 |
protocolApplied.authority.type |
uri |
|
Type the reference refers to (e.g. "Patient") |
|
protocolApplied.authority.identifier |
Identifier |
|
Logical reference, when literal reference is not known |
4 |
protocolApplied.authority.identifier.use |
code |
|
usual | official | temp | secondary | old (If known) |
|
protocolApplied.authority.identifier.type |
CodeableConcept |
|
Description of identifier |
|
protocolApplied.authority.identifier.type.coding |
Coding |
|
Code defined by a terminology system |
5 |
protocolApplied.authority.identifier.type.coding.system |
uri |
|
Identity of the terminology system |
6 |
protocolApplied.authority.identifier.type.coding.version |
string |
|
Version of the system - if relevant |
7 |
protocolApplied.authority.identifier.type.coding.code |
code |
|
Symbol in syntax defined by the system |
8 |
protocolApplied.authority.identifier.type.coding.display |
string |
|
Representation defined by the system |
9 |
protocolApplied.authority.identifier.type.coding.userSelected |
boolean |
|
If this coding was chosen directly by the user |
10 |
protocolApplied.authority.identifier.type.text |
string |
|
Plain text representation of the concept |
11 |
protocolApplied.authority.identifier.system |
uri |
|
The namespace for the identifier value |
12 |
protocolApplied.authority.identifier.value |
string |
|
The value that is unique |
|
protocolApplied.authority.identifier.period |
Period |
|
Time period when id is/was valid for use |
13 |
protocolApplied.authority.identifier.period.start |
dateTime |
|
Starting time with inclusive boundary |
14 |
protocolApplied.authority.identifier.period.end |
dateTime |
|
End time with inclusive boundary, if not ongoing |
15 |
protocolApplied.authority.display |
string |
|
Text alternative for the resource |
|
protocolApplied.targetDisease |
CodeableConcept |
|
Vaccine preventatable disease being targetted |
|
protocolApplied.targetDisease.coding |
Coding |
|
Code defined by a terminology system |
16 |
protocolApplied.targetDisease.coding.system |
uri |
|
Identity of the terminology system |
17 |
protocolApplied.targetDisease.coding.version |
string |
|
Version of the system - if relevant |
18 |
protocolApplied.targetDisease.coding.code |
code |
|
Symbol in syntax defined by the system |
19 |
protocolApplied.targetDisease.coding.display |
string |
|
Representation defined by the system |
20 |
protocolApplied.targetDisease.coding.userSelected |
boolean |
|
If this coding was chosen directly by the user |
21 |
protocolApplied.targetDisease.text |
string |
|
Plain text representation of the concept |
|
protocolApplied.doseNumber[x] |
|
|
Dose number within series |
22 |
protocolApplied.doseNumberPositiveInt |
positiveInt |
|
|
23 |
protocolApplied.doseNumberString |
string |
|
|
|
protocolApplied.seriesDoses[x] |
|
|
Recommended number of doses for immunity |
24 |
protocolApplied.seriesDosesPositiveInt |
positiveInt |
|
|
25 |
protocolApplied.seriesDosesString |
string |
|
|
Examples
Example #1
Input CSV
Immunization,2,"historical","completed",,,,,,,"urn:oid:1.2.36.1.2001.1005.17",,"GNFLU",,,"Influenza","Patient/example",,,,,,,,,,,,,,,,,,,,,,,,,,,,,"January 2012",,false,"http://terminology.hl7.org/CodeSystem/immunization-origin",,"record",,,"Written Record","Location/1",,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
identifier,,,,,,,,"urn:ietf:rfc:3986","urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234",,
note,,,,,,,,,,,,,,,,,"Notes on adminstration of a historical vaccine"
Resulting resource
{
"resourceType": "Immunization",
"id": "historical",
"identifier": [
{
"system": "urn:ietf:rfc:3986",
"value": "urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234"
}
],
"status": "completed",
"vaccineCode": {
"coding": [
{
"system": "urn:oid:1.2.36.1.2001.1005.17",
"code": "GNFLU"
}
],
"text": "Influenza"
},
"patient": {
"reference": "Patient/example"
},
"occurrenceString": "January 2012",
"primarySource": false,
"reportOrigin": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/immunization-origin",
"code": "record"
}
],
"text": "Written Record"
},
"location": {
"reference": "Location/1"
},
"note": [
{
"text": "Notes on adminstration of a historical vaccine"
}
]
}
Example #2
Input CSV
Immunization,7,"example","completed",,,,,,,"urn:oid:1.2.36.1.2001.1005.17",,"FLUVAX",,,"Fluvax (Influenza)","Patient/example",,,,,,,,,,,,,,"Encounter/example",,,,,,,,,,,,,,"2013-01-10",,,true,,,,,,,"Location/1",,,,,,,,,,,,,,"Organization/hl7",,,,,,,,,,,,,,"AAJN11K","2015-02-15","http://terminology.hl7.org/CodeSystem/v3-ActSite",,"LA","left arm",,,"http://terminology.hl7.org/CodeSystem/v3-RouteOfAdministration",,"IM","Injection, intramuscular",,,5,,"http://unitsofmeasure.org","mg",true,"http://terminology.hl7.org/CodeSystem/immunization-funding-source",,"private",,,
identifier,,,,,,,,"urn:ietf:rfc:3986","urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234",,
performer,"http://terminology.hl7.org/CodeSystem/v2-0443",,"OP",,,,"Practitioner/example",,,,,,,,,,,,,
performer,"http://terminology.hl7.org/CodeSystem/v2-0443",,"AP",,,,"Practitioner/example",,,,,,,,,,,,,
note,,,,,,,,,,,,,,,,,"Notes on adminstration of vaccine"
reasonCode,"http://snomed.info/sct",,"429060002",,,
education,"253088698300010311120702",,"2012-07-02","2013-01-10"
programEligibility,"http://terminology.hl7.org/CodeSystem/immunization-program-eligibility",,"ineligible",,,
Resulting resource
{
"resourceType": "Immunization",
"id": "example",
"identifier": [
{
"system": "urn:ietf:rfc:3986",
"value": "urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234"
}
],
"status": "completed",
"vaccineCode": {
"coding": [
{
"system": "urn:oid:1.2.36.1.2001.1005.17",
"code": "FLUVAX"
}
],
"text": "Fluvax (Influenza)"
},
"patient": {
"reference": "Patient/example"
},
"encounter": {
"reference": "Encounter/example"
},
"occurrenceDateTime": "2013-01-10",
"primarySource": true,
"location": {
"reference": "Location/1"
},
"manufacturer": {
"reference": "Organization/hl7"
},
"lotNumber": "AAJN11K",
"expirationDate": "2015-02-15",
"site": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ActSite",
"code": "LA",
"display": "left arm"
}
]
},
"route": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-RouteOfAdministration",
"code": "IM",
"display": "Injection, intramuscular"
}
]
},
"doseQuantity": {
"value": 5,
"system": "http://unitsofmeasure.org",
"code": "mg"
},
"performer": [
{
"function": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0443",
"code": "OP"
}
]
},
"actor": {
"reference": "Practitioner/example"
}
},
{
"function": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0443",
"code": "AP"
}
]
},
"actor": {
"reference": "Practitioner/example"
}
}
],
"note": [
{
"text": "Notes on adminstration of vaccine"
}
],
"reasonCode": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "429060002"
}
]
}
],
"isSubpotent": true,
"education": [
{
"documentType": "253088698300010311120702",
"publicationDate": "2012-07-02",
"presentationDate": "2013-01-10"
}
],
"programEligibility": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/immunization-program-eligibility",
"code": "ineligible"
}
]
}
],
"fundingSource": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/immunization-funding-source",
"code": "private"
}
]
}
}
Example #3
Input CSV
Immunization,6,"protocol","completed",,,,,,,"http://hl7.org/fhir/sid/cvx",,"104",,,"Twinrix (HepA/HepB)","Patient/example",,,,,,,,,,,,,,"Encounter/example",,,,,,,,,,,,,,"2018-06-18",,,true,,,,,,,"Location/1",,,,,,,,,,,,,,"Organization/hl7",,,,,,,,,,,,,,"PT123F","2018-12-15","http://terminology.hl7.org/CodeSystem/v3-ActSite",,"LA","left arm",,,"http://terminology.hl7.org/CodeSystem/v3-RouteOfAdministration",,"IM","Injection, intramuscular",,,5,,"http://unitsofmeasure.org","mg",false,"http://terminology.hl7.org/CodeSystem/immunization-funding-source",,"private",,,
identifier,,,,,,,,"urn:ietf:rfc:3986","urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234",,
performer,"http://terminology.hl7.org/CodeSystem/v2-0443",,"OP",,,,"Practitioner/example",,,,,,,,,,,,,
performer,"http://terminology.hl7.org/CodeSystem/v2-0443",,"AP",,,,"Practitioner/example",,,,,,,,,,,,,
programEligibility,"http://terminology.hl7.org/CodeSystem/immunization-program-eligibility",,"ineligible",,,
protocolApplied,"2-dose",,,,,,,,,,,,,,,"http://snomed.info/sct",,"40468003",,,,1,,,
protocolApplied,"3-dose",,,,,,,,,,,,,,,"http://snomed.info/sct",,"66071002",,,,2,,,
Resulting resource
{
"resourceType": "Immunization",
"id": "protocol",
"identifier": [
{
"system": "urn:ietf:rfc:3986",
"value": "urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234"
}
],
"status": "completed",
"vaccineCode": {
"coding": [
{
"system": "http://hl7.org/fhir/sid/cvx",
"code": "104"
}
],
"text": "Twinrix (HepA/HepB)"
},
"patient": {
"reference": "Patient/example"
},
"encounter": {
"reference": "Encounter/example"
},
"occurrenceDateTime": "2018-06-18",
"primarySource": true,
"location": {
"reference": "Location/1"
},
"manufacturer": {
"reference": "Organization/hl7"
},
"lotNumber": "PT123F",
"expirationDate": "2018-12-15",
"site": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ActSite",
"code": "LA",
"display": "left arm"
}
]
},
"route": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-RouteOfAdministration",
"code": "IM",
"display": "Injection, intramuscular"
}
]
},
"doseQuantity": {
"value": 5,
"system": "http://unitsofmeasure.org",
"code": "mg"
},
"performer": [
{
"function": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0443",
"code": "OP"
}
]
},
"actor": {
"reference": "Practitioner/example"
}
},
{
"function": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0443",
"code": "AP"
}
]
},
"actor": {
"reference": "Practitioner/example"
}
}
],
"isSubpotent": false,
"programEligibility": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/immunization-program-eligibility",
"code": "ineligible"
}
]
}
],
"fundingSource": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/immunization-funding-source",
"code": "private"
}
]
},
"protocolApplied": [
{
"series": "2-dose",
"targetDisease": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "40468003"
}
]
}
],
"doseNumberPositiveInt": 1
},
{
"series": "3-dose",
"targetDisease": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "66071002"
}
]
}
],
"doseNumberPositiveInt": 2
}
]
}
Example #4
Input CSV
Immunization,0,"notGiven","not-done","http://terminology.hl7.org/CodeSystem/v3-ActReason",,"MEDPREC","medical precaution",,,"http://hl7.org/fhir/sid/cvx",,"01","DTP",,,"Patient/example",,,,,,,,,,,,,,,,,,,,,,,,,,,,"2013-01-10",,,true,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
Resulting resource
{
"resourceType": "Immunization",
"id": "notGiven",
"status": "not-done",
"statusReason": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ActReason",
"code": "MEDPREC",
"display": "medical precaution"
}
]
},
"vaccineCode": {
"coding": [
{
"system": "http://hl7.org/fhir/sid/cvx",
"code": "01",
"display": "DTP"
}
]
},
"patient": {
"reference": "Patient/example"
},
"occurrenceDateTime": "2013-01-10",
"primarySource": true
}
Example #5
Input CSV
Immunization,7,"subpotent","completed",,,,,,,"urn:oid:1.2.36.1.2001.1005.17",,"GNHEP",,,"Hepatitis B","Patient/example",,,,,,,,,,,,,,"Encounter/example",,,,,,,,,,,,,,"2015-01-15",,,true,,,,,,,"Location/1",,,,,,,,,,,,,,"Organization/hl7",,,,,,,,,,,,,,"AAJN11K","2015-02-28","http://terminology.hl7.org/CodeSystem/v3-ActSite",,"LT","left thigh",,,"http://terminology.hl7.org/CodeSystem/v3-RouteOfAdministration",,"IM","Injection, intramuscular",,,0.5,,"http://unitsofmeasure.org","ml",false,"http://terminology.hl7.org/CodeSystem/immunization-funding-source",,"private",,,
identifier,,,,,,,,"urn:ietf:rfc:3986","urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234",,
performer,"http://terminology.hl7.org/CodeSystem/v2-0443",,"OP",,,,"Practitioner/example",,,,,,,,,,,,,
performer,"http://terminology.hl7.org/CodeSystem/v2-0443",,"AP",,,,"Practitioner/example",,,,,,,,,,,,,
note,,,,,,,,,,,,,,,,,"Notes on adminstration of vaccine"
subpotentReason,"http://terminology.hl7.org/CodeSystem/immunization-subpotent-reason",,"partial",,,
education,"253088698300010311120702",,"2012-07-02","2013-01-10"
programEligibility,"http://terminology.hl7.org/CodeSystem/immunization-program-eligibility",,"ineligible",,,
Resulting resource
{
"resourceType": "Immunization",
"id": "subpotent",
"identifier": [
{
"system": "urn:ietf:rfc:3986",
"value": "urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234"
}
],
"status": "completed",
"vaccineCode": {
"coding": [
{
"system": "urn:oid:1.2.36.1.2001.1005.17",
"code": "GNHEP"
}
],
"text": "Hepatitis B"
},
"patient": {
"reference": "Patient/example"
},
"encounter": {
"reference": "Encounter/example"
},
"occurrenceDateTime": "2015-01-15",
"primarySource": true,
"location": {
"reference": "Location/1"
},
"manufacturer": {
"reference": "Organization/hl7"
},
"lotNumber": "AAJN11K",
"expirationDate": "2015-02-28",
"site": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ActSite",
"code": "LT",
"display": "left thigh"
}
]
},
"route": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-RouteOfAdministration",
"code": "IM",
"display": "Injection, intramuscular"
}
]
},
"doseQuantity": {
"value": 0.5,
"system": "http://unitsofmeasure.org",
"code": "ml"
},
"performer": [
{
"function": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0443",
"code": "OP"
}
]
},
"actor": {
"reference": "Practitioner/example"
}
},
{
"function": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0443",
"code": "AP"
}
]
},
"actor": {
"reference": "Practitioner/example"
}
}
],
"note": [
{
"text": "Notes on adminstration of vaccine"
}
],
"isSubpotent": false,
"subpotentReason": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/immunization-subpotent-reason",
"code": "partial"
}
]
}
],
"education": [
{
"documentType": "253088698300010311120702",
"publicationDate": "2012-07-02",
"presentationDate": "2013-01-10"
}
],
"programEligibility": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/immunization-program-eligibility",
"code": "ineligible"
}
]
}
],
"fundingSource": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/immunization-funding-source",
"code": "private"
}
]
}
}