US Veterans Health Administration FHIR Map Set Implementation Guide
1.6.49 - 250701
Publication Build: This will be filled in by the publication tooling
Official URL: http://va.gov/fhir/StructureDefinition/VAERSImmunizationpvac3 | Version: 1.6.49 | |||
Draft as of 2025-06-13 | Computable Name: VAERSImmunizationpvac3 |
This StructureDefinition contains the maps for ADERS to us-core-immunization.
See also the FHIR Shorthand.
Usages:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | USCoreImmunizationProfile(5.0.1) | Immunization event information Constraints: us-core-5 |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
?!SΣ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required) Required Pattern: completed |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Reason not done Binding: ImmunizationStatusReasonCodes (example) |
![]() ![]() ![]() |
SΣC | 1..1 | CodeableConcept | Vaccine Product Type (bind to CVX) Binding: CVX Vaccines Administered Vaccine Set ![]() |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(VAERS Patient) | Who was immunized |
![]() ![]() ![]() |
SΣ | 1..1 | Vaccine administration date Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | dateTime | Vaccine administration date |
![]() ![]() ![]() |
SΣ | 1..1 | boolean | Indicates context the data was recorded in Required Pattern: false |
![]() ![]() ![]() |
0..1 | Reference(Organization) | Vaccine manufacturer | |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Text alternative for the resource |
![]() ![]() ![]() |
S | 0..1 | string | Vaccine lot number |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered. |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | How vaccine entered body Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered. |
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | Dose potency |
![]() ![]() ![]() |
0..* | BackboneElement | Protocol followed by the provider | |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
1..1 | Dose number within series Slice: Unordered, Open by type:$this | ||
![]() ![]() ![]() ![]() ![]() |
positiveInt | |||
![]() ![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Dose number within series |
![]() |
Path | Conformance | ValueSet / Code | URI |
Immunization.status | required | Pattern Value: completedhttp://hl7.org/fhir/ValueSet/immunization-status From the FHIR Standard | |
Immunization.statusReason | example | ImmunizationStatusReasonCodeshttp://hl7.org/fhir/ValueSet/immunization-status-reason From the FHIR Standard | |
Immunization.vaccineCode | extensible | CVX Vaccines Administered Vaccine Set ![]() http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.6 | |
Immunization.site | example | CodesForImmunizationSiteOfAdministrationhttp://hl7.org/fhir/ValueSet/immunization-site From the FHIR Standard | |
Immunization.route | example | ImmunizationRouteCodeshttp://hl7.org/fhir/ValueSet/immunization-route From the FHIR Standard |
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() | |
us-core-5 | best practice | Immunization | SHOULD have a translation to the NDC value set : vaccineCode.coding.where(system='http://hl7.org/fhir/sid/ndc').empty() |
This structure is derived from USCoreImmunizationProfile
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
USCoreImmunizationProfile(5.0.1) | |||
![]() ![]() ![]() |
1..1 | code | completed | entered-in-error | not-done Required Pattern: completed | |
![]() ![]() ![]() |
0..1 | CodeableConcept | Reason not done | |
![]() ![]() ![]() |
1..1 | CodeableConcept | Vaccine Product Type (bind to CVX) | |
![]() ![]() ![]() |
1..1 | Reference(VAERS Patient) | Who was immunized | |
![]() ![]() ![]() |
1..1 | dateTime, string | Vaccine administration date Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() |
S | 0..1 | dateTime S | Vaccine administration date |
![]() ![]() ![]() |
1..1 | boolean | Indicates context the data was recorded in Required Pattern: false | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
S | 0..1 | string | Text alternative for the resource |
![]() ![]() ![]() |
S | 0..1 | string | Vaccine lot number |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Body site vaccine was administered |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | How vaccine entered body |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
1..1 | positiveInt, string | Dose number within series Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Dose number within series |
![]() |
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | USCoreImmunizationProfile(5.0.1) | Immunization event information Constraints: us-core-5 | ||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
0..* | Identifier | Business identifier | |||||
![]() ![]() ![]() |
?!SΣ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required) Required Pattern: completed | ||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Reason not done Binding: ImmunizationStatusReasonCodes (example) | ||||
![]() ![]() ![]() |
SΣC | 1..1 | CodeableConcept | Vaccine Product Type (bind to CVX) Binding: CVX Vaccines Administered Vaccine Set ![]() | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(VAERS Patient) | Who was immunized | ||||
![]() ![]() ![]() |
0..1 | Reference(Encounter) | Encounter immunization was part of | |||||
![]() ![]() ![]() |
SΣ | 1..1 | Vaccine administration date Slice: Unordered, Open by type:$this | |||||
![]() ![]() ![]() ![]() |
dateTime S | |||||||
![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | dateTime S | Vaccine administration date | ||||
![]() ![]() ![]() |
0..1 | dateTime | When the immunization was first captured in the subject's record | |||||
![]() ![]() ![]() |
SΣ | 1..1 | boolean | Indicates context the data was recorded in Required Pattern: false | ||||
![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() |
0..1 | Reference(Location) | Where immunization occurred | |||||
![]() ![]() ![]() |
0..1 | Reference(Organization) | Vaccine manufacturer | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() |
Σ | 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). | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() ![]() |
S | 0..1 | string | Vaccine lot number | ||||
![]() ![]() ![]() |
0..1 | date | Vaccine expiration date | |||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered. | ||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | How vaccine entered body Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered. | ||||
![]() ![]() ![]() |
0..1 | SimpleQuantity | Amount of vaccine administered | |||||
![]() ![]() ![]() |
Σ | 0..* | BackboneElement | Who performed event | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing | ||||
![]() ![]() ![]() |
Σ | 0..* | Annotation | Additional immunization notes | ||||
![]() ![]() ![]() |
0..* | CodeableConcept | Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered. | |||||
![]() ![]() ![]() |
0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred | |||||
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | Dose potency | ||||
![]() ![]() ![]() |
0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent. | |||||
![]() ![]() ![]() |
C | 0..* | BackboneElement | Educational material presented to patient Constraints: imm-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Educational material document identifier | |||||
![]() ![]() ![]() ![]() |
0..1 | uri | Educational material reference pointer | |||||
![]() ![]() ![]() ![]() |
0..1 | dateTime | Educational material publication date | |||||
![]() ![]() ![]() ![]() |
0..1 | dateTime | Educational material presentation date | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program. | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered. | |||||
![]() ![]() ![]() |
0..* | BackboneElement | Details of a reaction that follows immunization | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..1 | dateTime | When reaction started | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Observation) | Additional information on reaction | |||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Indicates self-reported reaction | |||||
![]() ![]() ![]() |
0..* | BackboneElement | Protocol followed by the provider | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Name of vaccine series | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for. | |||||
![]() ![]() ![]() ![]() |
1..1 | Dose number within series Slice: Unordered, Open by type:$this | ||||||
![]() ![]() ![]() ![]() ![]() |
positiveInt | |||||||
![]() ![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Dose number within series | ||||
![]() ![]() ![]() ![]() |
0..1 | Recommended number of doses for immunity | ||||||
![]() ![]() ![]() ![]() ![]() |
positiveInt | |||||||
![]() ![]() ![]() ![]() ![]() |
string | |||||||
![]() |
Path | Conformance | ValueSet / Code | URI | |||
Immunization.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages From the FHIR Standard
| ||||
Immunization.status | required | Pattern Value: completedhttp://hl7.org/fhir/ValueSet/immunization-status From the FHIR Standard | ||||
Immunization.statusReason | example | ImmunizationStatusReasonCodeshttp://hl7.org/fhir/ValueSet/immunization-status-reason From the FHIR Standard | ||||
Immunization.vaccineCode | extensible | CVX Vaccines Administered Vaccine Set ![]() http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.6 | ||||
Immunization.reportOrigin | example | ImmunizationOriginCodeshttp://hl7.org/fhir/ValueSet/immunization-origin From the FHIR Standard | ||||
Immunization.manufacturer.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard | ||||
Immunization.site | example | CodesForImmunizationSiteOfAdministrationhttp://hl7.org/fhir/ValueSet/immunization-site From the FHIR Standard | ||||
Immunization.route | example | ImmunizationRouteCodeshttp://hl7.org/fhir/ValueSet/immunization-route From the FHIR Standard | ||||
Immunization.performer.function | extensible | ImmunizationFunctionCodeshttp://hl7.org/fhir/ValueSet/immunization-function From the FHIR Standard | ||||
Immunization.reasonCode | example | ImmunizationReasonCodeshttp://hl7.org/fhir/ValueSet/immunization-reason From the FHIR Standard | ||||
Immunization.subpotentReason | example | ImmunizationSubpotentReasonhttp://hl7.org/fhir/ValueSet/immunization-subpotent-reason From the FHIR Standard | ||||
Immunization.programEligibility | example | ImmunizationProgramEligibilityhttp://hl7.org/fhir/ValueSet/immunization-program-eligibility From the FHIR Standard | ||||
Immunization.fundingSource | example | ImmunizationFundingSourcehttp://hl7.org/fhir/ValueSet/immunization-funding-source From the FHIR Standard | ||||
Immunization.protocolApplied.targetDisease | example | ImmunizationTargetDiseaseCodeshttp://hl7.org/fhir/ValueSet/immunization-target-disease From the FHIR Standard |
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() | |
us-core-5 | best practice | Immunization | SHOULD have a translation to the NDC value set : vaccineCode.coding.where(system='http://hl7.org/fhir/sid/ndc').empty() |
This structure is derived from USCoreImmunizationProfile
Summary
Must-Support: 6 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Key Elements View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | USCoreImmunizationProfile(5.0.1) | Immunization event information Constraints: us-core-5 |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
?!SΣ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required) Required Pattern: completed |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Reason not done Binding: ImmunizationStatusReasonCodes (example) |
![]() ![]() ![]() |
SΣC | 1..1 | CodeableConcept | Vaccine Product Type (bind to CVX) Binding: CVX Vaccines Administered Vaccine Set ![]() |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(VAERS Patient) | Who was immunized |
![]() ![]() ![]() |
SΣ | 1..1 | Vaccine administration date Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | dateTime | Vaccine administration date |
![]() ![]() ![]() |
SΣ | 1..1 | boolean | Indicates context the data was recorded in Required Pattern: false |
![]() ![]() ![]() |
0..1 | Reference(Organization) | Vaccine manufacturer | |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Text alternative for the resource |
![]() ![]() ![]() |
S | 0..1 | string | Vaccine lot number |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered. |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | How vaccine entered body Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered. |
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | Dose potency |
![]() ![]() ![]() |
0..* | BackboneElement | Protocol followed by the provider | |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
1..1 | Dose number within series Slice: Unordered, Open by type:$this | ||
![]() ![]() ![]() ![]() ![]() |
positiveInt | |||
![]() ![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Dose number within series |
![]() |
Path | Conformance | ValueSet / Code | URI |
Immunization.status | required | Pattern Value: completedhttp://hl7.org/fhir/ValueSet/immunization-status From the FHIR Standard | |
Immunization.statusReason | example | ImmunizationStatusReasonCodeshttp://hl7.org/fhir/ValueSet/immunization-status-reason From the FHIR Standard | |
Immunization.vaccineCode | extensible | CVX Vaccines Administered Vaccine Set ![]() http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.6 | |
Immunization.site | example | CodesForImmunizationSiteOfAdministrationhttp://hl7.org/fhir/ValueSet/immunization-site From the FHIR Standard | |
Immunization.route | example | ImmunizationRouteCodeshttp://hl7.org/fhir/ValueSet/immunization-route From the FHIR Standard |
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() | |
us-core-5 | best practice | Immunization | SHOULD have a translation to the NDC value set : vaccineCode.coding.where(system='http://hl7.org/fhir/sid/ndc').empty() |
Differential View
This structure is derived from USCoreImmunizationProfile
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
USCoreImmunizationProfile(5.0.1) | |||
![]() ![]() ![]() |
1..1 | code | completed | entered-in-error | not-done Required Pattern: completed | |
![]() ![]() ![]() |
0..1 | CodeableConcept | Reason not done | |
![]() ![]() ![]() |
1..1 | CodeableConcept | Vaccine Product Type (bind to CVX) | |
![]() ![]() ![]() |
1..1 | Reference(VAERS Patient) | Who was immunized | |
![]() ![]() ![]() |
1..1 | dateTime, string | Vaccine administration date Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() |
S | 0..1 | dateTime S | Vaccine administration date |
![]() ![]() ![]() |
1..1 | boolean | Indicates context the data was recorded in Required Pattern: false | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
S | 0..1 | string | Text alternative for the resource |
![]() ![]() ![]() |
S | 0..1 | string | Vaccine lot number |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Body site vaccine was administered |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | How vaccine entered body |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
1..1 | positiveInt, string | Dose number within series Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Dose number within series |
![]() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | USCoreImmunizationProfile(5.0.1) | Immunization event information Constraints: us-core-5 | ||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
0..* | Identifier | Business identifier | |||||
![]() ![]() ![]() |
?!SΣ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required) Required Pattern: completed | ||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Reason not done Binding: ImmunizationStatusReasonCodes (example) | ||||
![]() ![]() ![]() |
SΣC | 1..1 | CodeableConcept | Vaccine Product Type (bind to CVX) Binding: CVX Vaccines Administered Vaccine Set ![]() | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(VAERS Patient) | Who was immunized | ||||
![]() ![]() ![]() |
0..1 | Reference(Encounter) | Encounter immunization was part of | |||||
![]() ![]() ![]() |
SΣ | 1..1 | Vaccine administration date Slice: Unordered, Open by type:$this | |||||
![]() ![]() ![]() ![]() |
dateTime S | |||||||
![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | dateTime S | Vaccine administration date | ||||
![]() ![]() ![]() |
0..1 | dateTime | When the immunization was first captured in the subject's record | |||||
![]() ![]() ![]() |
SΣ | 1..1 | boolean | Indicates context the data was recorded in Required Pattern: false | ||||
![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() |
0..1 | Reference(Location) | Where immunization occurred | |||||
![]() ![]() ![]() |
0..1 | Reference(Organization) | Vaccine manufacturer | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() |
Σ | 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). | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() ![]() |
S | 0..1 | string | Vaccine lot number | ||||
![]() ![]() ![]() |
0..1 | date | Vaccine expiration date | |||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered. | ||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | How vaccine entered body Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered. | ||||
![]() ![]() ![]() |
0..1 | SimpleQuantity | Amount of vaccine administered | |||||
![]() ![]() ![]() |
Σ | 0..* | BackboneElement | Who performed event | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing | ||||
![]() ![]() ![]() |
Σ | 0..* | Annotation | Additional immunization notes | ||||
![]() ![]() ![]() |
0..* | CodeableConcept | Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered. | |||||
![]() ![]() ![]() |
0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred | |||||
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | Dose potency | ||||
![]() ![]() ![]() |
0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent. | |||||
![]() ![]() ![]() |
C | 0..* | BackboneElement | Educational material presented to patient Constraints: imm-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Educational material document identifier | |||||
![]() ![]() ![]() ![]() |
0..1 | uri | Educational material reference pointer | |||||
![]() ![]() ![]() ![]() |
0..1 | dateTime | Educational material publication date | |||||
![]() ![]() ![]() ![]() |
0..1 | dateTime | Educational material presentation date | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program. | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered. | |||||
![]() ![]() ![]() |
0..* | BackboneElement | Details of a reaction that follows immunization | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..1 | dateTime | When reaction started | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Observation) | Additional information on reaction | |||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Indicates self-reported reaction | |||||
![]() ![]() ![]() |
0..* | BackboneElement | Protocol followed by the provider | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Name of vaccine series | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for. | |||||
![]() ![]() ![]() ![]() |
1..1 | Dose number within series Slice: Unordered, Open by type:$this | ||||||
![]() ![]() ![]() ![]() ![]() |
positiveInt | |||||||
![]() ![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Dose number within series | ||||
![]() ![]() ![]() ![]() |
0..1 | Recommended number of doses for immunity | ||||||
![]() ![]() ![]() ![]() ![]() |
positiveInt | |||||||
![]() ![]() ![]() ![]() ![]() |
string | |||||||
![]() |
Path | Conformance | ValueSet / Code | URI | |||
Immunization.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages From the FHIR Standard
| ||||
Immunization.status | required | Pattern Value: completedhttp://hl7.org/fhir/ValueSet/immunization-status From the FHIR Standard | ||||
Immunization.statusReason | example | ImmunizationStatusReasonCodeshttp://hl7.org/fhir/ValueSet/immunization-status-reason From the FHIR Standard | ||||
Immunization.vaccineCode | extensible | CVX Vaccines Administered Vaccine Set ![]() http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.6 | ||||
Immunization.reportOrigin | example | ImmunizationOriginCodeshttp://hl7.org/fhir/ValueSet/immunization-origin From the FHIR Standard | ||||
Immunization.manufacturer.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard | ||||
Immunization.site | example | CodesForImmunizationSiteOfAdministrationhttp://hl7.org/fhir/ValueSet/immunization-site From the FHIR Standard | ||||
Immunization.route | example | ImmunizationRouteCodeshttp://hl7.org/fhir/ValueSet/immunization-route From the FHIR Standard | ||||
Immunization.performer.function | extensible | ImmunizationFunctionCodeshttp://hl7.org/fhir/ValueSet/immunization-function From the FHIR Standard | ||||
Immunization.reasonCode | example | ImmunizationReasonCodeshttp://hl7.org/fhir/ValueSet/immunization-reason From the FHIR Standard | ||||
Immunization.subpotentReason | example | ImmunizationSubpotentReasonhttp://hl7.org/fhir/ValueSet/immunization-subpotent-reason From the FHIR Standard | ||||
Immunization.programEligibility | example | ImmunizationProgramEligibilityhttp://hl7.org/fhir/ValueSet/immunization-program-eligibility From the FHIR Standard | ||||
Immunization.fundingSource | example | ImmunizationFundingSourcehttp://hl7.org/fhir/ValueSet/immunization-funding-source From the FHIR Standard | ||||
Immunization.protocolApplied.targetDisease | example | ImmunizationTargetDiseaseCodeshttp://hl7.org/fhir/ValueSet/immunization-target-disease From the FHIR Standard |
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() | |
us-core-5 | best practice | Immunization | SHOULD have a translation to the NDC value set : vaccineCode.coding.where(system='http://hl7.org/fhir/sid/ndc').empty() |
This structure is derived from USCoreImmunizationProfile
Summary
Must-Support: 6 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron