Profiles & Operations Index > Profile: Immunization

Profile: Immunization

Canonical URL:http://ontariohealth.ca/fhir/StructureDefinition/ca-on-ps-profile-immunization

Simplifier project page: Immunization (PS-ON)

Derived from: Immunization (R4)

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work

Differential View

versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..*canonical(StructureDefinition)
securityΣ0..*CodingBinding
tagΣ0..*Coding
identifier0..*Identifier
statusS Σ ?!1..1codeBinding
statusReason0..1CodeableConcept
vaccineIPSCodeΣ0..1Coding (PS-ON)Binding
atcClassΣ0..*Coding (PS-ON)Binding
CVCGenericS Σ0..*Coding (PS-ON)Binding
CVCTradenameS Σ0..*Coding (PS-ON)Binding
absentOrUnknownImmunizationS Σ0..*Coding (PS-ON)Binding
textS Σ0..1string
referenceS Σ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
encounterI0..1Reference(Encounter)
data-absent-reasonS I0..1Extension(code)
occurrenceDateTimedateTime
occurrenceStringstring
recorded0..1dateTime
primarySourceΣ0..1boolean
reportOrigin0..1CodeableConcept
locationI0..1Reference(Location)
manufacturerI0..1Reference(Organization)
lotNumber0..1string
expirationDate0..1date
site0..1Codeable Concept (PS-ON)Binding
route0..1Codeable Concept (PS-ON)Binding
doseQuantityI0..1SimpleQuantity
functionΣ0..1CodeableConceptBinding
actorΣ I1..1Reference(Practitioner | PractitionerRole | Organization)
noteΣ0..*Annotation
reasonCode0..*CodeableConcept
reasonReferenceI0..*Reference(Condition | Observation | DiagnosticReport)
isSubpotentΣ ?!0..1boolean
subpotentReason0..*CodeableConcept
documentType0..1string
reference0..1uri
publicationDate0..1dateTime
presentationDate0..1dateTime
programEligibility0..*CodeableConcept
fundingSource0..1CodeableConcept
date0..1dateTime
detailI0..1Reference(Observation)
reported0..1boolean
series0..1string
authorityI0..1Reference(Organization)
targetDiseaseIPSCodeΣ0..*Coding (PS-ON)Binding
targetDiseaseCVCΣ0..*Coding (PS-ON)Binding
textS Σ0..1string
doseNumberPositiveIntpositiveInt
doseNumberStringstring
seriesDosesPositiveIntpositiveInt
seriesDosesStringstring

Hybrid View

versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..*canonical(StructureDefinition)
securityΣ0..*CodingBinding
tagΣ0..*Coding
identifier0..*Identifier
statusS Σ ?!1..1codeBinding
statusReason0..1CodeableConcept
vaccineIPSCodeΣ0..1Coding (PS-ON)Binding
atcClassΣ0..*Coding (PS-ON)Binding
CVCGenericS Σ0..*Coding (PS-ON)Binding
CVCTradenameS Σ0..*Coding (PS-ON)Binding
absentOrUnknownImmunizationS Σ0..*Coding (PS-ON)Binding
textS Σ0..1string
referenceS Σ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
encounterI0..1Reference(Encounter)
data-absent-reasonS I0..1Extension(code)
occurrenceDateTimedateTime
occurrenceStringstring
recorded0..1dateTime
primarySourceΣ0..1boolean
reportOrigin0..1CodeableConcept
locationI0..1Reference(Location)
manufacturerI0..1Reference(Organization)
lotNumber0..1string
expirationDate0..1date
site0..1Codeable Concept (PS-ON)Binding
route0..1Codeable Concept (PS-ON)Binding
doseQuantityI0..1SimpleQuantity
functionΣ0..1CodeableConceptBinding
actorΣ I1..1Reference(Practitioner | PractitionerRole | Organization)
noteΣ0..*Annotation
reasonCode0..*CodeableConcept
reasonReferenceI0..*Reference(Condition | Observation | DiagnosticReport)
isSubpotentΣ ?!0..1boolean
subpotentReason0..*CodeableConcept
documentType0..1string
reference0..1uri
publicationDate0..1dateTime
presentationDate0..1dateTime
programEligibility0..*CodeableConcept
fundingSource0..1CodeableConcept
date0..1dateTime
detailI0..1Reference(Observation)
reported0..1boolean
series0..1string
authorityI0..1Reference(Organization)
targetDiseaseIPSCodeΣ0..*Coding (PS-ON)Binding
targetDiseaseCVCΣ0..*Coding (PS-ON)Binding
textS Σ0..1string
doseNumberPositiveIntpositiveInt
doseNumberStringstring
seriesDosesPositiveIntpositiveInt
seriesDosesStringstring

