"Id","Path","Slice Name","Alias(s)","Label","Min","Max","Must Support?","Is Modifier?","Is Summary?","Type(s)","Short","Definition","Comments","Requirements","Default Value","Meaning When Missing","Fixed Value","Pattern","Example","Minimum Value","Maximum Value","Maximum Length","Binding Strength","Binding Description","Binding Value Set","Code","Slicing Discriminator","Slicing Description","Slicing Ordered","Slicing Rules","Base Path","Base Min","Base Max","Condition(s)","Constraint(s)","Mapping: Workflow Pattern","Mapping: FiveWs Pattern Mapping","Mapping: HL7 V2 Mapping","Mapping: RIM Mapping","Mapping: CDA (R2)"
"Immunization","Immunization","","","",0,*,"","","","null {[]} {[]}
","Immunization event information","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.","","","","","","","","","",,,,,"",,,,"Immunization",0,*,"","dom-2:If the resource is contained in another resource, it SHALL NOT contain nested Resources {contained.contained.empty()}
dom-3: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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()}dom-4: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:If a resource is contained in another resource, it SHALL NOT have a security label {contained.meta.security.empty()}dom-6:A resource should have narrative for robust management {text.`div`.exists()}","Event","clinical.medication","VXU_V04","Entity, Role, or Act,SubstanceAdministration"
"Immunization.id","Immunization.id","","","",0,1,"","","Y","id {[]} {[]}
","Logical id of this artifact","The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.","Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.","","","","","","","","",,,,,"",,,,"Resource.id",0,1,"",""
"Immunization.meta","Immunization.meta","","","",0,1,"","","Y","Meta {[]} {[]}
","Metadata about the resource","The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.","","","","","","","","","",,,,,"",,,,"Resource.meta",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"Immunization.implicitRules","Immunization.implicitRules","","","",0,1,"","Y","Y","uri {[]} {[]}
","A set of rules under which this content was created","A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.","Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.","","","","","","","","",,,,,"",,,,"Resource.implicitRules",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"Immunization.language","Immunization.language","","","",0,1,"","","","code {[]} {[]}
","Language of the resource content","The base language in which the resource is written.","Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies  to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).","","","","","","","","",,"required","IETF language tag for a human language","http://hl7.org/fhir/ValueSet/all-languages|5.0.0","",,,,"Resource.language",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
"
"Immunization.text","Immunization.text","","narrative
htmlxhtmldisplay","",0,1,"","","","Narrative {[]} {[]}
","Text summary of the resource, for human interpretation","A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it ""clinically safe"" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.","Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied).  This may be necessary for data from legacy systems where information is captured as a ""text blob"" or where text is additionally entered raw or narrated and encoded information is added later.","","","","","","","","",,,,,"",,,,"DomainResource.text",0,1,"dom-6
","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
","Act.text?"
"Immunization.contained","Immunization.contained","","inline resources
anonymous resourcescontained resources","",0,*,"","","","Resource {[]} {[]}
","Contained, inline Resources","These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.","This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.","","","","","","","","",,,,,"",,,,"DomainResource.contained",0,*,"dom-2
dom-4dom-3dom-5","","N/A"
"Immunization.extension","Immunization.extension","","extensions
user content","",0,*,"","","","Extension {[]} {[]}
","Additional content defined by implementations","May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","","","","","","","","",,,,,"",,,,"DomainResource.extension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}","N/A"
"Immunization.modifierExtension","Immunization.modifierExtension","","extensions
user content","",0,*,"","Y","Y","Extension {[]} {[]}
","Extensions that cannot be ignored","May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored.  This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R5/extensibility.html#modifierExtension).","","","","","","","",,,,,"",,,,"DomainResource.modifierExtension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}","N/A"
"Immunization.identifier","Immunization.identifier","","","",0,*,"","","","Identifier {[]} {[]}
","Business identifier","A unique identifier assigned to this immunization record.","","","","","","","","","",,,,,"",,,,"Immunization.identifier",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
","Event.identifier","FiveWs.identifier",".id","ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/id"
"Immunization.basedOn","Immunization.basedOn","","","",0,*,"","","Y","Reference {[]} {[CanonicalType[http://hl7.org/fhir/StructureDefinition/CarePlan|5.0.0], CanonicalType[http://hl7.org/fhir/StructureDefinition/MedicationRequest|5.0.0], CanonicalType[http://hl7.org/fhir/StructureDefinition/ServiceRequest|5.0.0], CanonicalType[http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation|5.0.0]]}
","Authority that the immunization event is based on","A plan, order or recommendation fulfilled in whole or in part by this immunization.","Allows tracing of an authorization for the Immunization.","","","","","","","","",,,,,"",,,,"Immunization.basedOn",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
","Event.basedOn","N/A"
"Immunization.status","Immunization.status","","","",1,1,"","Y","Y","code {[]} {[]}
","completed | entered-in-error | not-done","Indicates the current status of the immunization event.","Will generally be set to show that the immunization has been completed or not done.  This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.","","","","","<valueCode xmlns=""http://hl7.org/fhir"" value=""completed""/>","","","",,"required","","http://hl7.org/fhir/ValueSet/immunization-status|5.0.0","",,,,"Immunization.status",1,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
","Event.status","FiveWs.status","statusCode"
"Immunization.statusReason","Immunization.statusReason","","","",0,1,"","","","CodeableConcept {[]} {[]}
","Reason for current status","Indicates the reason the immunization event was not performed.","This is generally only used for the status of ""not-done"". The reason for performing the immunization event is captured in reasonCode, not here.","","","","","","","","",,"example","","http://hl7.org/fhir/ValueSet/immunization-status-reason|5.0.0","",,,,"Immunization.statusReason",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
","Event.statusReason",".inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN].reasonCOde"
"Immunization.vaccineCode","Immunization.vaccineCode","","","",1,1,"","","Y","CodeableConcept {[]} {[]}
","Vaccine administered","Vaccine that was administered or was to be administered.","The code for the administered vaccine may be reported at various levels of granularity from a very generic code for a general type of vaccine (e.g. the SNOMED or CVX code for the flu vaccine) to a very discrete code for a specific product including the form and packaging (e.g. an NDC code). Because vaccineCode uses the CodeableConcept data type, multiple codes at different levels of granularity may be reported for a single immunization event provided that all codes are appropriate for the same vaccine. For example, both NDC and CVX codes may be provided for a given immunization event by repeating the coding element within vaccineCode.","","","","","","","","",,"required","","https://fhir.amakomaya.com/ValueSet/vaccine","",,,,"Immunization.vaccineCode",1,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
","Event.code","FiveWs.what[x]","RXA-5",".code","ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/realmCode/code"
"Immunization.administeredProduct","Immunization.administeredProduct","","","",0,1,"","","","CodeableReference {[]} {[CanonicalType[http://hl7.org/fhir/StructureDefinition/Medication|5.0.0]]}
","Product that was administered","An indication of which product was administered to the patient. This is typically a more detailed representation of the concept conveyed by the vaccineCode data element. If a Medication resource is referenced, it may be to a stand-alone resource or a contained resource within the Immunization resource.","","","","","","","","","",,,,,"",,,,"Immunization.administeredProduct",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
","Event.code","FiveWs.what[x]","RXA-5",".code","ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/realmCode/code"
"Immunization.manufacturer","Immunization.manufacturer","","","",0,1,"","","","CodeableReference {[]} {[CanonicalType[http://hl7.org/fhir/StructureDefinition/Organization|5.0.0]]}
","Vaccine manufacturer","Name of vaccine manufacturer.","","","","","","","","","",,,,,"",,,,"Immunization.manufacturer",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
","RXA-17",".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=ORG]","ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacuturerOrganization/name"
"Immunization.lotNumber","Immunization.lotNumber","","","",0,1,"","","","string {[]} {[]}
","Vaccine lot number","Lot number of the  vaccine product.","","","","","","","","","",,,,,"",,,,"Immunization.lotNumber",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
","RXA-15",".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].id","ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/lotNumberText"
"Immunization.expirationDate","Immunization.expirationDate","","","",0,1,"","","","date {[]} {[]}
","Vaccine expiration date","Date vaccine batch expires.","","","","","","","","","",,,,,"",,,,"Immunization.expirationDate",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
","RXA-16",".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].expirationTime"
"Immunization.patient","Immunization.patient","","","",1,1,"","","Y","Reference {[]} {[CanonicalType[https://fhir.amakomaya.com/StructureDefinition/amk-core-patient]]}
","Who was immunized","The patient who either received or did not receive the immunization.","","","","","","","","","",,,,,"",,,,"Immunization.patient",1,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
","Event.subject","FiveWs.subject[x]","PID-3",".partipication[ttypeCode=].role"
"Immunization.encounter","Immunization.encounter","","","",0,1,"","","","Reference {[]} {[CanonicalType[http://hl7.org/fhir/StructureDefinition/Encounter|5.0.0]]}
","Encounter immunization was part of","The visit or admission or other contact between patient and health care provider the immunization was performed as part of.","","","","","","","","","",,,,,"",,,,"Immunization.encounter",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
","Event.encounter","FiveWs.context","PV1-19","component->EncounterEvent"
"Immunization.supportingInformation","Immunization.supportingInformation","","","",0,*,"","","","Reference {[]} {[CanonicalType[http://hl7.org/fhir/StructureDefinition/Resource|5.0.0]]}
","Additional information in support of the immunization","Additional information that is relevant to the immunization (e.g. for a vaccine recipient who is pregnant, the gestational age of the fetus). The reason why a vaccine was given (e.g. occupation, underlying medical condition) should be conveyed in Immunization.reason, not as supporting information. The reason why a vaccine was not given (e.g. contraindication) should be conveyed in Immunization.statusReason, not as supporting information.","","","","","","","","","",,,,,"",,,,"Immunization.supportingInformation",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
","FiveWs.context"
"Immunization.occurrence[x]","Immunization.occurrence[x]","","","",1,1,"","","Y","dateTime {[]} {[]}
","Vaccine administration date","Date vaccine administered or was to be administered.","When immunizations are given a specific date and time should always be known.   When immunizations are patient reported, a specific date might not be known.  Although partial dates are allowed, an adult patient might not be able to recall the year a childhood immunization was given. An exact date is always preferable, but the use of the String data type is acceptable when an exact date is not known. A small number of vaccines (e.g. live oral typhoid vaccine) are given as a series of patient self-administered dose over a span of time. In cases like this, often, only the first dose (typically a provider supervised dose) is recorded with the occurrence indicating the date/time of the first dose.","","","","","","","","",,,,,"","type:$this}
","",,"closed","Immunization.occurrence[x]",1,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
","Event.occurrence[x]","FiveWs.done[x]","RXA-3",".effectiveTime","ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/effectiveTime/value"
"Immunization.occurrence[x]:occurrenceDateTime","Immunization.occurrence[x]","occurrenceDateTime","","",1,1,"","","Y","dateTime {[]} {[]}
","Vaccine administration date","Date vaccine administered or was to be administered.","When immunizations are given a specific date and time should always be known.   When immunizations are patient reported, a specific date might not be known.  Although partial dates are allowed, an adult patient might not be able to recall the year a childhood immunization was given. An exact date is always preferable, but the use of the String data type is acceptable when an exact date is not known. A small number of vaccines (e.g. live oral typhoid vaccine) are given as a series of patient self-administered dose over a span of time. In cases like this, often, only the first dose (typically a provider supervised dose) is recorded with the occurrence indicating the date/time of the first dose.","","","","","","","","",,,,,"",,,,"Immunization.occurrence[x]",1,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
","Event.occurrence[x]","FiveWs.done[x]","RXA-3",".effectiveTime","ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/effectiveTime/value"
"Immunization.primarySource","Immunization.primarySource","","","",0,1,"","","Y","boolean {[]} {[]}
","Indicates context the data was captured in","Indicates whether the data contained in the resource was captured by the individual/organization which was responsible for the administration of the vaccine rather than as 'secondary reported' data documented by a third party. A value of 'true' means this data originated with the individual/organization which was responsible for the administration of the vaccine.","Reflects the “reliability” of the content.","","","","","","","","",,,,,"",,,,"Immunization.primarySource",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
","Event.reported","FiveWs.source","RXA-9","immunization.uncertaintycode (if primary source=false, uncertainty=U)"
"Immunization.informationSource","Immunization.informationSource","","","",0,1,"","","","CodeableReference {[]} {[CanonicalType[http://hl7.org/fhir/StructureDefinition/Patient|5.0.0], CanonicalType[http://hl7.org/fhir/StructureDefinition/Practitioner|5.0.0], CanonicalType[http://hl7.org/fhir/StructureDefinition/PractitionerRole|5.0.0], CanonicalType[http://hl7.org/fhir/StructureDefinition/RelatedPerson|5.0.0], CanonicalType[http://hl7.org/fhir/StructureDefinition/Organization|5.0.0]]}
","Indicates the source of a  reported record","Typically the source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.","Typically will not be populated if primarySource = True, not required even if primarySource = False.","","","","","","","","",,"example","","http://hl7.org/fhir/ValueSet/immunization-origin|5.0.0","",,,,"Immunization.informationSource",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
","Event.reported","FiveWs.source","RXA-9",".participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported) .participation[typeCode=INF].role[classCode=LIC] (this syntax for health care professional) .participation[typeCode=INF].role[classCode=PRS] (this syntax for family member)"
"Immunization.location","Immunization.location","","","",0,1,"","","","Reference {[]} {[CanonicalType[http://hl7.org/fhir/StructureDefinition/Location|5.0.0]]}
","Where immunization occurred","The service delivery location where the vaccine administration occurred.","","","","","","","","","",,,,,"",,,,"Immunization.location",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
","Event.location","FiveWs.where[x]","RXA-27  (or RXA-11, deprecated as of v2.7)",".participation[typeCode=LOC].COCT_MT240000UV"
"Immunization.site","Immunization.site","","","",0,1,"","","","CodeableConcept {[]} {[]}
","Body site vaccine  was administered","Body site where vaccine was administered.","","","","","","","","","",,"example","","http://hl7.org/fhir/ValueSet/immunization-site|5.0.0","",,,,"Immunization.site",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
","RXR-2","observation.targetSiteCode","ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/approachSiteCode/code"
"Immunization.route","Immunization.route","","","",0,1,"","","","CodeableConcept {[]} {[]}
","How vaccine entered body","The path by which the vaccine product is taken into the body.","","","","","","","","","",,"example","","http://hl7.org/fhir/ValueSet/immunization-route|5.0.0","",,,,"Immunization.route",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
","RXR-1",".routeCode","ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/routeCode/code"
"Immunization.doseQuantity","Immunization.doseQuantity","","","",0,1,"","","","Quantity {[CanonicalType[http://hl7.org/fhir/StructureDefinition/SimpleQuantity|5.0.0]]} {[]}
","Amount of vaccine administered","The quantity of vaccine product that was administered.","","","","","","","","","",,,,,"",,,,"Immunization.doseQuantity",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
","RXA-6 / RXA-7",".doseQuantity"
"Immunization.performer","Immunization.performer","","","",0,*,"","","Y","BackboneElement {[]} {[]}
","Who performed event","Indicates who performed the immunization event.","","","","","","","","","",,,,,"",,,,"Immunization.performer",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
","Event.performer","ORC-12 / RXA-10",".participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]"
"Immunization.performer.id","Immunization.performer.id","","","",0,1,"","","","string {[]} {[]}
","Unique id for inter-element referencing","Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","","","","","","","","","",,,,,"",,,,"Element.id",0,1,"ele-1
","","n/a"
"Immunization.performer.extension","Immunization.performer.extension","","extensions
user content","",0,*,"","","","Extension {[]} {[]}
","Additional content defined by implementations","May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","","","","","","","","",,,,,"",,,,"Element.extension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}","n/a"
"Immunization.performer.modifierExtension","Immunization.performer.modifierExtension","","extensions
user contentmodifiers","",0,*,"","Y","Y","Extension {[]} {[]}
","Extensions that cannot be ignored even if unrecognized","May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored.  This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R5/extensibility.html#modifierExtension).","","","","","","","",,,,,"",,,,"BackboneElement.modifierExtension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}","N/A"
"Immunization.performer.function","Immunization.performer.function","","","",0,1,"","","Y","CodeableConcept {[]} {[]}
","What type of performance was done","Describes the type of performance (e.g. ordering provider, administering provider, etc.).","","","","","","","","","",,"extensible","","http://hl7.org/fhir/ValueSet/immunization-function|5.0.0","",,,,"Immunization.performer.function",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
","Event.performer.function",".participation.functionCode"
"Immunization.performer.actor","Immunization.performer.actor","","","",1,1,"","","Y","Reference {[]} {[CanonicalType[http://hl7.org/fhir/StructureDefinition/Practitioner|5.0.0], CanonicalType[http://hl7.org/fhir/StructureDefinition/PractitionerRole|5.0.0], CanonicalType[http://hl7.org/fhir/StructureDefinition/Organization|5.0.0], CanonicalType[http://hl7.org/fhir/StructureDefinition/Patient|5.0.0], CanonicalType[http://hl7.org/fhir/StructureDefinition/RelatedPerson|5.0.0]]}
","Individual or organization who was performing","The practitioner or organization who performed the action.","When the individual practitioner who performed the action is known, it is best to send.","","","","","","","","",,,,,"",,,,"Immunization.performer.actor",1,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
","Event.performer.actor","FiveWs.actor",".player"
"Immunization.note","Immunization.note","","","",0,*,"","","Y","Annotation {[]} {[]}
","Additional immunization notes","Extra information about the immunization that is not conveyed by the other attributes.","","","","","","","","","",,,,,"",,,,"Immunization.note",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
","Event.note","OBX-5 : OBX-3 = 48767-8","note"
"Immunization.reason","Immunization.reason","","","",0,*,"","","","CodeableReference {[]} {[CanonicalType[http://hl7.org/fhir/StructureDefinition/Condition|5.0.0], CanonicalType[http://hl7.org/fhir/StructureDefinition/Observation|5.0.0], CanonicalType[http://hl7.org/fhir/StructureDefinition/DiagnosticReport|5.0.0]]}
","Why immunization occurred","Describes why the immunization occurred in coded or textual form, or Indicates another resource (Condition, Observation or DiagnosticReport) whose existence justifies this immunization.","","","","","","","","","",,"example","","http://hl7.org/fhir/ValueSet/immunization-reason|5.0.0","",,,,"Immunization.reason",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
","Event.reason","[actionNegationInd=false].reasonCode"
"Immunization.isSubpotent","Immunization.isSubpotent","","","",0,1,"","Y","Y","boolean {[]} {[]}
","Dose potency","Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.","Typically, the recognition of the dose being sub-potent is retrospective, after the administration (ex. notification of a manufacturer recall after administration). However, in the case of a partial administration (the patient moves unexpectedly and only some of the dose is actually administered), subpotency may be recognized immediately, but it is still important to record the event.","","","By default, a dose should be considered to be potent.","","","","","",,,,,"",,,,"Immunization.isSubpotent",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
","RXA-20 = PA (partial administration)","N/A"
"Immunization.subpotentReason","Immunization.subpotentReason","","","",0,*,"","","","CodeableConcept {[]} {[]}
","Reason for being subpotent","Reason why a dose is considered to be subpotent.","","","","","","","","","",,"example","The reason why a dose is considered to be subpotent.","http://hl7.org/fhir/ValueSet/immunization-subpotent-reason|5.0.0","",,,,"Immunization.subpotentReason",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
","N/A"
"Immunization.programEligibility","Immunization.programEligibility","","","",0,*,"","","","BackboneElement {[]} {[]}
","Patient eligibility for a specific vaccination program","Indicates a patient's eligibility for a funding program.","","","","","","","","","",,,,,"",,,,"Immunization.programEligibility",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
","OBX-5 : OBX-3 = 64994-7","n/a"
"Immunization.programEligibility.id","Immunization.programEligibility.id","","","",0,1,"","","","string {[]} {[]}
","Unique id for inter-element referencing","Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","","","","","","","","","",,,,,"",,,,"Element.id",0,1,"ele-1
","","n/a"
"Immunization.programEligibility.extension","Immunization.programEligibility.extension","","extensions
user content","",0,*,"","","","Extension {[]} {[]}
","Additional content defined by implementations","May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","","","","","","","","",,,,,"",,,,"Element.extension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}","n/a"
"Immunization.programEligibility.modifierExtension","Immunization.programEligibility.modifierExtension","","extensions
user contentmodifiers","",0,*,"","Y","Y","Extension {[]} {[]}
","Extensions that cannot be ignored even if unrecognized","May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored.  This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R5/extensibility.html#modifierExtension).","","","","","","","",,,,,"",,,,"BackboneElement.modifierExtension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}","N/A"
"Immunization.programEligibility.program","Immunization.programEligibility.program","","","",1,1,"","","","CodeableConcept {[]} {[]}
","The program that eligibility is declared for","Indicates which program the patient had their eligility evaluated for.","","","","","","","","","",,"example","","http://hl7.org/fhir/ValueSet/immunization-vaccine-funding-program|5.0.0","",,,,"Immunization.programEligibility.program",1,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
","n/a"
"Immunization.programEligibility.programStatus","Immunization.programEligibility.programStatus","","","",1,1,"","","","CodeableConcept {[]} {[]}
","The patient's eligibility status for the program","Indicates the patient's eligility status for for a specific payment program.","","","","","","","","","",,"example","","http://hl7.org/fhir/ValueSet/immunization-program-eligibility|5.0.0","",,,,"Immunization.programEligibility.programStatus",1,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
","n/a"
"Immunization.fundingSource","Immunization.fundingSource","","","",0,1,"","","","CodeableConcept {[]} {[]}
","Funding source for the vaccine","Indicates the source of the vaccine actually administered. This may be different than the patient eligibility (e.g. the patient may be eligible for a publically purchased vaccine but due to inventory issues, vaccine purchased with private funds was actually administered).","","","","","","","","","",,"example","","http://hl7.org/fhir/ValueSet/immunization-funding-source|5.0.0","",,,,"Immunization.fundingSource",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
","N/A"
"Immunization.reaction","Immunization.reaction","","","",0,*,"","","","BackboneElement {[]} {[]}
","Details of a reaction that follows immunization","Categorical data indicating that an adverse event is associated in time to an immunization.","A reaction may be an indication of an allergy or intolerance and, if this is determined to be the case, it should be recorded as a new AllergyIntolerance resource instance as most systems will not query against past Immunization.reaction elements.","","","","","","","","",,,,,"",,,,"Immunization.reaction",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
","OBX-3","Observation[classCode=obs].code"
"Immunization.reaction.id","Immunization.reaction.id","","","",0,1,"","","","string {[]} {[]}
","Unique id for inter-element referencing","Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","","","","","","","","","",,,,,"",,,,"Element.id",0,1,"ele-1
","","n/a"
"Immunization.reaction.extension","Immunization.reaction.extension","","extensions
user content","",0,*,"","","","Extension {[]} {[]}
","Additional content defined by implementations","May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","","","","","","","","",,,,,"",,,,"Element.extension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}","n/a"
"Immunization.reaction.modifierExtension","Immunization.reaction.modifierExtension","","extensions
user contentmodifiers","",0,*,"","Y","Y","Extension {[]} {[]}
","Extensions that cannot be ignored even if unrecognized","May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored.  This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R5/extensibility.html#modifierExtension).","","","","","","","",,,,,"",,,,"BackboneElement.modifierExtension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}","N/A"
"Immunization.reaction.date","Immunization.reaction.date","","","",0,1,"","","","dateTime {[]} {[]}
","When reaction started","Date of reaction to the immunization.","","","","","","","","","",,,,,"",,,,"Immunization.reaction.date",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
","OBX-14 (ideally this would be reported in an IAM segment, but IAM is not part of the HL7 V2 VXU message - most likely would appear in OBX segments if at all)",".effectiveTime"
"Immunization.reaction.manifestation","Immunization.reaction.manifestation","","","",0,1,"","","","CodeableReference {[]} {[CanonicalType[http://hl7.org/fhir/StructureDefinition/Observation|5.0.0]]}
","Additional information on reaction","Details of the reaction.","","","","","","","","","",,,,,"",,,,"Immunization.reaction.manifestation",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
","OBX-5",".value"
"Immunization.reaction.reported","Immunization.reaction.reported","","","",0,1,"","","","boolean {[]} {[]}
","Indicates self-reported reaction","Self-reported indicator.","","","","","","","","","",,,,,"",,,,"Immunization.reaction.reported",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
","(HL7 V2 doesn't seem to provide for this)",".participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported=true)"
"Immunization.protocolApplied","Immunization.protocolApplied","","","",0,*,"","","","BackboneElement {[]} {[]}
","Protocol followed by the provider","The protocol (set of recommendations) being followed by the provider who administered the dose.","","","","","","","","","",,,,,"",,,,"Immunization.protocolApplied",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
","N/A"
"Immunization.protocolApplied.id","Immunization.protocolApplied.id","","","",0,1,"","","","string {[]} {[]}
","Unique id for inter-element referencing","Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.","","","","","","","","","",,,,,"",,,,"Element.id",0,1,"ele-1
","","n/a"
"Immunization.protocolApplied.extension","Immunization.protocolApplied.extension","","extensions
user content","",0,*,"","","","Extension {[]} {[]}
","Additional content defined by implementations","May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","","","","","","","","",,,,,"",,,,"Element.extension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}","n/a"
"Immunization.protocolApplied.modifierExtension","Immunization.protocolApplied.modifierExtension","","extensions
user contentmodifiers","",0,*,"","Y","Y","Extension {[]} {[]}
","Extensions that cannot be ignored even if unrecognized","May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).","There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions.  The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.","Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored.  This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R5/extensibility.html#modifierExtension).","","","","","","","",,,,,"",,,,"BackboneElement.modifierExtension",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
ext-1:Must have either extensions or value[x], not both {extension.exists() != value.exists()}","N/A"
"Immunization.protocolApplied.series","Immunization.protocolApplied.series","","","",0,1,"","","","string {[]} {[]}
","Name of vaccine series","One possible path to achieve presumed immunity against a disease - within the context of an authority.","","","","","","","","","",,,,,"",,,,"Immunization.protocolApplied.series",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
","N/A"
"Immunization.protocolApplied.authority","Immunization.protocolApplied.authority","","","",0,1,"","","","Reference {[]} {[CanonicalType[http://hl7.org/fhir/StructureDefinition/Organization|5.0.0]]}
","Who is responsible for publishing the recommendations","Indicates the authority who published the protocol (e.g. ACIP) that is being followed.","","","","","","","","","",,,,,"",,,,"Immunization.protocolApplied.authority",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
","N/A"
"Immunization.protocolApplied.targetDisease","Immunization.protocolApplied.targetDisease","","","",0,*,"","","","CodeableConcept {[]} {[]}
","Vaccine preventatable disease being targeted","The vaccine preventable disease the dose is being administered against.","","","","","","","","","",,"example","","http://hl7.org/fhir/ValueSet/immunization-target-disease|5.0.0","",,,,"Immunization.protocolApplied.targetDisease",0,*,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
","N/A"
"Immunization.protocolApplied.doseNumber","Immunization.protocolApplied.doseNumber","","","",1,1,"","","","string {[]} {[]}
","Dose number within series","Nominal position in a series as intended by the practitioner administering the dose.","The use of an integer is preferred if known. Text should only be used in cases where an integer is not available (such as when documenting a recurring booster dose).","","","","","","","","",,,,,"",,,,"Immunization.protocolApplied.doseNumber",1,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
","N/A"
"Immunization.protocolApplied.seriesDoses","Immunization.protocolApplied.seriesDoses","","","",0,1,"","","","string {[]} {[]}
","Recommended number of doses for immunity","The recommended number of doses to achieve immunity as intended by the practitioner administering the dose.","The use of an integer is preferred if known.","","","","","","","","",,,,,"",,,,"Immunization.protocolApplied.seriesDoses",0,1,"","ele-1:All FHIR elements must have a @value or children {hasValue() or (children().count() > id.count())}
","N/A"
