Introduction

This profile is used to represent de-identified Immunization information. The de-identification process has to remove all data elements not explicitly identified as "SUPPORTED" in the profile.

The HHS De-identification Guidance is to be followed to ensure appropriate level of de-identification is performed.

According to the HHS guidance, dates should not have a precision of more than the year. This means month and day cannot be included. This includes Immunization.occurenceDateTime.

In FHIR Resources, text elements and reference.display elements which provide human readable information to the providers may be generated using programs and tools from the data present within the resource. For e.g a Immunization resource text element may contain information such as the Immunization date, patient information. This type of information will enable identification of the individuals. In order to avoid inadvertent revealing of PII/PHI, text elements cannot be included in the De-identified FHIR resource and the submission will be rejected when text elements are present by the validation process.

Ids and References

The original Immunization resource id should not be included in the De-identified Immunization instance. Instead a new id should be created and provided as part of the FHIR resource. The Data Submitter should be capable of using the generated id to relink the data to the original Immunization. All resource references to the Immunization submitted as part of the UDS+ report should refer to newly generated id.

Resource references cannot contain text element as it may contain PHI/PII. The text element for following references are not allowed

• patient

Date Truncation

The Data Submitter has to truncate the following dates to only have a precision of year

• occurence[x]
• recorded

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from Immunization

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	Immunization	De-Identified UDS Plus Immunization
id	S	0..1	id	The de-identified Immunization identifier created by the health center to send data to UDS+ Data Receiver
text		0..0
contained		0..0
status	S	1..1	code	completed | entered-in-error | not-done
statusReason	S	0..1	CodeableConcept	Reason not done
vaccineCode	S	1..1	CodeableConcept	Vaccine product administered
patient	S	1..1	Reference(De-Identified UDS Plus Patient)	Who was immunized
display		0..0
occurrence[x]	SC	1..1	dateTime	Vaccine administration date uds-plus-imm-1: All dateTime data elements should be truncated to a year only for de-identified resources.
recorded	SC	0..1	dateTime	When the immunization was first captured in the subject's record uds-plus-iimm-2: All dateTime data elements should be truncated to a year only for de-identified resources.
primarySource	S	1..1	boolean	Indicates context the data was recorded in
expirationDate	C	0..1	date	Vaccine expiration date uds-plus-iimm-3: All date data elements should be truncated to a year only for de-identified resources.
note		0..0
reaction
date	C	0..1	dateTime	When reaction started uds-plus-iimm-4: All dateTime data elements should be truncated to a year only for de-identified resources.
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
uds-plus-iimm-2	error	Immunization.recorded	All dateTime data elements should be truncated to a year only for de-identified resources. : $this is DateTime implies $this.toString().length() = 4
uds-plus-iimm-3	error	Immunization.expirationDate	All date data elements should be truncated to a year only for de-identified resources. : $this is date implies $this.toString().length() = 4
uds-plus-iimm-4	error	Immunization.reaction.date	All dateTime data elements should be truncated to a year only for de-identified resources. : $this is dateTime implies $this.toString().length() = 4
uds-plus-imm-1	error	Immunization.occurrence[x]	All dateTime data elements should be truncated to a year only for de-identified resources. : $this is DateTime implies $this.toString().length() = 4

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	Immunization	De-Identified UDS Plus Immunization
id	SΣ	0..1	id	The de-identified Immunization identifier created by the health center to send data to UDS+ Data Receiver
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!SΣ	1..1	code	completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
statusReason	S	0..1	CodeableConcept	Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
vaccineCode	SΣ	1..1	CodeableConcept	Vaccine product administered Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.
patient	SΣ	1..1	Reference(De-Identified UDS Plus Patient)	Who was immunized
occurrence[x]	SΣC	1..1	dateTime	Vaccine administration date uds-plus-imm-1: All dateTime data elements should be truncated to a year only for de-identified resources.
recorded	SC	0..1	dateTime	When the immunization was first captured in the subject's record uds-plus-iimm-2: All dateTime data elements should be truncated to a year only for de-identified resources.
primarySource	SΣ	1..1	boolean	Indicates context the data was recorded in
expirationDate	C	0..1	date	Vaccine expiration date uds-plus-iimm-3: All date data elements should be truncated to a year only for de-identified resources.
isSubpotent	?!Σ	0..1	boolean	Dose potency
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Immunization.status	required	ImmunizationStatusCodes http://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard
Immunization.statusReason	example	ImmunizationStatusReasonCodes http://hl7.org/fhir/ValueSet/immunization-status-reason from the FHIR Standard
Immunization.vaccineCode	example	VaccineAdministeredValueSet http://hl7.org/fhir/ValueSet/vaccine-code from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Immunization	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Immunization	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Immunization	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Immunization	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Immunization	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
uds-plus-iimm-2	error	Immunization.recorded	All dateTime data elements should be truncated to a year only for de-identified resources. : $this is DateTime implies $this.toString().length() = 4
uds-plus-iimm-3	error	Immunization.expirationDate	All date data elements should be truncated to a year only for de-identified resources. : $this is date implies $this.toString().length() = 4
uds-plus-imm-1	error	Immunization.occurrence[x]	All dateTime data elements should be truncated to a year only for de-identified resources. : $this is DateTime implies $this.toString().length() = 4

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	Immunization	De-Identified UDS Plus Immunization
id	SΣ	0..1	id	The de-identified Immunization identifier created by the health center to send data to UDS+ Data Receiver
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier		0..*	Identifier	Business identifier
status	?!SΣ	1..1	code	completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
statusReason	S	0..1	CodeableConcept	Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
vaccineCode	SΣ	1..1	CodeableConcept	Vaccine product administered Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.
patient	SΣ	1..1	Reference(De-Identified UDS Plus Patient)	Who was immunized
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
encounter		0..1	Reference(Encounter)	Encounter immunization was part of
occurrence[x]	SΣC	1..1	dateTime	Vaccine administration date uds-plus-imm-1: All dateTime data elements should be truncated to a year only for de-identified resources.
recorded	SC	0..1	dateTime	When the immunization was first captured in the subject's record uds-plus-iimm-2: All dateTime data elements should be truncated to a year only for de-identified resources.
primarySource	SΣ	1..1	boolean	Indicates context the data was recorded in
reportOrigin		0..1	CodeableConcept	Indicates the source of a secondarily reported record Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source.
location		0..1	Reference(Location)	Where immunization occurred
manufacturer		0..1	Reference(Organization)	Vaccine manufacturer
lotNumber		0..1	string	Vaccine lot number
expirationDate	C	0..1	date	Vaccine expiration date uds-plus-iimm-3: All date data elements should be truncated to a year only for de-identified resources.
site		0..1	CodeableConcept	Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.
route		0..1	CodeableConcept	How vaccine entered body Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered.
doseQuantity		0..1	SimpleQuantity	Amount of vaccine administered
performer	Σ	0..*	BackboneElement	Who performed event
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
function	Σ	0..1	CodeableConcept	What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.
actor	Σ	1..1	Reference(Practitioner | PractitionerRole | Organization)	Individual or organization who was performing
reasonCode		0..*	CodeableConcept	Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.
reasonReference		0..*	Reference(Condition | Observation | DiagnosticReport)	Why immunization occurred
isSubpotent	?!Σ	0..1	boolean	Dose potency
subpotentReason		0..*	CodeableConcept	Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.
education	C	0..*	BackboneElement	Educational material presented to patient imm-1: One of documentType or reference SHALL be present
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
documentType		0..1	string	Educational material document identifier
reference		0..1	uri	Educational material reference pointer
publicationDate		0..1	dateTime	Educational material publication date
presentationDate		0..1	dateTime	Educational material presentation date
programEligibility		0..*	CodeableConcept	Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.
fundingSource		0..1	CodeableConcept	Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.
reaction		0..*	BackboneElement	Details of a reaction that follows immunization
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
date	C	0..1	dateTime	When reaction started uds-plus-iimm-4: All dateTime data elements should be truncated to a year only for de-identified resources.
detail		0..1	Reference(Observation)	Additional information on reaction
reported		0..1	boolean	Indicates self-reported reaction
protocolApplied		0..*	BackboneElement	Protocol followed by the provider
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
series		0..1	string	Name of vaccine series
authority		0..1	Reference(Organization)	Who is responsible for publishing the recommendations
targetDisease		0..*	CodeableConcept	Vaccine preventatable disease being targetted Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for.
doseNumber[x]		1..1		Dose number within series
doseNumberPositiveInt			positiveInt
doseNumberString			string
seriesDoses[x]		0..1		Recommended number of doses for immunity
seriesDosesPositiveInt			positiveInt
seriesDosesString			string
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Immunization.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Immunization.status	required	ImmunizationStatusCodes http://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard
Immunization.statusReason	example	ImmunizationStatusReasonCodes http://hl7.org/fhir/ValueSet/immunization-status-reason from the FHIR Standard
Immunization.vaccineCode	example	VaccineAdministeredValueSet http://hl7.org/fhir/ValueSet/vaccine-code from the FHIR Standard
Immunization.patient.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Immunization.reportOrigin	example	ImmunizationOriginCodes http://hl7.org/fhir/ValueSet/immunization-origin from the FHIR Standard
Immunization.site	example	CodesForImmunizationSiteOfAdministration http://hl7.org/fhir/ValueSet/immunization-site from the FHIR Standard
Immunization.route	example	ImmunizationRouteCodes http://hl7.org/fhir/ValueSet/immunization-route from the FHIR Standard
Immunization.performer.function	extensible	ImmunizationFunctionCodes http://hl7.org/fhir/ValueSet/immunization-function from the FHIR Standard
Immunization.reasonCode	example	ImmunizationReasonCodes http://hl7.org/fhir/ValueSet/immunization-reason from the FHIR Standard
Immunization.subpotentReason	example	ImmunizationSubpotentReason http://hl7.org/fhir/ValueSet/immunization-subpotent-reason from the FHIR Standard
Immunization.programEligibility	example	ImmunizationProgramEligibility http://hl7.org/fhir/ValueSet/immunization-program-eligibility from the FHIR Standard
Immunization.fundingSource	example	ImmunizationFundingSource http://hl7.org/fhir/ValueSet/immunization-funding-source from the FHIR Standard
Immunization.protocolApplied.targetDisease	example	ImmunizationTargetDiseaseCodes http://hl7.org/fhir/ValueSet/immunization-target-disease from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Immunization	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Immunization	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Immunization	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Immunization	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Immunization	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
imm-1	error	Immunization.education	One of documentType or reference SHALL be present : documentType.exists() or reference.exists()
uds-plus-iimm-2	error	Immunization.recorded	All dateTime data elements should be truncated to a year only for de-identified resources. : $this is DateTime implies $this.toString().length() = 4
uds-plus-iimm-3	error	Immunization.expirationDate	All date data elements should be truncated to a year only for de-identified resources. : $this is date implies $this.toString().length() = 4
uds-plus-iimm-4	error	Immunization.reaction.date	All dateTime data elements should be truncated to a year only for de-identified resources. : $this is dateTime implies $this.toString().length() = 4
uds-plus-imm-1	error	Immunization.occurrence[x]	All dateTime data elements should be truncated to a year only for de-identified resources. : $this is DateTime implies $this.toString().length() = 4