Snapshot View

versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..*canonical(StructureDefinition)
securityΣ0..*CodingBinding
tagΣ0..*Coding
identifier0..*Identifier
statusS Σ ?!1..1codeBinding
statusReason0..1CodeableConcept
vaccineIPSCodeΣ0..1Coding (PS-ON)Binding
atcClassΣ0..*Coding (PS-ON)Binding
CVCGenericS Σ0..*Coding (PS-ON)Binding
CVCTradenameS Σ0..*Coding (PS-ON)Binding
absentOrUnknownImmunizationS Σ0..*Coding (PS-ON)Binding
textS Σ0..1string
referenceS Σ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
encounterI0..1Reference(Encounter)
data-absent-reasonS I0..1Extension(code)
occurrenceDateTimedateTime
occurrenceStringstring
recorded0..1dateTime
primarySourceΣ0..1boolean
reportOrigin0..1CodeableConcept
locationI0..1Reference(Location)
manufacturerI0..1Reference(Organization)
lotNumber0..1string
expirationDate0..1date
site0..1Codeable Concept (PS-ON)Binding
route0..1Codeable Concept (PS-ON)Binding
doseQuantityI0..1SimpleQuantity
functionΣ0..1CodeableConceptBinding
actorΣ I1..1Reference(Practitioner | PractitionerRole | Organization)
noteΣ0..*Annotation
reasonCode0..*CodeableConcept
reasonReferenceI0..*Reference(Condition | Observation | DiagnosticReport)
isSubpotentΣ ?!0..1boolean
subpotentReason0..*CodeableConcept
documentType0..1string
reference0..1uri
publicationDate0..1dateTime
presentationDate0..1dateTime
programEligibility0..*CodeableConcept
fundingSource0..1CodeableConcept
date0..1dateTime
detailI0..1Reference(Observation)
reported0..1boolean
series0..1string
authorityI0..1Reference(Organization)
targetDiseaseIPSCodeΣ0..*Coding (PS-ON)Binding
targetDiseaseCVCΣ0..*Coding (PS-ON)Binding
textS Σ0..1string
doseNumberPositiveIntpositiveInt
doseNumberStringstring
seriesDosesPositiveIntpositiveInt
seriesDosesStringstring

Table View

Immunization..
Immunization.meta1..
Immunization.meta.profile1..
Immunization.status..
Immunization.vaccineCodeCodeable Concept (PS-ON)1..1
Immunization.vaccineCode.codingCoding (PS-ON)..
Immunization.vaccineCode.coding..1
Immunization.vaccineCode.coding..
Immunization.vaccineCode.coding..
Immunization.vaccineCode.coding..
Immunization.vaccineCode.coding..
Immunization.patientReference(Patient (PS-ON))..
Immunization.patient.reference1..
Immunization.occurrence[x]1..1
Immunization.occurrence[x].extension..
Immunization.occurrence[x].extensionExtension..1
Immunization.siteCodeable Concept (PS-ON)..
Immunization.routeCodeable Concept (PS-ON)..
Immunization.performer..1
Immunization.protocolApplied..
Immunization.protocolApplied.targetDiseaseCodeable Concept (PS-ON)0..
Immunization.protocolApplied.targetDisease.codingCoding (PS-ON)..
Immunization.protocolApplied.targetDisease.coding..
Immunization.protocolApplied.targetDisease.coding..


JSON View

