Profile Comparison between http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-immunization vs http://hl7.org/fhir/ca/baseline/StructureDefinition/profile-immunization

Left:IPA-Immunization (http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-immunization)
Right:Immunization Profile (http://hl7.org/fhir/ca/baseline/StructureDefinition/profile-immunization)

Messages

ErrorStructureDefinition.urlValues for url differ: 'http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-immunization' vs 'http://hl7.org/fhir/ca/baseline/StructureDefinition/profile-immunization'
InformationStructureDefinition.nameValues for name differ: 'IPAImmunization' vs 'ImmunizationProfile'
InformationStructureDefinition.titleValues for title differ: 'IPA-Immunization' vs 'Immunization Profile'
InformationStructureDefinition.statusValues for status differ: 'active' vs 'draft'
InformationStructureDefinition.dateValues for date differ: '2022-08-02' vs '2024-12-13'
InformationStructureDefinition.publisherValues for publisher differ: 'HL7 International / Patient Care' vs 'HL7 Canada - FHIR Implementation Work Group'
InformationStructureDefinition.jurisdictionRemoved the item 'http://unstats.un.org/unsd/methods/m49/m49.htm#001'
InformationStructureDefinition.jurisdictionAdded the item 'urn:iso:std:iso:3166#CA'
InformationStructureDefinition.commentValues for comment differ: 'This is generally only used for the status of 'not-done'. The reason for performing the immunization event is captured in reasonCode, not here.' vs 'CA Baseline Usage Notes: a reason should be provided if the status is 'not-done'.'
InformationStructureDefinition.commentValues for comment differ: '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.' vs 'CA Baseline Usage Notes: While occurrenceString is allowed given its use in existing Canadian systems - a combination of occurrenceDateTime (full or partial) with the 'estimated' extension is the preferred mechanism for expressing when an exact date is unknown. For example, if a patient recalls that they were immunized in June 1980, occurrenceDateTime will have a partial date '1980-06' with 'estimated'=true. Another example: if in 2020, a 55 y.o. patient recalls that they were immunized at the age of 5, occurrenceDateTime will have a partial date '1970' with 'estimated'=true.'
WarningImmunization.occurrence[x]Elements differ in definition for mustSupport: 'true' vs 'false'
InformationStructureDefinition.shortValues for short differ: 'Indicates context the data was recorded in' vs 'Indicates that data is from the primary record created at the time the vaccine was administered.'
InformationImmunization.reportOriginExample/preferred bindings differ at Immunization.reportOrigin using binding from ImmunizationProfile
InformationImmunization.siteExample/preferred bindings differ at Immunization.site using binding from ImmunizationProfile
InformationImmunization.routeExample/preferred bindings differ at Immunization.route using binding from ImmunizationProfile
InformationImmunization.protocolApplied.targetDiseaseExample/preferred bindings differ at Immunization.protocolApplied.targetDisease using binding from ImmunizationProfile

Metadata

NameValueComments
.abstractfalse
    .baseDefinitionhttp://hl7.org/fhir/StructureDefinition/Immunization
      .copyrightUsed by permission of HL7 International all rights reserved Creative Commons License
      • Removed the item 'Used by permission of HL7 International all rights reserved Creative Commons License'
      .date2022-08-022024-12-13
      • Values Differ
      .descriptionMinimum expectations for an Immunization resource when accessed via a International Patient Access APIProposed constraints and extensions on the Immunization resource. Generated as a first step toward creating a set of Canadian Baseline FHIR profiles.
      • Values Differ
      .experimentalfalse
      • Removed the item 'false'
      .fhirVersion4.0.1
        .jurisdiction
          ..jurisdiction[0]http://unstats.un.org/unsd/methods/m49/m49.htm#001
          • Removed the item 'http://unstats.un.org/unsd/methods/m49/m49.htm#001'
          ..jurisdiction[1]urn:iso:std:iso:3166#CA
          • Added the item 'urn:iso:std:iso:3166#CA'
          .kindresource
            .nameIPAImmunizationImmunizationProfile
            • Values Differ
            .publisherHL7 International / Patient CareHL7 Canada - FHIR Implementation Work Group
            • Values Differ
            .purpose
              .statusactivedraft
              • Values Differ
              .titleIPA-ImmunizationImmunization Profile
              • Values Differ
              .typeImmunization
                .urlhttp://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-immunizationhttp://hl7.org/fhir/ca/baseline/StructureDefinition/profile-immunization
                • Values Differ
                .version1.1.0

                  Structure

                  NameL FlagsL Card.L TypeL Description & ConstraintsR FlagsR Card.R TypeR Description & ConstraintsCommentsdoco
                  .. Immunization 0..*ImmunizationImmunization event information
                  0..*ImmunizationImmunization event information
                    ... id Σ0..1idLogical id of this artifactΣ0..1idLogical id of this artifact
                      ... meta Σ0..1MetaMetadata about the resourceΣ0..1MetaMetadata about the resource
                        ... implicitRules ?!Σ0..1uriA set of rules under which this content was created?!Σ0..1uriA set of rules under which this content was created
                          ... language 0..1codeLanguage of the resource content
                          Binding: ?? (preferred): A human language.

                          Additional BindingsPurpose
                          ??Max Binding
                          0..1codeLanguage of the resource content
                          Binding: ?? (preferred): A human language.

                          Additional BindingsPurpose
                          ??Max Binding
                            ... text 0..1NarrativeText summary of the resource, for human interpretation0..1NarrativeText summary of the resource, for human interpretation
                              ... contained 0..*ResourceContained, inline Resources
                              0..*ResourceContained, inline Resources
                                ... extension 0..*ExtensionAdditional content defined by implementations
                                0..*ExtensionAdditional content defined by implementations
                                  ... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
                                  ?!0..*ExtensionExtensions that cannot be ignored
                                    ... identifier 0..*IdentifierBusiness identifier
                                    0..*IdentifierBusiness identifier
                                      ... status ?!SOΣ1..1codecompleted | entered-in-error | not-done
                                      Binding: ?? (required): A set of codes indicating the current status of an Immunization.

                                      ObligationsActor
                                      SHALL:populate-if-knownhttp://hl7.org/fhir/uv/ipa/ActorDefinition/server
                                      SHALL:handlehttp://hl7.org/fhir/uv/ipa/ActorDefinition/client
                                      ?!SΣ1..1codecompleted | entered-in-error | not-done
                                      Binding: ?? (required): A set of codes indicating the current status of an Immunization.

                                        ... statusReason 0..1CodeableConceptReason not done
                                        Binding: ?? (example): The reason why a vaccine was not administered.

                                        0..1CodeableConceptReason not done
                                        Binding: ?? (example): The reason why a vaccine was not administered.

                                          ... vaccineCode SOΣ1..1CodeableConceptVaccine product administered
                                          Binding: ?? (example): The code for vaccine product administered.

                                          ObligationsActor
                                          SHALL:populate-if-knownhttp://hl7.org/fhir/uv/ipa/ActorDefinition/server
                                          SHALL:handlehttp://hl7.org/fhir/uv/ipa/ActorDefinition/client
                                          SΣ1..1CodeableConceptVaccine product administered
                                          Binding: ?? (example): The code for vaccine product administered.

                                            .... id 0..1stringUnique id for inter-element referencing
                                            • Added this element
                                            .... Slices for extension 0..*ExtensionAdditional content defined by implementations
                                            Slice: Unordered, Open by value:url
                                            • Added this element
                                            .... Slices for coding Σ1..*CodingCode defined by a terminology system
                                            Slice: Unordered, Open by pattern:system, pattern:code
                                            • Added this element
                                            .... text Σ0..1stringPlain text representation of the concept
                                            • Added this element
                                            ... patient SOΣ1..1Reference(IPA-Patient)Who was immunized
                                            ObligationsActor
                                            SHALL:populate-if-knownhttp://hl7.org/fhir/uv/ipa/ActorDefinition/server
                                            SHALL:handlehttp://hl7.org/fhir/uv/ipa/ActorDefinition/client
                                            SΣ1..1Reference(Patient Profile)Who was immunized
                                              ... encounter 0..1Reference(Encounter)Encounter immunization was part of0..1Reference(Encounter Profile)Encounter immunization was part of
                                                ... occurrence[x] SOΣ1..1dateTime, stringVaccine administration date
                                                ObligationsActor
                                                SHALL:populate-if-knownhttp://hl7.org/fhir/uv/ipa/ActorDefinition/server
                                                SHALL:handlehttp://hl7.org/fhir/uv/ipa/ActorDefinition/client
                                                Σ1..1dateTime, stringVaccine administration date
                                                Slice: Unordered, Open by type:$this
                                                • Elements differ in definition for mustSupport: 'true' vs 'false'
                                                ... recorded 0..1dateTimeWhen the immunization was first captured in the subject's record0..1dateTimeWhen the immunization was first captured in the subject's record
                                                  ... primarySource Σ0..1booleanIndicates context the data was recorded inΣ0..1booleanIndicates that data is from the primary record created at the time the vaccine was administered.
                                                    ... 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.

                                                    0..1CodeableConceptIndicates the source of a secondarily reported record
                                                    Binding: ?? (preferred)
                                                    • Example/preferred bindings differ at Immunization.reportOrigin using binding from ImmunizationProfile
                                                    ... location 0..1Reference(Location)Where immunization occurred0..1Reference(Location Profile)Where immunization occurred
                                                      ... manufacturer 0..1Reference(Organization)Vaccine manufacturer0..1Reference(Organization Profile)Vaccine manufacturer
                                                        ... lotNumber 0..1stringVaccine lot number0..1stringVaccine lot number
                                                          ... expirationDate 0..1dateVaccine expiration date0..1dateVaccine expiration date
                                                            ... site 0..1CodeableConceptBody site vaccine was administered
                                                            Binding: ?? (example): The site at which the vaccine was administered.

                                                            0..1CodeableConceptBody site vaccine was administered
                                                            Binding: ?? (preferred)
                                                            • Example/preferred bindings differ at Immunization.site using binding from ImmunizationProfile
                                                            ... route 0..1CodeableConceptHow vaccine entered body
                                                            Binding: ?? (example): The route by which the vaccine was administered.

                                                            0..1CodeableConceptHow vaccine entered body
                                                            Binding: ?? (preferred)
                                                            • Example/preferred bindings differ at Immunization.route using binding from ImmunizationProfile
                                                            ... doseQuantity 0..1??Amount of vaccine administered0..1??Amount of vaccine administered
                                                              ... performer Σ0..*BackboneElementWho performed event
                                                              Σ0..*BackboneElementWho performed event
                                                                .... id 0..1stringUnique id for inter-element referencing0..1stringUnique id for inter-element referencing
                                                                  .... extension 0..*ExtensionAdditional content defined by implementations
                                                                  0..*ExtensionAdditional content defined by implementations
                                                                    .... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
                                                                    ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
                                                                      .... function Σ0..1CodeableConceptWhat type of performance was done
                                                                      Binding: ?? (extensible): The role a practitioner or organization plays in the immunization event.

                                                                      Σ0..1CodeableConceptWhat type of performance was done
                                                                      Binding: ?? (extensible): The role a practitioner or organization plays in the immunization event.

                                                                        .... actor Σ1..1Reference(Practitioner | PractitionerRole | Organization)Individual or organization who was performingΣ1..1Reference(Practitioner Profile (General) | PractitionerRole Profile (General) | Organization Profile)Individual or organization who was performing
                                                                          ... note Σ0..*AnnotationAdditional immunization notes
                                                                          Σ0..*AnnotationAdditional immunization notes
                                                                            ... reasonCode 0..*CodeableConceptWhy immunization occurred
                                                                            Binding: ?? (example): The reason why a vaccine was administered.


                                                                            0..*CodeableConceptWhy immunization occurred
                                                                            Binding: ?? (example): The reason why a vaccine was administered.


                                                                              ... reasonReference 0..*Reference(Condition | Observation | DiagnosticReport)Why immunization occurred
                                                                              0..*Reference(Condition Profile | Observation Profile (General Use) | DiagnosticReport Profile for Laboratory Results Reporting | Diagnostic Report for Report and Note Exchange Profile)Why immunization occurred
                                                                                ... isSubpotent ?!Σ0..1booleanDose potency?!Σ0..1booleanDose potency
                                                                                  ... subpotentReason 0..*CodeableConceptReason for being subpotent
                                                                                  Binding: ?? (example): The reason why a dose is considered to be subpotent.


                                                                                  0..*CodeableConceptReason for being subpotent
                                                                                  Binding: ?? (example): The reason why a dose is considered to be subpotent.


                                                                                    ... education C0..*BackboneElementEducational material presented to patient
                                                                                    imm-1: One of documentType or reference SHALL be present
                                                                                    C0..*BackboneElementEducational material presented to patient
                                                                                    imm-1: One of documentType or reference SHALL be present
                                                                                      .... id 0..1stringUnique id for inter-element referencing0..1stringUnique id for inter-element referencing
                                                                                        .... extension 0..*ExtensionAdditional content defined by implementations
                                                                                        0..*ExtensionAdditional content defined by implementations
                                                                                          .... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
                                                                                          ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
                                                                                            .... documentType 0..1stringEducational material document identifier0..1stringEducational material document identifier
                                                                                              .... reference 0..1uriEducational material reference pointer0..1uriEducational material reference pointer
                                                                                                .... publicationDate 0..1dateTimeEducational material publication date0..1dateTimeEducational material publication date
                                                                                                  .... presentationDate 0..1dateTimeEducational material presentation date0..1dateTimeEducational material presentation date
                                                                                                    ... programEligibility 0..*CodeableConceptPatient eligibility for a vaccination program
                                                                                                    Binding: ?? (example): The patient's eligibility for a vaccation program.


                                                                                                    0..*CodeableConceptPatient eligibility for a vaccination program
                                                                                                    Binding: ?? (example): The patient's eligibility for a vaccation program.


                                                                                                      ... fundingSource 0..1CodeableConceptFunding source for the vaccine
                                                                                                      Binding: ?? (example): The source of funding used to purchase the vaccine administered.

                                                                                                      0..1CodeableConceptFunding source for the vaccine
                                                                                                      Binding: ?? (example): The source of funding used to purchase the vaccine administered.

                                                                                                        ... reaction 0..*BackboneElementDetails of a reaction that follows immunization
                                                                                                        0..*BackboneElementDetails of a reaction that follows immunization
                                                                                                          .... id 0..1stringUnique id for inter-element referencing0..1stringUnique id for inter-element referencing
                                                                                                            .... extension 0..*ExtensionAdditional content defined by implementations
                                                                                                            0..*ExtensionAdditional content defined by implementations
                                                                                                              .... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
                                                                                                              ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
                                                                                                                .... date 0..1dateTimeWhen reaction started0..1dateTimeWhen reaction started
                                                                                                                  .... detail 0..1Reference(Observation)Additional information on reaction0..1Reference(Observation Profile (General Use))Additional information on reaction
                                                                                                                    .... reported 0..1booleanIndicates self-reported reaction0..1booleanIndicates self-reported reaction
                                                                                                                      ... protocolApplied 0..*BackboneElementProtocol followed by the provider
                                                                                                                      0..*BackboneElementProtocol followed by the provider
                                                                                                                        .... id 0..1stringUnique id for inter-element referencing0..1stringUnique id for inter-element referencing
                                                                                                                          .... extension 0..*ExtensionAdditional content defined by implementations
                                                                                                                          0..*ExtensionAdditional content defined by implementations
                                                                                                                            .... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
                                                                                                                            ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
                                                                                                                              .... series 0..1stringName of vaccine series0..1stringName of vaccine series
                                                                                                                                .... authority 0..1Reference(Organization)Who is responsible for publishing the recommendations0..1Reference(Organization Profile)Who is responsible for publishing the recommendations
                                                                                                                                  .... targetDisease 0..*CodeableConceptVaccine preventatable disease being targetted
                                                                                                                                  Binding: ?? (example): The vaccine preventable disease the dose is being administered for.


                                                                                                                                  0..*CodeableConceptVaccine preventatable disease being targetted
                                                                                                                                  Binding: ?? (preferred)
                                                                                                                                  • Example/preferred bindings differ at Immunization.protocolApplied.targetDisease using binding from ImmunizationProfile
                                                                                                                                  .... doseNumber[x] 1..1positiveInt, stringDose number within series1..1positiveInt, stringDose number within series
                                                                                                                                    .... seriesDoses[x] 0..1positiveInt, stringRecommended number of doses for immunity0..1positiveInt, stringRecommended number of doses for immunity

                                                                                                                                      doco Documentation for this format