FHIR IG Statistics: StructureDefinition/ca-on-ps-profile-immunization

Resources that use this resource

Resources that this resource uses

Narrative

No narrative content found in resource

Source

{
  "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": "active",
  "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.",
        "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
      },
      {
        "id": "Immunization.vaccineCode.coding.display.extension:translation",
        "path": "Immunization.vaccineCode.coding.display.extension",
        "sliceName": "translation"
      },
      {
        "id": "Immunization.vaccineCode.coding.display.extension:translation.extension",
        "path": "Immunization.vaccineCode.coding.display.extension.extension",
        "min": 2
      },
      {
        "id": "Immunization.vaccineCode.coding:CVCGeneric",
        "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:CVCGeneric.display.extension:translation",
        "path": "Immunization.vaccineCode.coding.display.extension",
        "sliceName": "translation"
      },
      {
        "id": "Immunization.vaccineCode.coding:CVCGeneric.display.extension:translation.extension",
        "path": "Immunization.vaccineCode.coding.display.extension.extension",
        "min": 2
      },
      {
        "id": "Immunization.vaccineCode.coding:CVCTradename",
        "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:CVCTradename.display.extension:translation",
        "path": "Immunization.vaccineCode.coding.display.extension",
        "sliceName": "translation"
      },
      {
        "id": "Immunization.vaccineCode.coding:CVCTradename.display.extension:translation.extension",
        "path": "Immunization.vaccineCode.coding.display.extension.extension",
        "min": 2
      },
      {
        "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.vaccineCode.coding:absentOrUnknownImmunization.display.extension:translation",
        "path": "Immunization.vaccineCode.coding.display.extension",
        "sliceName": "translation"
      },
      {
        "id": "Immunization.vaccineCode.coding:absentOrUnknownImmunization.display.extension:translation.extension",
        "path": "Immunization.vaccineCode.coding.display.extension.extension",
        "min": 2
      },
      {
        "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]",
        "type": [
          {
            "code": "dateTime",
            "profile": [
              "http://ontariohealth.ca/fhir/StructureDefinition/ca-on-ps-profile-datetime"
            ]
          },
          {
            "code": "string",
            "profile": [
              "http://ontariohealth.ca/fhir/StructureDefinition/ca-on-ps-profile-string"
            ]
          }
        ],
        "mustSupport": true
      },
      {
        "id": "Immunization.occurrence[x].extension",
        "path": "Immunization.occurrence[x].extension",
        "slicing": {
          "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.",
        "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"
            ]
          }
        ],
        "mustSupport": true,
        "binding": {
          "strength": "preferred",
          "valueSet": "http://fhir.infoway-inforoute.ca/io/psca/ValueSet/CVC-AnatomicalSite"
        }
      },
      {
        "id": "Immunization.site.coding",
        "path": "Immunization.site.coding",
        "mustSupport": true
      },
      {
        "id": "Immunization.site.coding.display.extension:translation",
        "path": "Immunization.site.coding.display.extension",
        "sliceName": "translation"
      },
      {
        "id": "Immunization.site.coding.display.extension:translation.extension",
        "path": "Immunization.site.coding.display.extension.extension",
        "min": 2
      },
      {
        "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"
            ]
          }
        ],
        "mustSupport": true,
        "binding": {
          "strength": "preferred",
          "valueSet": "http://fhir.infoway-inforoute.ca/io/psca/ValueSet/CVC-RouteOfAdmin"
        }
      },
      {
        "id": "Immunization.route.coding",
        "path": "Immunization.route.coding",
        "mustSupport": true
      },
      {
        "id": "Immunization.route.coding.display.extension:translation",
        "path": "Immunization.route.coding.display.extension",
        "sliceName": "translation"
      },
      {
        "id": "Immunization.route.coding.display.extension:translation.extension",
        "path": "Immunization.route.coding.display.extension.extension",
        "min": 2
      },
      {
        "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",
        "path": "Immunization.protocolApplied",
        "mustSupport": false
      },
      {
        "id": "Immunization.protocolApplied.targetDisease",
        "path": "Immunization.protocolApplied.targetDisease",
        "mustSupport": false,
        "binding": {
          "strength": "preferred",
          "valueSet": "http://fhir.infoway-inforoute.ca/io/psca/ValueSet/CVC-Disease"
        }
      },
      {
        "id": "Immunization.protocolApplied.targetDisease.coding",
        "path": "Immunization.protocolApplied.targetDisease.coding",
        "slicing": {
          "discriminator": [
            {
              "type": "pattern",
              "path": "$this"
            }
          ],
          "description": "Discriminated by bound value set",
          "rules": "open"
        },
        "mustSupport": false
      },
      {
        "id": "Immunization.protocolApplied.targetDisease.coding.display",
        "path": "Immunization.protocolApplied.targetDisease.coding.display",
        "mustSupport": false
      },
      {
        "id": "Immunization.protocolApplied.targetDisease.coding.display.extension:translation",
        "path": "Immunization.protocolApplied.targetDisease.coding.display.extension",
        "sliceName": "translation"
      },
      {
        "id": "Immunization.protocolApplied.targetDisease.coding.display.extension:translation.url",
        "path": "Immunization.protocolApplied.targetDisease.coding.display.extension.url",
        "fixedUri": "translation"
      },
      {
        "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.",
        "mustSupport": false,
        "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:targetDiseaseIPSCode.display.extension:translation",
        "path": "Immunization.protocolApplied.targetDisease.coding.display.extension",
        "sliceName": "translation"
      },
      {
        "id": "Immunization.protocolApplied.targetDisease.coding:targetDiseaseIPSCode.display.extension:translation.url",
        "path": "Immunization.protocolApplied.targetDisease.coding.display.extension.url",
        "fixedUri": "translation"
      },
      {
        "id": "Immunization.protocolApplied.targetDisease.coding:targetDiseaseCVC",
        "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#/)",
        "mustSupport": false,
        "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"
        }
      },
      {
        "id": "Immunization.protocolApplied.targetDisease.coding:targetDiseaseCVC.display.extension:translation",
        "path": "Immunization.protocolApplied.targetDisease.coding.display.extension",
        "sliceName": "translation"
      },
      {
        "id": "Immunization.protocolApplied.targetDisease.coding:targetDiseaseCVC.display.extension:translation.url",
        "path": "Immunization.protocolApplied.targetDisease.coding.display.extension.url",
        "fixedUri": "translation"
      }
    ]
  }
}