This is the set of resources that conform to either of the profiles Immunization (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Immunization-uv-ips) 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
Name Flags Card. Type Description & Constraints Filter: Bindings Constraints Obligations
Immunization 0..* Immunization event information Immunization. meta Σ This element is included in summaries. 0..1 Meta Metadata about the resource Immunization. implicitRules ?! This element is a modifier element. Σ This element is included in summaries. 0..1 uri A set of rules under which this content was created Immunization. language 0..1 code Language of the resource contentBinding: ?? ( preferred ) : A human language. Immunization. text 0..1 Narrative Text summary of the resource, for human interpretationThis profile does not constrain the narrative in regard to content, language, or traceability to data elements Immunization. contained 0..* Resource Contained, inline Resources Immunization. extension 0..* Extension Additional content defined by implementationsConstraints: ext-1 Immunization. modifierExtension ?! This element is a modifier element. 0..* Extension Extensions that cannot be ignoredConstraints: ext-1 Immunization. identifier 0..* Identifier Business identifier Immunization. status ?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries. 1..1 code completed | entered-in-error | not-doneBinding: ?? ( required ) : A set of codes indicating the current status of an Immunization. Immunization. statusReason S This element must be supported. 0..1 CodeableConcept Reason not doneBinding: ?? ( extensible ) : The reason why a vaccine was not administered. Immunization. vaccineCode S This element must be supported. Σ This element is included in summaries. 1..1 CodeableConcept left: Vaccine that was administered or was to be administered.Several kinds of vaccine product coding could be provided.
The IPS assumes that either the type of the vaccine for particular disease or diseases (e.g. MMR vaccine) against which the patient has been immunised is provided; or the known absent / unknown code.
Other coded information can be provided as well as: the IDMP Pharmaceutical Product Identifiers (PhPID), Medicinal Product Identifier (MPID), Packaged Medicinal Product Identifier (PCID), when available, or equivalent coded concepts; the WHO ATC codes; or any other kind of code that that identifies, classifies or cluster the administered product.; right: Vaccine Product Type (bind to CVX)Binding: ?? ( extensible ) : The type of vaccine for particular disease or diseases against which the patient has been immunised, or a code for absent/unknown immunization. Immunization. patient S This element must be supported. Σ This element is included in summaries. 1..1 Reference (Patient (IPS)(2.0.1) | #sd-2214-Patient-uv-ips-us-core-patient )Who was immunized Immunization.patient. extension 0..* Extension Additional content defined by implementationsSlice: Unordered, Open by value:urlConstraints: ext-1 Immunization.patient. reference SO This element has obligations and must be supported. Σ This element is included in summaries. C 1..1 string Literal reference, Relative, internal or absolute URLObligations Actor Source SHALL :populate-if-known Creator (IPS) from Immunization (IPS) SHALL :handle Consumer (IPS) from Immunization (IPS)
Immunization.patient. type Σ This element is included in summaries. 0..1 uri Type the reference refers to (e.g. "Patient")Binding: ?? ( extensible ) : Aa resource (or, for logical models, the URI of the logical model). Immunization.patient. identifier Σ This element is included in summaries. 0..1 Identifier Logical reference, when literal reference is not known Immunization.patient. display Σ This element is included in summaries. 0..1 string Text alternative for the resource Immunization. encounter S This element must be supported. 0..1 Reference (Encounter )left: Encounter immunization was part of; right: Encounter the immunization was part of Immunization. occurrence[x] S This element must be supported. Σ This element is included in summaries. 1..1 Vaccine administration date Immunization.occurrence[x]. occurrenceDateTime dateTime Immunization.occurrence[x]. occurrenceString string Immunization. recorded 0..1 dateTime When the immunization was first captured in the subject's record Immunization. primarySource S This element must be supported. Σ This element is included in summaries. 0..1 boolean Indicates context the data was recorded in Immunization. reportOrigin 0..1 CodeableConcept Indicates the source of a secondarily reported recordBinding: ?? ( example ) : The source of the data for a record which is not from a primary source. Immunization. location S This element must be supported. 0..1 Reference (Location )left: Where immunization occurred; right: Where the vaccine was administered Immunization. manufacturer 0..1 Reference (Organization )Vaccine manufacturer Immunization. lotNumber S This element must be supported. 0..1 string Vaccine lot number Immunization. expirationDate 0..1 date Vaccine expiration date Immunization. site 0..1 CodeableConcept Body site vaccine was administeredBinding: ?? ( preferred ) : The site at which the vaccine was administered. Immunization. route 0..1 CodeableConcept How vaccine entered bodyBinding: ?? ( preferred ) : left: SNOMED Route Terms; right: The route by which the vaccine was administered. Immunization. doseQuantity 0..1 ?? Amount of vaccine administered Immunization. performer S This element must be supported. Σ This element is included in summaries. 0..* BackboneElement Who performed event Immunization.performer. extension 0..* Extension Additional content defined by implementationsConstraints: ext-1 Immunization.performer. modifierExtension ?! This element is a modifier element. Σ This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognizedConstraints: ext-1 Immunization.performer. function Σ This element is included in summaries. 0..1 CodeableConcept What type of performance was doneBinding: ?? ( extensible ) : The role a practitioner or organization plays in the immunization event. Immunization.performer. actor S This element must be supported. Σ This element is included in summaries. 1..1 Reference (Practitioner | PractitionerRole | Organization )Individual or organization who was performing Immunization. note Σ This element is included in summaries. 0..* Annotation Additional immunization notes Immunization. reasonCode 0..* CodeableConcept Why immunization occurredBinding: ?? ( example ) : The reason why a vaccine was administered. Immunization. reasonReference 0..* Reference (Condition | Observation | DiagnosticReport )Why immunization occurred Immunization. isSubpotent ?! This element is a modifier element. Σ This element is included in summaries. 0..1 boolean Dose potency Immunization. subpotentReason 0..* CodeableConcept Reason for being subpotentBinding: ?? ( example ) : The reason why a dose is considered to be subpotent. Immunization. education C 0..* BackboneElement Educational material presented to patientConstraints: imm-1 Immunization.education. extension 0..* Extension Additional content defined by implementationsConstraints: ext-1 Immunization.education. modifierExtension ?! This element is a modifier element. Σ This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognizedConstraints: ext-1 Immunization.education. documentType 0..1 string Educational material document identifier Immunization.education. reference 0..1 uri Educational material reference pointer Immunization.education. publicationDate 0..1 dateTime Educational material publication date Immunization.education. presentationDate 0..1 dateTime Educational material presentation date Immunization. programEligibility 0..* CodeableConcept Patient eligibility for a vaccination programBinding: ?? ( example ) : The patient's eligibility for a vaccation program. Immunization. fundingSource 0..1 CodeableConcept Funding source for the vaccineBinding: ?? ( example ) : The source of funding used to purchase the vaccine administered. Immunization. reaction 0..* BackboneElement Details of a reaction that follows immunization Immunization.reaction. extension 0..* Extension Additional content defined by implementationsConstraints: ext-1 Immunization.reaction. modifierExtension ?! This element is a modifier element. Σ This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognizedConstraints: ext-1 Immunization.reaction. date 0..1 dateTime When reaction started Immunization.reaction. detail 0..1 Reference (Observation )Additional information on reaction Immunization.reaction. reported 0..1 boolean Indicates self-reported reaction Immunization. protocolApplied 0..* BackboneElement Protocol followed by the provider Immunization.protocolApplied. extension 0..* Extension Additional content defined by implementationsConstraints: ext-1 Immunization.protocolApplied. modifierExtension ?! This element is a modifier element. Σ This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognizedConstraints: ext-1 Immunization.protocolApplied. series 0..1 string Name of vaccine series Immunization.protocolApplied. authority 0..1 Reference (Organization )Who is responsible for publishing the recommendations Immunization.protocolApplied. targetDisease 0..* CodeableConcept left: Vaccine preventable disease being targeted; right: Vaccine preventatable disease being targettedBinding: ?? ( preferred ) : left: The particular disease or diseases against which the patient has been immunized.; right: The vaccine preventable disease the dose is being administered for. Immunization.protocolApplied. doseNumber[x] 1..1 Dose number within series Immunization.protocolApplied.doseNumber[x]. doseNumberPositiveInt positiveInt Immunization.protocolApplied.doseNumber[x]. doseNumberString string Immunization.protocolApplied. seriesDoses[x] 0..1 Recommended number of doses for immunity Immunization.protocolApplied.seriesDoses[x]. seriesDosesPositiveInt positiveInt Immunization.protocolApplied.seriesDoses[x]. seriesDosesString string
Immunization 
meta 
implicitRules 
contained 
extension 
modifierExtension 
patient 
occurrence[x] 
