Pan-Canadian Patient Summary (PS-CA) CI Build

Profile

Extensions

Key Differences between the IPS-UV and PS-CA

DFT - For a full list of available versions, see the Directory of published versions

Releases of the PS-CA Implementation Guide may be found on a table on the Home Page of this Project.

Immunization (PS-CA)

Additional information on this profile (including the JSON & XML structure and detailed element descriptions) can be found at Immunization (PS-CA)

Profile

ImmunizationPSCA (Immunization)	I		Immunization	There are no (further) constraints on this element Element id Immunization Short description Immunization event information Definition 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. Data type Immunization Constraints 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().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: 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() Mappings rim: Entity. Role, or Act workflow: Event v2: VXU_V04 rim: SubstanceAdministration
id	Σ	0..1	string	There are no (further) constraints on this element Element id Immunization.id Short description Logical id of this artifact Definition The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Data type string
meta	Σ	0..1	Meta	There are no (further) constraints on this element Element id Immunization.meta Short description Metadata about the resource Definition 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. Data type Meta Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
implicitRules	Σ ?!	0..1	uri	There are no (further) constraints on this element Element id Immunization.implicitRules Short description A set of rules under which this content was created Definition 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. Comments 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 it's narrative along with other profiles, value sets, etc. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
language		0..1	codeBinding	There are no (further) constraints on this element Element id Immunization.language Short description Language of the resource content Definition The base language in which the resource is written. Comments 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). Data type code Binding A human language. CommonLanguages (preferred) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())`
text		0..1	Narrative	There are no (further) constraints on this element Element id Immunization.text Short description Text summary of the resource, for human interpretation Alternate names narrative, html, xhtml, display Definition 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. Comments Contained resources do not have 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. Data type Narrative Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: Act.text?
contained		0..*	Resource	There are no (further) constraints on this element Element id Immunization.contained Short description Contained, inline Resources Alternate names inline resources, anonymous resources, contained resources Definition These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. Comments 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. Data type Resource Mappings rim: N/A
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Immunization.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition 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 manageable, 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. Comments 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. Data type Extension Constraints 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()` Mappings rim: N/A
modifierExtension	?! I	0..*	Extension	There are no (further) constraints on this element Element id Immunization.modifierExtension Short description Extensions that cannot be ignored Alternate names extensions, user content Definition 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 manageable, 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). Requirements 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. Comments 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. Data type Extension Constraints 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()` Mappings rim: N/A
identifier		0..*	Identifier	There are no (further) constraints on this element Element id Immunization.identifier Short description Business identifier Definition A unique identifier assigned to this immunization record. Data type Identifier Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Event.identifier w5: FiveWs.identifier rim: .id cda: ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/id
status	S Σ ?!	1..1	codeBinding	There are no (further) constraints on this element Element id Immunization.status Short description completed \| entered-in-error \| not-done Definition Indicates the current status of the immunization event. Comments 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. Data type code Binding A set of codes indicating the current status of an Immunization. ImmunizationStatusCodes (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Event.status w5: FiveWs.status rim: statusCode
statusReason		0..1	CodeableConcept	There are no (further) constraints on this element Element id Immunization.statusReason Short description Reason not done Definition Indicates the reason the immunization event was not performed. Comments This is generally only used for the status of "not-done". The reason for performing the immunization event is captured in reasonCode, not here. Data type CodeableConcept Binding The reason why a vaccine was not administered. ImmunizationStatusReasonCodes (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Event.statusReason rim: .inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN].reasonCOde
vaccineCode	S Σ	1..1	CodeableConceptBinding	Element id Immunization.vaccineCode Short description Vaccine that was administered or was to be administered. IPS-UV Note: 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 Pharmaceutical and medicinal product identifiers, 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. Definition Vaccine that was administered or was to be administered. Comments See additionalBinding extension. Future releases of PS-CA may require use of coded entries. In this release, however, implementations that support codings are encouraged to send the codings for codeable concepts if they are available. Consistent with FHIR best practice, receivers should not produce failures or rejections if codings are received. Vendors should expect that some jurisdictions may further constrain support of this element within the context of their own jurisdictional content. IPS-UV Note: 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 immunized is provided; or the known absent/unknown. Other coded information can be provided as well as: The IDMP Pharmaceutical Product Identifier (PhPID), Level 1, [Substance(s)]. Example: Amoxicillin and Clavulanate Potassium; or any other equivalent coded concept. The IDMP Pharmaceutical Product Identifier (PhPID), Level 2 [Substance(s) + Strength + reference strength]. Example: Amoxicillin 875 mg and Clavulanate Potassium 125 mg; or any other equivalent coded concept. The IDMP Pharmaceutical Product Identifier (PhPID), Level 3 [Substance(s) + administrable dose form]. Example: Amoxicillin and Clavulanate Potassium, Oral Tablet; or any other equivalent coded concept. The IDMP Pharmaceutical Product Identifier (PhPID), Level 4 [Substance(s) + strength + reference strength + administrable dose form]. Example: Amoxicillin 875 mg and clavulanate potassium 125 mg, oral tablet; or any other equivalent coded concept. The IDMP Medicinal Product Identifier (MPID) or any equivalent Medicinal Product Identifier. IDMP MPID uniquely identifies a Medicinal Product, reflecting (but not replacing) any other authorization numbers allocated by a regulator. MPID implies one (set of) PhPID. The MPID shall use a common segment pattern related to a Medicinal Product, which, when each segment is valued shall define a specific MPID concept. The IDMP Packaged Medicinal Product Identifier (PCID) or any equivalent Packaged Medicinal Product Identifier. Uniquely identifies a Medicinal Product based on its packaging. This implies one MPID can be associated with more than one PCID, if the same Medicinal Product has more than one type of package. Any other kind of code that that identifies, classifies or clusters the administered product (e.g. the medicinal product or the product class). The value sets used for the PhPID, MPID and PCID identifiers are provisional and include only few equivalent concepts used for exemplification purposes, they will be updated with real IDMP identifiers when they will become available. Data type CodeableConcept Binding Codes from the National Vaccine Catalogue Vaccine Administered Trade Name Code ValueSet. Equivalently preferred to the Vaccine Historical Name Code ValueSet, Passive Administered Immunizing Agent Code ValueSet, or Passive Historical Immunizing Agent Code ValueSet found in additionalBinding extension VaccineAdministeredTradeNameCode (preferred) Additional bindings: VaccineHistoricalNameCode (preferred) Equivalently recommended for use when conveying vaccine generic names for scenarios when brand name is not known or does not exist (e.g., immunization history where provider does not have detail of the trade name, the product has been discontinued and/or never licensed in Canada). PassiveAdministeredImmunizingAgentCode (preferred) Equivalently recommended for use when conveying when passive immunization products are used. PassiveHistoricalImmunizingAgentCode (preferred) Equivalently recommended for use when conveying when passive immunization products are used. VaccinesUvIps (candidate) IPS Vaccine codes value set. This value set includes codes from SNOMED CT. WhoAtcUvIps (candidate) Code that is selected from the WHO ATC classification. http://hl7.org/fhir/uv/ips/ValueSet/absent-or-unknown-immunizations-uv-ips (candidate) Code to identify absent or unknown immunizations. Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Event.code w5: FiveWs.what[x] v2: RXA-5 rim: .code cda: ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/realmCode/code
patient	S Σ	1..1	Reference(PatientPSCA)	Element id Immunization.patient Short description Who was immunized Definition The patient who either received or did not receive the immunization. Data type Reference(PatientPSCA) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Event.subject w5: FiveWs.subject[x] v2: PID-3 rim: .partipication[ttypeCode=].role w5: FiveWs.subject
id		0..1	string	There are no (further) constraints on this element Element id Immunization.patient.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Immunization.patient.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition 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 manageable, 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. Comments 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints 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()` Mappings rim: n/a
reference	S Σ I	1..1	string	There are no (further) constraints on this element Element id Immunization.patient.reference Short description Literal reference, Relative, internal or absolute URL Definition A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Comments Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A
type	Σ	0..1	uriBinding	There are no (further) constraints on this element Element id Immunization.patient.type Short description Type the reference refers to (e.g. "Patient") Definition The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). Comments This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. Data type uri Binding Aa resource (or, for logical models, the URI of the logical model). ResourceType (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A
identifier	Σ	0..1	Identifier	There are no (further) constraints on this element Element id Immunization.patient.identifier Short description Logical reference, when literal reference is not known Definition An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. Comments When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation\|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). Data type Identifier Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: .identifier
display	Σ	0..1	string	There are no (further) constraints on this element Element id Immunization.patient.display Short description Text alternative for the resource Definition Plain text narrative that identifies the resource in addition to the resource reference. Comments This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A
encounter		0..1	Reference(Encounter)	There are no (further) constraints on this element Element id Immunization.encounter Short description Encounter immunization was part of Definition The visit or admission or other contact between patient and health care provider the immunization was performed as part of. Data type Reference(Encounter) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Event.context w5: FiveWs.context v2: PV1-19 rim: component->EncounterEvent
occurrence[x]	S Σ	1..1		There are no (further) constraints on this element Element id Immunization.occurrence[x] Short description Vaccine administration date Definition Date vaccine administered or was to be administered. Comments 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. Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Event.occurrence[x] w5: FiveWs.done[x] v2: RXA-3 rim: .effectiveTime cda: ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/effectiveTime/value
id		0..1	string	There are no (further) constraints on this element Element id Immunization.occurrence[x].id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Immunization.occurrence[x].extension Short description Additional content defined by implementations Alternate names extensions, user content Definition 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 manageable, 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. Comments 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. Data type Extension Sliced: Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints 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()` Mappings rim: n/a
data-absent-reason	S I	0..1	Extension(code)	Element id Immunization.occurrence[x].extension:data-absent-reason Short description occurrence[x] absence reason Alternate names extensions, user content Definition Provides a reason why the occurrence is missing. Comments 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. Data type Extension(code) Extension URL http://hl7.org/fhir/StructureDefinition/data-absent-reason Constraints 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()` Mappings rim: n/a rim: ANY.nullFlavor
occurrenceDateTime			dateTime	There are no (further) constraints on this element Data type dateTime
occurrenceString			string	There are no (further) constraints on this element Data type string
recorded		0..1	dateTime	There are no (further) constraints on this element Element id Immunization.recorded Short description When the immunization was first captured in the subject's record Definition The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event. Data type dateTime Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.recorded rim: .participation[typeCode=AUT].time
primarySource	Σ	0..1	boolean	There are no (further) constraints on this element Element id Immunization.primarySource Short description Indicates context the data was recorded in Definition An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded. Comments Reflects the “reliability” of the content. Data type boolean Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.source v2: RXA-9 rim: immunization.uncertaintycode (if primary source=false, uncertainty=U)
reportOrigin		0..1	CodeableConcept	There are no (further) constraints on this element Element id Immunization.reportOrigin Short description Indicates the source of a secondarily reported record Definition The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine. Comments Should not be populated if primarySource = True, not required even if primarySource = False. Data type CodeableConcept Binding The source of the data for a record which is not from a primary source. ImmunizationOriginCodes (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings w5: FiveWs.source v2: RXA-9 rim: .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)
location		0..1	Reference(Location)	There are no (further) constraints on this element Element id Immunization.location Short description Where immunization occurred Definition The service delivery location where the vaccine administration occurred. Data type Reference(Location) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Event.location w5: FiveWs.where[x] v2: RXA-27 (or RXA-11, deprecated as of v2.7) rim: .participation[typeCode=LOC].COCT_MT240000UV
manufacturer		0..1	Reference(Organization)	There are no (further) constraints on this element Element id Immunization.manufacturer Short description Vaccine manufacturer Definition Name of vaccine manufacturer. Data type Reference(Organization) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: RXA-17 rim: .participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=ORG] cda: ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacuturerOrganization/name
lotNumber		0..1	string	There are no (further) constraints on this element Element id Immunization.lotNumber Short description Vaccine lot number Definition Lot number of the vaccine product. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: RXA-15 rim: .participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].id cda: ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/lotNumberText
expirationDate		0..1	date	There are no (further) constraints on this element Element id Immunization.expirationDate Short description Vaccine expiration date Definition Date vaccine batch expires. Data type date Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: RXA-16 rim: .participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].expirationTime
site		0..1	CodeableConceptPSCA	Element id Immunization.site Short description Concept - reference to a terminology or just text Definition A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. Comments The development of a FHIR ValueSet & Terminology Gateway subset for this element is underway. Given that the migration of terminology from the CVC to NVC is underway, and that this element is no longer MS in PS-CA or IPS, the profiling on this binding has been temporarily removed and will be reapplied in future updates once there is an established subset to point to. Data type CodeableConceptPSCA Binding The site at which the vaccine was administered. CodesForImmunizationSiteOfAdministration (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: RXR-2 rim: observation.targetSiteCode cda: ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/approachSiteCode/code rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
route		0..1	CodeableConceptPSCABinding	Element id Immunization.route Short description Concept - reference to a terminology or just text Definition A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. Comments See additionalBinding extension. IPS-UV no longer flags this as a Must Support element. It is not currently flagged as Must Support in PS-CA, as stakeholders have indicated the element may not be supported by the majority of systems today. Systems that do support the element are encouraged to include it in generated Patient Summary documents, and support it when received. Future releases of PS-CA may require use of coded entries. In this release, however, implementations that support codings are encouraged to send the codings for codeable concepts if they are available. Consistent with FHIR best practice, receivers should not produce failures or rejections if codings are received. Data type CodeableConceptPSCA Binding The route by which the vaccine was administered. ImmunizationRouteOfAdministrationCode (preferred) Additional bindings: MedicineRouteOfAdministrationUvIps (candidate) Route of immunization administration includes content from EDQM Standard Terms. v3.RouteOfAdministration (candidate) The path the administered medication takes to get into the body or into contact with the body. While not the preferred terminology for broader pan-Canadian exchange use cases, this additional binding is surfaced to socialize the value sets that may be more commonly in use. Where multiple codings can be supplied, it is encouraged to supply the original coding alongside the pan-Canadian preferred terminology. Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: RXR-1 rim: .routeCode cda: ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/routeCode/code rim: n/a v2: CE/CNE/CWE rim: CD orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
doseQuantity		0..1	SimpleQuantity	There are no (further) constraints on this element Element id Immunization.doseQuantity Short description Amount of vaccine administered Definition The quantity of vaccine product that was administered. Data type SimpleQuantity Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: RXA-6 / RXA-7 rim: .doseQuantity
performer	Σ	0..*	BackboneElement	There are no (further) constraints on this element Element id Immunization.performer Short description Who performed event Definition Indicates who performed the immunization event. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Event.performer v2: ORC-12 / RXA-10 rim: .participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]
id		0..1	string	There are no (further) constraints on this element Element id Immunization.performer.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Immunization.performer.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition 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 manageable, 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. Comments 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. Data type Extension Constraints 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()` Mappings rim: n/a
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id Immunization.performer.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition 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 manageable, 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). Requirements 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. Comments 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. Data type Extension Constraints 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()` Mappings rim: N/A
function	Σ	0..1	CodeableConceptBinding	There are no (further) constraints on this element Element id Immunization.performer.function Short description What type of performance was done Definition Describes the type of performance (e.g. ordering provider, administering provider, etc.). Data type CodeableConcept Binding The role a practitioner or organization plays in the immunization event. ImmunizationFunctionCodes (extensible) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Event.performer.function rim: .participation.functionCode
actor	Σ	1..1	Reference(Practitioner \| PractitionerRole \| Organization)	There are no (further) constraints on this element Element id Immunization.performer.actor Short description Individual or organization who was performing Definition The practitioner or organization who performed the action. Comments When the individual practitioner who performed the action is known, it is best to send. Data type Reference(Practitioner \| PractitionerRole \| Organization) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Event.performer.actor w5: FiveWs.actor rim: .player
note	Σ	0..*	Annotation	There are no (further) constraints on this element Element id Immunization.note Short description Additional immunization notes Definition Extra information about the immunization that is not conveyed by the other attributes. Data type Annotation Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Event.note v2: OBX-5 : OBX-3 = 48767-8 rim: note
reasonCode		0..*	CodeableConcept	There are no (further) constraints on this element Element id Immunization.reasonCode Short description Why immunization occurred Definition Reasons why the vaccine was administered. Data type CodeableConcept Binding The reason why a vaccine was administered. ImmunizationReasonCodes (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Event.reasonCode rim: [actionNegationInd=false].reasonCode
reasonReference		0..*	Reference(Condition \| Observation \| DiagnosticReport)	There are no (further) constraints on this element Element id Immunization.reasonReference Short description Why immunization occurred Definition Condition, Observation or DiagnosticReport that supports why the immunization was administered. Data type Reference(Condition \| Observation \| DiagnosticReport) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings workflow: Event.reasonReference rim: N/A
isSubpotent	Σ ?!	0..1	boolean	There are no (further) constraints on this element Element id Immunization.isSubpotent Short description Dose potency Definition Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent. Comments 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. Meaning when missing By default, a dose should be considered to be potent. Data type boolean Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: RXA-20 = PA (partial administration) rim: N/A
subpotentReason		0..*	CodeableConcept	There are no (further) constraints on this element Element id Immunization.subpotentReason Short description Reason for being subpotent Definition Reason why a dose is considered to be subpotent. Data type CodeableConcept Binding The reason why a dose is considered to be subpotent. ImmunizationSubpotentReason (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A
education	I	0..*	BackboneElement	There are no (further) constraints on this element Element id Immunization.education Short description Educational material presented to patient Definition Educational material presented to the patient (or guardian) at the time of vaccine administration. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` imm-1: One of documentType or reference SHALL be present `documentType.exists() or reference.exists()` Mappings rim: N/A
id		0..1	string	There are no (further) constraints on this element Element id Immunization.education.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Immunization.education.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition 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 manageable, 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. Comments 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. Data type Extension Constraints 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()` Mappings rim: n/a
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id Immunization.education.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition 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 manageable, 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). Requirements 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. Comments 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. Data type Extension Constraints 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()` Mappings rim: N/A
documentType		0..1	string	There are no (further) constraints on this element Element id Immunization.education.documentType Short description Educational material document identifier Definition Identifier of the material presented to the patient. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: OBX-5 : OBX-3 = 69764-9 rim: N/A
reference		0..1	uri	There are no (further) constraints on this element Element id Immunization.education.reference Short description Educational material reference pointer Definition Reference pointer to the educational material given to the patient if the information was on line. Data type uri Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A
publicationDate		0..1	dateTime	There are no (further) constraints on this element Element id Immunization.education.publicationDate Short description Educational material publication date Definition Date the educational material was published. Data type dateTime Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: OBX-5 : OBX-3 = 29768-9 rim: N/A
presentationDate		0..1	dateTime	There are no (further) constraints on this element Element id Immunization.education.presentationDate Short description Educational material presentation date Definition Date the educational material was given to the patient. Data type dateTime Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: OBX-5 : OBX-3 = 29769-7 rim: N/A
programEligibility		0..*	CodeableConcept	There are no (further) constraints on this element Element id Immunization.programEligibility Short description Patient eligibility for a vaccination program Definition Indicates a patient's eligibility for a funding program. Data type CodeableConcept Binding The patient's eligibility for a vaccation program. ImmunizationProgramEligibility (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: OBX-5 : OBX-3 = 64994-7 rim: N/A
fundingSource		0..1	CodeableConcept	There are no (further) constraints on this element Element id Immunization.fundingSource Short description Funding source for the vaccine Definition 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). Data type CodeableConcept Binding The source of funding used to purchase the vaccine administered. ImmunizationFundingSource (example) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A
reaction		0..*	BackboneElement	There are no (further) constraints on this element Element id Immunization.reaction Short description Details of a reaction that follows immunization Definition Categorical data indicating that an adverse event is associated in time to an immunization. Comments 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. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: OBX-3 rim: Observation[classCode=obs].code
id		0..1	string	There are no (further) constraints on this element Element id Immunization.reaction.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Immunization.reaction.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition 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 manageable, 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. Comments 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. Data type Extension Constraints 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()` Mappings rim: n/a
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id Immunization.reaction.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition 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 manageable, 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). Requirements 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. Comments 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. Data type Extension Constraints 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()` Mappings rim: N/A
date		0..1	dateTime	There are no (further) constraints on this element Element id Immunization.reaction.date Short description When reaction started Definition Date of reaction to the immunization. Data type dateTime Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: 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) rim: .effectiveTime
detail		0..1	Reference(Observation)	There are no (further) constraints on this element Element id Immunization.reaction.detail Short description Additional information on reaction Definition Details of the reaction. Data type Reference(Observation) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: OBX-5 rim: .value
reported		0..1	boolean	There are no (further) constraints on this element Element id Immunization.reaction.reported Short description Indicates self-reported reaction Definition Self-reported indicator. Data type boolean Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings v2: (HL7 v2 doesn't seem to provide for this) rim: .participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported=true)
protocolApplied		0..*	BackboneElement	There are no (further) constraints on this element Element id Immunization.protocolApplied Short description Protocol followed by the provider Definition The protocol (set of recommendations) being followed by the provider who administered the dose. Data type BackboneElement Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A
id		0..1	string	There are no (further) constraints on this element Element id Immunization.protocolApplied.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	I	0..*	Extension	There are no (further) constraints on this element Element id Immunization.protocolApplied.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition 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 manageable, 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. Comments 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. Data type Extension Constraints 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()` Mappings rim: n/a
modifierExtension	Σ ?! I	0..*	Extension	There are no (further) constraints on this element Element id Immunization.protocolApplied.modifierExtension Short description Extensions that cannot be ignored even if unrecognized Alternate names extensions, user content, modifiers Definition 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 manageable, 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). Requirements 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. Comments 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. Data type Extension Constraints 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()` Mappings rim: N/A
series		0..1	string	There are no (further) constraints on this element Element id Immunization.protocolApplied.series Short description Name of vaccine series Definition One possible path to achieve presumed immunity against a disease - within the context of an authority. Data type string Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A
authority		0..1	Reference(Organization)	There are no (further) constraints on this element Element id Immunization.protocolApplied.authority Short description Who is responsible for publishing the recommendations Definition Indicates the authority who published the protocol (e.g. ACIP) that is being followed. Data type Reference(Organization) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A
targetDisease		0..*	CodeableConceptBinding	Element id Immunization.protocolApplied.targetDisease Short description Vaccine preventatable disease being targetted Definition The vaccine preventable disease the dose is being administered against. Comments See additionalBinding extension. IPS-UV no longer flags this as a Must Support element. It is not currently flagged as Must Support in PS-CA, as stakeholders have indicated the element may not be supported by the majority of systems today. Systems that do support the element are encouraged to include it in generated Patient Summary documents, and support it when received. Data type CodeableConcept Binding The vaccine preventable disease the dose is being administered for. VaccinePreventableDiseaseCode (preferred) Additional bindings: VaccineTargetDiseasesUvIps (candidate) IPS Vaccine target disease codes value set. This value set includes codes from SNOMED CT Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A
doseNumber[x]		1..1		There are no (further) constraints on this element Element id Immunization.protocolApplied.doseNumber[x] Short description Dose number within series Definition Nominal position in a series. Comments The use of an integer is preferred if known. A string should only be used in cases where an integer is not available (such as when documenting a recurring booster dose). Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A
doseNumberPositiveInt			positiveInt	There are no (further) constraints on this element Data type positiveInt
doseNumberString			string	There are no (further) constraints on this element Data type string
seriesDoses[x]		0..1		There are no (further) constraints on this element Element id Immunization.protocolApplied.seriesDoses[x] Short description Recommended number of doses for immunity Definition The recommended number of doses to achieve immunity. Comments The use of an integer is preferred if known. A string should only be used in cases where an integer is not available (such as when documenting a recurring booster dose). Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A
seriesDosesPositiveInt			positiveInt	There are no (further) constraints on this element Data type positiveInt
seriesDosesString			string	There are no (further) constraints on this element Data type string

Extensions

This profile uses the following extensions:

Immunization.occurrence[x]: data-absent-reason

Key Differences between the IPS-UV and PS-CA

Must Support Differences:

The following elements are considered Must Support in the Immunization (IPS) profile that are relaxed in this version of the PS-CA profile:

Immunization.occurrence[x]: data-absent-reason

Note: Systems that support these elements are encouraged to send them in patient summaries

Cardinality Differences:

There are no cardinality differences between this profile and IPS-UV

Vocabulary Differences:

Immunization.vaccineCode
- added preferred binding of SNOMED CT Canadian Edition VaccineAdministeredTradeNameCode
  - Note: VaccineHistoricalNameCode, PassiveAdministeredImmunizingAgentCode, and PassiveHistoricalImmunizingAgentCode equivalently preferred to the primary binding as they convey codes that are intended to be utilized in different contexts (e.g., passive agents)
- additionalBindings added for:
  - SNOMED CT Canadian Edition Vaccine Historical Name VaccineHistoricalNameCode,
  - SNOMED CT Canadian Edition Passive Administered Immunizing Agent Code PassiveAdministeredImmunizingAgentCode,
  - SNOMED CT Canadian Edition Passive Historical Immunizing Agent Code PassiveHistoricalImmunizingAgentCode,
  - IPS Vaccine Code VaccinesUvIps
  - WHO ATC WhoAtcUvIps,
  - absent or unknown immunizations AbsentOrUnknownImmunizationsUvIps IPS absent/unknown ValueSets have been deprecated as of IPS 2.0.0-ballot and subsumed into their VaccinesUvIps. This change is pending analysis & alignment in a future update.
Immunization.site

The development of a FHIR ValueSet & Terminology Gateway subset for this element is underway. Given that the migration of terminology from the CVC to NVC is underway, and that this element is no longer MS in PS-CA or IPS, the profiling on this binding has been temporarily removed and will be re-applied in future updates once there is an established subset to point to.

Immunization.route
- added preferred binding of ImmunizationRouteOfAdministrationCode
- additionalBindings added for:
  - EDQM route of administration MedicineRouteOfAdministrationUvIps,
  - HL7 v3 route of administration v3.RouteOfAdministration
Immunization.protocolApplied.targetDisease
- added preferred binding of VaccinePreventableDiseaseCode
- additionalBindings added for:
  - IPS VaccineTargetDisease Code VaccineTargetDiseasesUvIps

Other differences between the IPS and PS-CA Include:

Data type profiles (e.g., CodeableConcept) and reference targets (e.g., Patient) replaced with PS-CA equivalents when appropriate
Immunization.vaccineCode: IPS datatype profiling removed