{
    "resourceType": "StructureDefinition",
    "id": "ca-on-ps-profile-immunization",
    "url": "http://ontariohealth.ca/fhir/StructureDefinition/ca-on-ps-profile-immunization",
    "version": "0.10.0",
    "name": "ImmunizationPSON",
    "title": "Immunization (PS-ON)",
    "status": "draft",
    "date": "2022-10-15T12:00:00+00:00",
    "publisher": "Ontario Health",
    "description": "This profile defines a set of constraints to the FHIR Immunization resource for use in Ontario Patient Summaries (PS-ON).  It refines constraints applied to the Immunization resource by the PS-CA project to represent a record of immunization in the patient summary. It is informed by the constraints of the [Immunization-UV-IPS profile](http://hl7.org/fhir/uv/ips/StructureDefinition-Immunization-uv-ips.html) and the [Canadian Baseline  Profile](http://build.fhir.org/ig/HL7-Canada/ca-baseline/branches/master/StructureDefinition-profile-immunization.html) to allow for cross-border and cross-jurisdiction sharing of Medication Summary information. It describes the event of a patient being administered a vaccination or a record of a vaccination as reported by a patient, a clinician or another party.",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "Immunization",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Immunization",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Immunization.meta",
                "path": "Immunization.meta",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Immunization.meta.profile",
                "path": "Immunization.meta.profile",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Immunization.status",
                "path": "Immunization.status",
                "mustSupport": true
            },
            {
                "id": "Immunization.vaccineCode",
                "path": "Immunization.vaccineCode",
                "short": "Vaccine that was administered or was to be administered. IPS-UV Note: Several kinds of vaccine product coding could be provided.\n\nThe 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.\n\nOther 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.",
                "comment": "PS-CA Note: Work is underway to define the pan-Canadian terminology that will be preferred and/or socialized for vaccine.code. IPS-UV Note: Several kinds of vaccine product coding could be provided.\n\nThe 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.\n\nOther coded information can be provided as well as:\n  1. The IDMP Pharmaceutical Product Identifier (PhPID), Level 1, [Substance(s)]. Example: Amoxicillin and Clavulanate Potassium; or any other equivalent coded concept.\n  1. 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.\n  1. 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.\n  1. 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.\n  1. 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.\n  1. 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.\n  1. Any other kind of code that that identifies, classifies or clusters the administered product (e.g. the medicinal product or the product class).\n\nThe 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.",
                "min": 1,
                "max": "1",
                "type":  [
                    {
                        "code": "CodeableConcept",
                        "profile":  [
                            "http://ontariohealth.ca/fhir/StructureDefinition/ca-on-ps-profile-codeableconcept"
                        ]
                    }
                ],
                "mustSupport": true,
                "binding": {
                    "strength": "preferred",
                    "description": "Codes from the Canadian Vaccine Catalogue Generic Value Set. Use of Tradename Value Set is equivalently preferred",
                    "valueSet": "http://fhir.infoway-inforoute.ca/io/psca/ValueSet/CVC-Generic"
                }
            },
            {
                "id": "Immunization.vaccineCode.coding",
                "path": "Immunization.vaccineCode.coding",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "pattern",
                            "path": "$this"
                        }
                    ],
                    "description": "Discriminated by bound value set",
                    "rules": "open"
                },
                "mustSupport": true,
                "type":  [
                    {
                        "code": "Coding",
                        "profile":  [
                            "http://ontariohealth.ca/fhir/StructureDefinition/ca-on-ps-profile-coding"
                        ]
                    }
                ]
            },
            {
                "id": "Immunization.vaccineCode.coding:vaccineIPSCode",
                "path": "Immunization.vaccineCode.coding",
                "sliceName": "vaccineIPSCode",
                "short": "Optional slice for representing the code for vaccine from the SNOMED CT IPS code set",
                "definition": "Code for a vaccine that is selected from the SNOMED CT IPS code set.",
                "max": "1",
                "binding": {
                    "extension":  [
                        {
                            "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
                            "valueString": "vaccineIPS"
                        }
                    ],
                    "strength": "required",
                    "valueSet": "http://hl7.org/fhir/uv/ips/ValueSet/vaccines-uv-ips"
                }
            },
            {
                "id": "Immunization.vaccineCode.coding:atcClass",
                "path": "Immunization.vaccineCode.coding",
                "sliceName": "atcClass",
                "short": "Optional slice for representing the vaccine code from the WHO ATC classification",
                "definition": "WHO ATC classification",
                "comment": "The IPS-UV considers this slice MS in STU1, however the impacts of applying MS on terminology slices have been brought forward to the IPS-UV FHIR authors and removal of the MS flag on optional slices is currently being discussed.",
                "binding": {
                    "extension":  [
                        {
                            "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
                            "valueString": "WHO ATC"
                        }
                    ],
                    "strength": "required",
                    "valueSet": "http://hl7.org/fhir/uv/ips/ValueSet/whoatc-uv-ips"
                }
            },
            {
                "id": "Immunization.vaccineCode.coding:Generic",
                "path": "Immunization.vaccineCode.coding",
                "sliceName": "CVCGeneric",
                "definition": "Generic Immunizing Agent",
                "comment": "Generic Immunizing Agents subset contains generically described vaccines and passive immunizing agents used in Canada. It is an extension of the Pan-Canadian Immunization Reference Sets Vaccine Historical Name Code and Passive Historical Immunizing Agent Code subset developed by Canada Health Infoway. **Please note** that Canadian Vaccine Catalogue (CVC)-published value set urls are currently not resolvable, but details of the referenced value sets are available in the current version of the CVC accessible here: [https://cvc.canimmunize.ca/en/explore#/](https://cvc.canimmunize.ca/en/explore#/)",
                "mustSupport": true,
                "binding": {
                    "extension":  [
                        {
                            "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
                            "valueString": "CVCGeneric"
                        }
                    ],
                    "strength": "required",
                    "valueSet": "http://fhir.infoway-inforoute.ca/io/psca/ValueSet/CVC-Generic"
                }
            },
            {
                "id": "Immunization.vaccineCode.coding:Tradename",
                "path": "Immunization.vaccineCode.coding",
                "sliceName": "CVCTradename",
                "definition": "Tradename Immunizing Agent",
                "comment": "Tradename Immunizing Agents subset contains tradenames of vaccines and passive immunizing agents used in Canada. It is an extension of the Pan-Canadian Immunization Reference Sets Vaccine Administered Trade Name Code and Immunioglobulin Code subset developed by Canada Health Infoway. **Please note** that Canadian Vaccine Catalogue (CVC)-published value set urls are currently not resolvable, but details of the referenced value sets are available in the current version of the CVC accessible here: [https://cvc.canimmunize.ca/en/explore#/](https://cvc.canimmunize.ca/en/explore#/)",
                "mustSupport": true,
                "binding": {
                    "extension":  [
                        {
                            "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
                            "valueString": "CVCTradename"
                        }
                    ],
                    "strength": "required",
                    "valueSet": "http://fhir.infoway-inforoute.ca/io/psca/ValueSet/CVC-Tradename"
                }
            },
            {
                "id": "Immunization.vaccineCode.coding:absentOrUnknownImmunization",
                "path": "Immunization.vaccineCode.coding",
                "sliceName": "absentOrUnknownImmunization",
                "short": "Optional slice for representing the codes for an Absent or Unknown Immunization",
                "definition": "A reference to a code indicating that there there are no known immunizations or that this information is unknown.",
                "comment": "This slice is kept as must support to ensure that systems proving conformance can show that they can produce a value indicating that an immunization is absent or unknown (similar to approach with keeping must support flags on data absent reason extensions)",
                "mustSupport": true,
                "binding": {
                    "extension":  [
                        {
                            "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
                            "valueString": "Absent Unknown Immunization"
                        }
                    ],
                    "strength": "required",
                    "valueSet": "http://hl7.org/fhir/uv/ips/ValueSet/absent-or-unknown-immunizations-uv-ips"
                }
            },
            {
                "id": "Immunization.patient",
                "path": "Immunization.patient",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://ontariohealth.ca/fhir/StructureDefinition/ca-on-ps-profile-patient"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "Immunization.patient.reference",
                "path": "Immunization.patient.reference",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Immunization.occurrence[x]",
                "path": "Immunization.occurrence[x]",
                "min": 1,
                "max": "1",
                "mustSupport": true
            },
            {
                "id": "Immunization.occurrence[x].extension",
                "path": "Immunization.occurrence[x].extension",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "url"
                        }
                    ],
                    "ordered": false,
                    "rules": "open"
                }
            },
            {
                "id": "Immunization.occurrence[x].extension:data-absent-reason",
                "path": "Immunization.occurrence[x].extension",
                "sliceName": "data-absent-reason",
                "short": "occurrence[x] absence reason",
                "definition": "Provides a reason why the occurrence is missing.",
                "comment": "**Note to implementers:** Path to this element in the FHIR Artifact is ~Immunization.occurrence[x].extension:data-absent-reason~ although it may be redering incorrectly in Simplifier.",
                "max": "1",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "http://hl7.org/fhir/StructureDefinition/data-absent-reason"
                        ]
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "Immunization.site",
                "path": "Immunization.site",
                "comment": "Code for anatomical site from the Canadian Vaccine Catalogue code set. **Please note** that Canadian Vaccine Catalogue (CVC)-published value set urls are currently not resolvable, but details of the referenced value sets are available in the current version of the CVC accessible here: [https://cvc.canimmunize.ca/en/explore#/](https://cvc.canimmunize.ca/en/explore#/)",
                "type":  [
                    {
                        "code": "CodeableConcept",
                        "profile":  [
                            "http://ontariohealth.ca/fhir/StructureDefinition/ca-on-ps-profile-codeableconcept"
                        ]
                    }
                ],
                "binding": {
                    "strength": "preferred",
                    "valueSet": "http://fhir.infoway-inforoute.ca/io/psca/ValueSet/CVC-AnatomicalSite"
                }
            },
            {
                "id": "Immunization.route",
                "path": "Immunization.route",
                "comment": "Code for a route of administration from the Canadian Vaccine Catalogue code set. **Please note** that Canadian Vaccine Catalogue (CVC)-published value set urls are currently not resolvable, but details of the referenced value sets are available in the current version of the CVC accessible here: [https://cvc.canimmunize.ca/en/explore#/](https://cvc.canimmunize.ca/en/explore#/)",
                "type":  [
                    {
                        "code": "CodeableConcept",
                        "profile":  [
                            "http://ontariohealth.ca/fhir/StructureDefinition/ca-on-ps-profile-codeableconcept"
                        ]
                    }
                ],
                "binding": {
                    "extension":  [
                        {
                            "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
                            "valueString": "ImmunizationRoute"
                        }
                    ],
                    "strength": "preferred",
                    "valueSet": "http://fhir.infoway-inforoute.ca/io/psca/ValueSet/CVC-RouteOfAdmin"
                }
            },
            {
                "id": "Immunization.performer",
                "path": "Immunization.performer",
                "comment": "While the IPS-UV specification considers this a MS element, some systems will not have a field directly representing performer, further feedback is required on whether these systems are still expected to be able to demonstrate they can construct this element when developing the patient summary instance",
                "max": "1"
            },
            {
                "id": "Immunization.protocolApplied.targetDisease",
                "path": "Immunization.protocolApplied.targetDisease",
                "type":  [
                    {
                        "code": "CodeableConcept",
                        "profile":  [
                            "http://ontariohealth.ca/fhir/StructureDefinition/ca-on-ps-profile-codeableconcept"
                        ]
                    }
                ],
                "binding": {
                    "strength": "preferred",
                    "valueSet": "http://fhir.infoway-inforoute.ca/io/psca/ValueSet/CVC-Disease"
                },
                "min": 0
            },
            {
                "id": "Immunization.protocolApplied.targetDisease.coding",
                "path": "Immunization.protocolApplied.targetDisease.coding",
                "type":  [
                    {
                        "code": "Coding",
                        "profile":  [
                            "http://ontariohealth.ca/fhir/StructureDefinition/ca-on-ps-profile-coding"
                        ]
                    }
                ],
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "pattern",
                            "path": "$this"
                        }
                    ],
                    "description": "Discriminated by bound value set",
                    "rules": "open"
                }
            },
            {
                "id": "Immunization.protocolApplied.targetDisease.coding:targetDiseaseIPSCode",
                "path": "Immunization.protocolApplied.targetDisease.coding",
                "sliceName": "targetDiseaseIPSCode",
                "short": "Optional slice for representing the code for a disease the vaccination is against the IPS Value Set",
                "definition": "Code for a disease the vaccination is against from the SNOMED CT code set.",
                "comment": "The IPS slice has replaced the GPS slice in this release to support validation tooling.",
                "binding": {
                    "extension":  [
                        {
                            "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
                            "valueString": "TargetDiseasesUvIps"
                        }
                    ],
                    "strength": "required",
                    "valueSet": "http://hl7.org/fhir/uv/ips/ValueSet/targetDiseases-uv-ips"
                }
            },
            {
                "id": "Immunization.protocolApplied.targetDisease.coding:CVC",
                "path": "Immunization.protocolApplied.targetDisease.coding",
                "sliceName": "targetDiseaseCVC",
                "short": "Optional slice for representing the code for a disease the vaccination is against from the Canadian Vaccine Catalogue code set.",
                "definition": "Code for a disease the vaccination is against from the Canadian Vaccine Catalogue code set. **Please note** that Canadian Vaccine Catalogue (CVC)-published value set urls are currently not resolvable, but details of the referenced value sets are available in the current version of the CVC accessible here: [https://cvc.canimmunize.ca/en/explore#/](https://cvc.canimmunize.ca/en/explore#/)",
                "binding": {
                    "extension":  [
                        {
                            "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
                            "valueString": "TargetDiseasesCVC"
                        }
                    ],
                    "strength": "required",
                    "valueSet": "http://fhir.infoway-inforoute.ca/io/psca/ValueSet/CVC-Disease"
                }
            }
        ]
    }
}

