Union of http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization and http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization

This is the set of resources that conform to either of the profiles US Core Immunization Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization) and US Core Immunization Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization). E.g. what you have to deal with if you get resources conforming to one of them

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization C0..*Immunization event information
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
us-core-5: SHOULD have a translation to the NDC value set
... meta Σ0..1MetaMetadata about the resource
ele-1: All FHIR elements must have a @value or children
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... language 0..1codeLanguage of the resource content
Binding: ?? (preferred): A human language.


ele-1: All FHIR elements must have a @value or children
... text 0..1NarrativeText summary of the resource, for human interpretation
ele-1: All FHIR elements must have a @value or children
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... identifier 0..*IdentifierBusiness identifier
ele-1: All FHIR elements must have a @value or children
... status ?!SΣ1..1codecompleted | entered-in-error | not-done
Binding: ?? (required)
ele-1: All FHIR elements must have a @value or children
... statusReason S0..1CodeableConceptReason not done
Binding: ?? (example)
ele-1: All FHIR elements must have a @value or children
... vaccineCode SΣ1..1CodeableConceptVaccine Product Type (bind to CVX)
Binding: ?? (extensible)
ele-1: All FHIR elements must have a @value or children
... patient SΣ1..1Reference(US Core Patient Profile | #sd-us-core-patient-us-core-patient)Who was immunized
ele-1: All FHIR elements must have a @value or children
... encounter S0..1Reference(Encounter)left: Encounter immunization was part of; right: Encounter the immunization was part of
ele-1: All FHIR elements must have a @value or children
... occurrence[x] SΣ1..1Vaccine administration date
ele-1: All FHIR elements must have a @value or children
.... occurrenceDateTimedateTime S
.... occurrenceStringstring
... recorded 0..1dateTimeWhen the immunization was first captured in the subject's record
ele-1: All FHIR elements must have a @value or children
... primarySource SΣ0..1booleanIndicates context the data was recorded in
ele-1: All FHIR elements must have a @value or children
... reportOrigin 0..1CodeableConceptIndicates the source of a secondarily reported record
Binding: ?? (example): The source of the data for a record which is not from a primary source.


ele-1: All FHIR elements must have a @value or children
... location S0..1Reference(Location)left: Where immunization occurred; right: Where the vaccine was administered
ele-1: All FHIR elements must have a @value or children
... manufacturer 0..1Reference(Organization)Vaccine manufacturer
ele-1: All FHIR elements must have a @value or children
... lotNumber 0..1stringVaccine lot number
ele-1: All FHIR elements must have a @value or children
... expirationDate 0..1dateVaccine expiration date
ele-1: All FHIR elements must have a @value or children
... site 0..1CodeableConceptBody site vaccine was administered
Binding: ?? (example): The site at which the vaccine was administered.


ele-1: All FHIR elements must have a @value or children
... route 0..1CodeableConceptHow vaccine entered body
Binding: ?? (example): The route by which the vaccine was administered.


ele-1: All FHIR elements must have a @value or children
... doseQuantity 0..1??Amount of vaccine administered
ele-1: All FHIR elements must have a @value or children
... performer Σ0..*BackboneElementWho performed event
ele-1: All FHIR elements must have a @value or children
.... extension 0..*ExtensionAdditional content defined by implementations
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... function Σ0..1CodeableConceptWhat type of performance was done
Binding: ?? (extensible): The role a practitioner or organization plays in the immunization event.


ele-1: All FHIR elements must have a @value or children
.... actor Σ1..1Reference(Practitioner | PractitionerRole | Organization)Individual or organization who was performing
ele-1: All FHIR elements must have a @value or children
... note Σ0..*AnnotationAdditional immunization notes
ele-1: All FHIR elements must have a @value or children
... reasonCode 0..*CodeableConceptWhy immunization occurred
Binding: ?? (example): The reason why a vaccine was administered.


ele-1: All FHIR elements must have a @value or children
... reasonReference 0..*Reference(Condition | Observation | DiagnosticReport)Why immunization occurred
ele-1: All FHIR elements must have a @value or children
... isSubpotent ?!Σ0..1booleanDose potency
ele-1: All FHIR elements must have a @value or children
... subpotentReason 0..*CodeableConceptReason for being subpotent
Binding: ?? (example): The reason why a dose is considered to be subpotent.


ele-1: All FHIR elements must have a @value or children
... education C0..*BackboneElementEducational material presented to patient
ele-1: All FHIR elements must have a @value or children
imm-1: One of documentType or reference SHALL be present
.... extension 0..*ExtensionAdditional content defined by implementations
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... documentType 0..1stringEducational material document identifier
ele-1: All FHIR elements must have a @value or children
.... reference 0..1uriEducational material reference pointer
ele-1: All FHIR elements must have a @value or children
.... publicationDate 0..1dateTimeEducational material publication date
ele-1: All FHIR elements must have a @value or children
.... presentationDate 0..1dateTimeEducational material presentation date
ele-1: All FHIR elements must have a @value or children
... programEligibility 0..*CodeableConceptPatient eligibility for a vaccination program
Binding: ?? (example): The patient's eligibility for a vaccation program.


ele-1: All FHIR elements must have a @value or children
... fundingSource 0..1CodeableConceptFunding source for the vaccine
Binding: ?? (example): The source of funding used to purchase the vaccine administered.


ele-1: All FHIR elements must have a @value or children
... reaction 0..*BackboneElementDetails of a reaction that follows immunization
ele-1: All FHIR elements must have a @value or children
.... extension 0..*ExtensionAdditional content defined by implementations
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... date 0..1dateTimeWhen reaction started
ele-1: All FHIR elements must have a @value or children
.... detail 0..1Reference(Observation)Additional information on reaction
ele-1: All FHIR elements must have a @value or children
.... reported 0..1booleanIndicates self-reported reaction
ele-1: All FHIR elements must have a @value or children
... protocolApplied 0..*BackboneElementProtocol followed by the provider
ele-1: All FHIR elements must have a @value or children
.... extension 0..*ExtensionAdditional content defined by implementations
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... series 0..1stringName of vaccine series
ele-1: All FHIR elements must have a @value or children
.... authority 0..1Reference(Organization)Who is responsible for publishing the recommendations
ele-1: All FHIR elements must have a @value or children
.... targetDisease 0..*CodeableConceptVaccine preventatable disease being targetted
Binding: ?? (example): The vaccine preventable disease the dose is being administered for.


ele-1: All FHIR elements must have a @value or children
.... doseNumber[x] 1..1Dose number within series
ele-1: All FHIR elements must have a @value or children
..... doseNumberPositiveIntpositiveInt
..... doseNumberStringstring
.... seriesDoses[x] 0..1Recommended number of doses for immunity
ele-1: All FHIR elements must have a @value or children
..... seriesDosesPositiveIntpositiveInt
..... seriesDosesStringstring

doco Documentation for this format