Differential View

This structure is derived from Immunization

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	Immunization	De-Identified UDS Plus Immunization
id	S	0..1	id	The de-identified Immunization identifier created by the health center to send data to UDS+ Data Receiver
text		0..0
contained		0..0
status	S	1..1	code	completed | entered-in-error | not-done
statusReason	S	0..1	CodeableConcept	Reason not done
vaccineCode	S	1..1	CodeableConcept	Vaccine product administered
patient	S	1..1	Reference(De-Identified UDS Plus Patient)	Who was immunized
display		0..0
occurrence[x]	SC	1..1	dateTime	Vaccine administration date uds-plus-imm-1: All dateTime data elements should be truncated to a year only for de-identified resources.
recorded	SC	0..1	dateTime	When the immunization was first captured in the subject's record uds-plus-iimm-2: All dateTime data elements should be truncated to a year only for de-identified resources.
primarySource	S	1..1	boolean	Indicates context the data was recorded in
expirationDate	C	0..1	date	Vaccine expiration date uds-plus-iimm-3: All date data elements should be truncated to a year only for de-identified resources.
note		0..0
reaction
date	C	0..1	dateTime	When reaction started uds-plus-iimm-4: All dateTime data elements should be truncated to a year only for de-identified resources.
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
uds-plus-iimm-2	error	Immunization.recorded	All dateTime data elements should be truncated to a year only for de-identified resources. : $this is DateTime implies $this.toString().length() = 4
uds-plus-iimm-3	error	Immunization.expirationDate	All date data elements should be truncated to a year only for de-identified resources. : $this is date implies $this.toString().length() = 4
uds-plus-iimm-4	error	Immunization.reaction.date	All dateTime data elements should be truncated to a year only for de-identified resources. : $this is dateTime implies $this.toString().length() = 4
uds-plus-imm-1	error	Immunization.occurrence[x]	All dateTime data elements should be truncated to a year only for de-identified resources. : $this is DateTime implies $this.toString().length() = 4

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	Immunization	De-Identified UDS Plus Immunization
id	SΣ	0..1	id	The de-identified Immunization identifier created by the health center to send data to UDS+ Data Receiver
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!SΣ	1..1	code	completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
statusReason	S	0..1	CodeableConcept	Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
vaccineCode	SΣ	1..1	CodeableConcept	Vaccine product administered Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.
patient	SΣ	1..1	Reference(De-Identified UDS Plus Patient)	Who was immunized
occurrence[x]	SΣC	1..1	dateTime	Vaccine administration date uds-plus-imm-1: All dateTime data elements should be truncated to a year only for de-identified resources.
recorded	SC	0..1	dateTime	When the immunization was first captured in the subject's record uds-plus-iimm-2: All dateTime data elements should be truncated to a year only for de-identified resources.
primarySource	SΣ	1..1	boolean	Indicates context the data was recorded in
expirationDate	C	0..1	date	Vaccine expiration date uds-plus-iimm-3: All date data elements should be truncated to a year only for de-identified resources.
isSubpotent	?!Σ	0..1	boolean	Dose potency
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Immunization.status	required	ImmunizationStatusCodes http://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard
Immunization.statusReason	example	ImmunizationStatusReasonCodes http://hl7.org/fhir/ValueSet/immunization-status-reason from the FHIR Standard
Immunization.vaccineCode	example	VaccineAdministeredValueSet http://hl7.org/fhir/ValueSet/vaccine-code from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Immunization	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Immunization	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Immunization	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Immunization	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Immunization	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
uds-plus-iimm-2	error	Immunization.recorded	All dateTime data elements should be truncated to a year only for de-identified resources. : $this is DateTime implies $this.toString().length() = 4
uds-plus-iimm-3	error	Immunization.expirationDate	All date data elements should be truncated to a year only for de-identified resources. : $this is date implies $this.toString().length() = 4
uds-plus-imm-1	error	Immunization.occurrence[x]	All dateTime data elements should be truncated to a year only for de-identified resources. : $this is DateTime implies $this.toString().length() = 4

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Immunization		0..*	Immunization	De-Identified UDS Plus Immunization
id	SΣ	0..1	id	The de-identified Immunization identifier created by the health center to send data to UDS+ Data Receiver
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier		0..*	Identifier	Business identifier
status	?!SΣ	1..1	code	completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
statusReason	S	0..1	CodeableConcept	Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
vaccineCode	SΣ	1..1	CodeableConcept	Vaccine product administered Binding: VaccineAdministeredValueSet (example): The code for vaccine product administered.
patient	SΣ	1..1	Reference(De-Identified UDS Plus Patient)	Who was immunized
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
encounter		0..1	Reference(Encounter)	Encounter immunization was part of
occurrence[x]	SΣC	1..1	dateTime	Vaccine administration date uds-plus-imm-1: All dateTime data elements should be truncated to a year only for de-identified resources.
recorded	SC	0..1	dateTime	When the immunization was first captured in the subject's record uds-plus-iimm-2: All dateTime data elements should be truncated to a year only for de-identified resources.
primarySource	SΣ	1..1	boolean	Indicates context the data was recorded in
reportOrigin		0..1	CodeableConcept	Indicates the source of a secondarily reported record Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source.
location		0..1	Reference(Location)	Where immunization occurred
manufacturer		0..1	Reference(Organization)	Vaccine manufacturer
lotNumber		0..1	string	Vaccine lot number
expirationDate	C	0..1	date	Vaccine expiration date uds-plus-iimm-3: All date data elements should be truncated to a year only for de-identified resources.
site		0..1	CodeableConcept	Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.
route		0..1	CodeableConcept	How vaccine entered body Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered.
doseQuantity		0..1	SimpleQuantity	Amount of vaccine administered
performer	Σ	0..*	BackboneElement	Who performed event
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
function	Σ	0..1	CodeableConcept	What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.
actor	Σ	1..1	Reference(Practitioner | PractitionerRole | Organization)	Individual or organization who was performing
reasonCode		0..*	CodeableConcept	Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.
reasonReference		0..*	Reference(Condition | Observation | DiagnosticReport)	Why immunization occurred
isSubpotent	?!Σ	0..1	boolean	Dose potency
subpotentReason		0..*	CodeableConcept	Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.
education	C	0..*	BackboneElement	Educational material presented to patient imm-1: One of documentType or reference SHALL be present
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
documentType		0..1	string	Educational material document identifier
reference		0..1	uri	Educational material reference pointer
publicationDate		0..1	dateTime	Educational material publication date
presentationDate		0..1	dateTime	Educational material presentation date
programEligibility		0..*	CodeableConcept	Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.
fundingSource		0..1	CodeableConcept	Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.
reaction		0..*	BackboneElement	Details of a reaction that follows immunization
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
date	C	0..1	dateTime	When reaction started uds-plus-iimm-4: All dateTime data elements should be truncated to a year only for de-identified resources.
detail		0..1	Reference(Observation)	Additional information on reaction
reported		0..1	boolean	Indicates self-reported reaction
protocolApplied		0..*	BackboneElement	Protocol followed by the provider
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
series		0..1	string	Name of vaccine series
authority		0..1	Reference(Organization)	Who is responsible for publishing the recommendations
targetDisease		0..*	CodeableConcept	Vaccine preventatable disease being targetted Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for.
doseNumber[x]		1..1		Dose number within series
doseNumberPositiveInt			positiveInt
doseNumberString			string
seriesDoses[x]		0..1		Recommended number of doses for immunity
seriesDosesPositiveInt			positiveInt
seriesDosesString			string
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Immunization.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Immunization.status	required	ImmunizationStatusCodes http://hl7.org/fhir/ValueSet/immunization-status|4.0.1 from the FHIR Standard
Immunization.statusReason	example	ImmunizationStatusReasonCodes http://hl7.org/fhir/ValueSet/immunization-status-reason from the FHIR Standard
Immunization.vaccineCode	example	VaccineAdministeredValueSet http://hl7.org/fhir/ValueSet/vaccine-code from the FHIR Standard
Immunization.patient.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Immunization.reportOrigin	example	ImmunizationOriginCodes http://hl7.org/fhir/ValueSet/immunization-origin from the FHIR Standard
Immunization.site	example	CodesForImmunizationSiteOfAdministration http://hl7.org/fhir/ValueSet/immunization-site from the FHIR Standard
Immunization.route	example	ImmunizationRouteCodes http://hl7.org/fhir/ValueSet/immunization-route from the FHIR Standard
Immunization.performer.function	extensible	ImmunizationFunctionCodes http://hl7.org/fhir/ValueSet/immunization-function from the FHIR Standard
Immunization.reasonCode	example	ImmunizationReasonCodes http://hl7.org/fhir/ValueSet/immunization-reason from the FHIR Standard
Immunization.subpotentReason	example	ImmunizationSubpotentReason http://hl7.org/fhir/ValueSet/immunization-subpotent-reason from the FHIR Standard
Immunization.programEligibility	example	ImmunizationProgramEligibility http://hl7.org/fhir/ValueSet/immunization-program-eligibility from the FHIR Standard
Immunization.fundingSource	example	ImmunizationFundingSource http://hl7.org/fhir/ValueSet/immunization-funding-source from the FHIR Standard
Immunization.protocolApplied.targetDisease	example	ImmunizationTargetDiseaseCodes http://hl7.org/fhir/ValueSet/immunization-target-disease from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Immunization	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Immunization	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Immunization	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Immunization	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Immunization	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
imm-1	error	Immunization.education	One of documentType or reference SHALL be present : documentType.exists() or reference.exists()
uds-plus-iimm-2	error	Immunization.recorded	All dateTime data elements should be truncated to a year only for de-identified resources. : $this is DateTime implies $this.toString().length() = 4
uds-plus-iimm-3	error	Immunization.expirationDate	All date data elements should be truncated to a year only for de-identified resources. : $this is date implies $this.toString().length() = 4
uds-plus-iimm-4	error	Immunization.reaction.date	All dateTime data elements should be truncated to a year only for de-identified resources. : $this is dateTime implies $this.toString().length() = 4
uds-plus-imm-1	error	Immunization.occurrence[x]	All dateTime data elements should be truncated to a year only for de-identified resources. : $this is DateTime implies $this.toString().length() = 4

This structure is derived from Immunization

Summary

Mandatory: 5 elements
Must-Support: 8 elements
Prohibited: 4 elements

Structures

This structure refers to these other structures:

• De-Identified UDS Plus Patient (http://fhir.org/guides/hrsa/uds-plus/StructureDefinition/de-identified-uds-plus-patient)

Maturity: 2