Usage

The Immunization Resource is used to populate entries in the Immunization section of a Patient Summary.

Notes

.id

  • Definition: Logical id of this artifact
  • used to uniquely identify the resource
  • if a persistent identity for the resource is not available to use when constructing the composition Bundle, a UUID SHOULD be used in this element (with a corresponding value in Bundle.entry.fullUrl)
  • Where .id is populated with a persistent identifier, consumers SHALL NOT expect to be able to resolve the resource and SHALL always use the version of the resource contained in the Bundle to render the composition.

.meta.profile

  • used to declare conformance to this profile
  • populate with a fixed value: http://ontariohealth.ca/fhir/StructureDefinition/ca-on-ps-profile-immunization|0.9.1

.meta.versionId

  • SHALL be populated by the Patient Summary Repository server
  • consuming systems can expect this element to be populated when retrieving patient summary instances from the repository
  • source systems do not need to populate this element prior to submission

.status

  • it is expected that immunizations recorded in the patient summary will have a status of "completed". "entered-in-error" or "not-done" may be used rarely.
  • mustSupport element in international patient summary

.vaccineCode

  • SHALL be used to either:
    • identify the vaccine in the entry, or
    • to explicitly state that the patient has no known or unknown immunizations when the section in the patient summary does not contain a vaccine
  • in situations where a vaccine is present:
    • a description SHALL be provided in .text for display
    • a coded value SHOULD also be provided in .coding
  • in situations where a vaccine is not present, this SHALL be coveyed using .coding from the prescribed valueSet
    • in situations where the EMR cannot distinguish between no-known and no information about patient immunizations, then the code for no information should be used. In the instance where a patient is KNOWN to have no immunizations, the no-known code should be used.
  • the "CVCGeneric" and "CVCTradename" slices provide the preferred choice of terminology for this element in Ontario
  • mustSupport element in international patient summary

.patient

  • SHALL provide a .reference to the same Patient resource identified in Composition.subject
  • mustSupport element in international patient summary

occurrence

  • SHALL be used to indicate when the immunization was administered
  • mustSupport element in international patient summary

occurrence.dataAbsentReason

  • NOTE: There is currently a rendering issue with this profile; the dataAbsentReason extension should be rendering under the .occurrence element
  • If no data is available about when the vaccine was administered, dataAbsentReason SHOULD be used to indicate why this information is absent
  • If no immunizations are present (i.e. .vaccineCode is used to convey absent or unknown), .dataAbsentReason SHALL be set to "not-applicable"
  • mustSupport element in international patient summary