| Package | ca.bc.bcy-ids |
| Resource Type | StructureDefinition |
| Id | 02bfa3ad-4130-4ac6-a64e-a4f34fffb6a3 |
| FHIR Version | R4 |
| Source | https://simplifier.net/resolve?scope=ca.bc.bcy-ids@1.0.0&canonical=http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/Immunization |
| URL | http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/Immunization |
| Status | draft |
| Date | 2022-02-04T19:50:20.0867005+00:00 |
| Name | Immunization |
| Type | Immunization |
| Kind | resource |
No resources found
| StructureDefinition | |
| ca-on-extension-estimated-date | EstimatedFlagExtension |
| immz-antigen | ImmzAntigenExtension |
| immz-revise-dose | ImmzReviseDoseExtension |
No narrative content found in resource
FHIR{
"resourceType": "StructureDefinition",
"id": "02bfa3ad-4130-4ac6-a64e-a4f34fffb6a3",
"meta": {
"versionId": "26",
"lastUpdated": "2025-01-24T22:53:20.4967554+00:00"
},
"url": "http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/Immunization",
"name": "Immunization",
"status": "draft",
"date": "2022-02-04T19:50:20.0867005+00:00",
"fhirVersion": "4.0.1",
"mapping": [
{
"identity": "workflow",
"uri": "http://hl7.org/fhir/workflow",
"name": "Workflow Pattern"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
},
{
"identity": "w5",
"uri": "http://hl7.org/fhir/fivews",
"name": "FiveWs Pattern Mapping"
},
{
"identity": "cda",
"uri": "http://hl7.org/v3/cda",
"name": "CDA (R2)"
}
],
"kind": "resource",
"abstract": false,
"type": "Immunization",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Immunization",
"derivation": "constraint",
"differential": {
"element": [
{
"id": "Immunization",
"path": "Immunization",
"short": "FHIR resource applies for PIR Immunization History",
"definition": "FHIR resource applies for PIR Immunization History"
},
{
"id": "Immunization.id",
"path": "Immunization.id",
"short": "PIR Internal Immunization ID",
"definition": "PIR Internal Immunization ID",
"comment": "See Mappings",
"min": 1,
"mapping": [
{
"identity": "source-PIR",
"map": "PIR Imms ID"
},
{
"identity": "source-PHSL",
"map": "immunizationId"
}
]
},
{
"id": "Immunization.meta",
"path": "Immunization.meta",
"min": 1
},
{
"id": "Immunization.meta.versionId",
"path": "Immunization.meta.versionId",
"comment": "Apply \"2025.01.1\". This indicates the FHIR Specs as of year 2025 Jan."
},
{
"id": "Immunization.meta.lastUpdated",
"path": "Immunization.meta.lastUpdated",
"comment": "Updated: Relax the previously crossed-out elements."
},
{
"id": "Immunization.meta.profile",
"path": "Immunization.meta.profile",
"comment": "Use 'http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/Immunization'",
"min": 1,
"max": "1"
},
{
"id": "Immunization.meta.security",
"path": "Immunization.meta.security",
"max": "1"
},
{
"id": "Immunization.meta.tag",
"path": "Immunization.meta.tag",
"max": "1"
},
{
"id": "Immunization.contained",
"path": "Immunization.contained",
"max": "1"
},
{
"id": "Immunization.extension:antigenDose",
"path": "Immunization.extension",
"sliceName": "antigenDose",
"short": "Antgien(s) + Antigen Dose Number + Antigen Dose Status associated with the Agent administered",
"definition": "Antgien(s) + Antigen Dose Number + Antigen Dose Status associated with the Agent administered",
"type": [
{
"code": "Extension",
"profile": [
"http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/immz-antigen"
]
}
]
},
{
"id": "Immunization.identifier",
"path": "Immunization.identifier",
"short": "PIR internal Immunization Identifier + External Immunization ID from source system(s)",
"definition": "PIR Immunization Identifier(s) which include Panorama Internal Immunization ID, External Immunization ID from different source systems).",
"min": 1
},
{
"id": "Immunization.identifier.type",
"path": "Immunization.identifier.type",
"min": 1
},
{
"id": "Immunization.identifier.type.id",
"path": "Immunization.identifier.type.id",
"max": "0"
},
{
"id": "Immunization.identifier.type.coding",
"path": "Immunization.identifier.type.coding",
"max": "0"
},
{
"id": "Immunization.identifier.type.text",
"path": "Immunization.identifier.type.text",
"comment": "See Mappings",
"min": 1,
"mapping": [
{
"identity": "source-PIR",
"map": "PANORAMAIMMZID'"
},
{
"identity": "source-NHA",
"map": "NHACEDARIMMS"
},
{
"identity": "source-VCH",
"map": "VCHPARISIMMS"
},
{
"identity": "source-FHA",
"map": "FHAPARISIMMS"
},
{
"identity": "source-PNet",
"map": "PHARMANETIMMS"
},
{
"identity": "source-CznSub",
"map": "CZNSUBIMMSID"
},
{
"identity": "source-immsBC",
"map": "HEALTHCONNECT"
},
{
"identity": "source-eForms",
"map": "EFORMIMMSID"
}
]
},
{
"id": "Immunization.identifier.system",
"path": "Immunization.identifier.system",
"comment": "See Mappings",
"min": 1,
"mapping": [
{
"identity": "source-PIR",
"map": "https://health.gov.bc.ca/fhir/NamingSystem/ca-bc-panorama-immunization-id"
},
{
"identity": "source-NHA",
"map": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-nha"
},
{
"identity": "source-FHA",
"map": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-fha"
},
{
"identity": "source-VCH",
"map": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-vcha"
},
{
"identity": "source-PNet",
"map": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-pharmanet-document-number"
},
{
"identity": "source-CznSub",
"map": "https://ehealthbc.ca/NamingSystem/ca-bc-citizen-submission"
},
{
"identity": "source-eForms",
"map": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-eForm"
},
{
"identity": "source-immsBC",
"map": "https://ehealthbc.ca/NamingSystem/ca-bc-health-connect"
}
]
},
{
"id": "Immunization.identifier.value",
"path": "Immunization.identifier.value",
"comment": "See Mappings",
"min": 1,
"mapping": [
{
"identity": "source-PIR",
"map": "PIR Immunization ID"
},
{
"identity": "source-FHA",
"map": "FHA PARIS Immunization ID"
},
{
"identity": "source-NHA",
"map": "NHA CeDaR Immunization ID"
},
{
"identity": "source-VCH",
"map": "VCH PARIS Immunization ID"
},
{
"identity": "source-PNet",
"map": "PharmaNet Immunization ID"
},
{
"identity": "source-PHSL",
"map": "immunizationId"
}
]
},
{
"id": "Immunization.status",
"path": "Immunization.status",
"short": "completed | entered-in-error |",
"definition": "Indicates the current status of the immunization record.",
"comment": "IDS sends \"completed\" or \"entered-in-error\" immunization records only."
},
{
"id": "Immunization.vaccineCode",
"path": "Immunization.vaccineCode",
"definition": "Vaccine that was administered."
},
{
"id": "Immunization.vaccineCode.id",
"path": "Immunization.vaccineCode.id",
"max": "0"
},
{
"id": "Immunization.vaccineCode.coding",
"path": "Immunization.vaccineCode.coding",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "code"
}
],
"rules": "open"
}
},
{
"id": "Immunization.vaccineCode.coding.id",
"path": "Immunization.vaccineCode.coding.id",
"max": "0"
},
{
"id": "Immunization.vaccineCode.coding:AgentNVC",
"path": "Immunization.vaccineCode.coding",
"sliceName": "AgentNVC",
"short": "Agent administered",
"definition": "Agent code and name in NVC",
"min": 1,
"max": "1"
},
{
"id": "Immunization.vaccineCode.coding:AgentNVC.id",
"path": "Immunization.vaccineCode.coding.id",
"max": "0"
},
{
"id": "Immunization.vaccineCode.coding:AgentNVC.system",
"path": "Immunization.vaccineCode.coding.system",
"comment": "See Mappings",
"min": 1,
"mapping": [
{
"identity": "code-NVC",
"map": "https://nvc-cnv.canada.ca"
},
{
"identity": "code-SNOMED",
"map": "http://snomed.info/sct"
}
]
},
{
"id": "Immunization.vaccineCode.coding:AgentNVC.version",
"path": "Immunization.vaccineCode.coding.version",
"max": "0"
},
{
"id": "Immunization.vaccineCode.coding:AgentNVC.code",
"path": "Immunization.vaccineCode.coding.code",
"comment": "See Mappings",
"min": 1,
"mapping": [
{
"identity": "source-PIR",
"map": "BCYREPORTING.RBCY_FN_GET_CONCEPT_CODE(H33_VACCINATION_MASTER_ASIIS_VACC_CODE)"
},
{
"identity": "source-PHSL",
"map": "immunizationAgentCode"
}
]
},
{
"id": "Immunization.vaccineCode.coding:AgentNVC.display",
"path": "Immunization.vaccineCode.coding.display",
"comment": "See Mappings",
"min": 1,
"mapping": [
{
"identity": "source-PIR",
"map": "REPORTING.GET_ITERM_DESC(H33_VACCINATION_MASTER_ASIIS_VACC_CODE)"
},
{
"identity": "source-PHSL",
"map": "immunizationAgentDescription"
}
]
},
{
"id": "Immunization.vaccineCode.coding:AgentNVC.userSelected",
"path": "Immunization.vaccineCode.coding.userSelected",
"max": "0"
},
{
"id": "Immunization.vaccineCode.coding:AgentPIR",
"path": "Immunization.vaccineCode.coding",
"sliceName": "AgentPIR",
"max": "1"
},
{
"id": "Immunization.vaccineCode.coding:AgentPIR.id",
"path": "Immunization.vaccineCode.coding.id",
"max": "0"
},
{
"id": "Immunization.vaccineCode.coding:AgentPIR.system",
"path": "Immunization.vaccineCode.coding.system",
"comment": "See Mappings",
"min": 1,
"mapping": [
{
"identity": "code-PIR",
"map": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-panorama-code"
}
]
},
{
"id": "Immunization.vaccineCode.coding:AgentPIR.version",
"path": "Immunization.vaccineCode.coding.version",
"max": "0"
},
{
"id": "Immunization.vaccineCode.coding:AgentPIR.code",
"path": "Immunization.vaccineCode.coding.code",
"min": 1
},
{
"id": "Immunization.vaccineCode.coding:AgentPIR.display",
"path": "Immunization.vaccineCode.coding.display",
"min": 1
},
{
"id": "Immunization.vaccineCode.coding:AgentPIR.userSelected",
"path": "Immunization.vaccineCode.coding.userSelected",
"max": "0"
},
{
"id": "Immunization.vaccineCode.coding:Tradename",
"path": "Immunization.vaccineCode.coding",
"sliceName": "Tradename",
"short": "Tradename administered",
"definition": "Tradename of agent administered",
"comment": "Tradename of agent administered",
"max": "1"
},
{
"id": "Immunization.vaccineCode.coding:Tradename.id",
"path": "Immunization.vaccineCode.coding.id",
"max": "0"
},
{
"id": "Immunization.vaccineCode.coding:Tradename.system",
"path": "Immunization.vaccineCode.coding.system",
"comment": "See Mappings",
"min": 1,
"mapping": [
{
"identity": "code-CVC",
"map": "https://cvc.canimmunize.ca"
},
{
"identity": "code-SNOMED",
"map": "http://snomed.info/sct"
}
]
},
{
"id": "Immunization.vaccineCode.coding:Tradename.version",
"path": "Immunization.vaccineCode.coding.version",
"max": "0"
},
{
"id": "Immunization.vaccineCode.coding:Tradename.code",
"path": "Immunization.vaccineCode.coding.code",
"comment": "See Mappings",
"min": 1,
"mapping": [
{
"identity": "source-PIR",
"map": "BCYREPORTNG.RBCY_FN_GET_CONCEPT_CODE (H33_VACCINATION_MASTER.ASIIS_VACC_CODE)"
},
{
"identity": "source-PHSL",
"map": "tradeName"
}
]
},
{
"id": "Immunization.vaccineCode.coding:Tradename.display",
"path": "Immunization.vaccineCode.coding.display",
"comment": "See Mappings",
"mapping": [
{
"identity": "source-PIR",
"map": "REPORTNG.GET_ITERM_DESC(H33_VACCINATION_MASTER.ASIIS_VACC_CODE)"
}
]
},
{
"id": "Immunization.vaccineCode.coding:Tradename.userSelected",
"path": "Immunization.vaccineCode.coding.userSelected",
"max": "0"
},
{
"id": "Immunization.vaccineCode.text",
"path": "Immunization.vaccineCode.text",
"comment": "See Mappings",
"mapping": [
{
"identity": "source-PIR",
"map": "immunizationAgentCombineDescription"
},
{
"identity": "source-PHSL",
"map": "immunizationAgentCombineDescription"
}
]
},
{
"id": "Immunization.patient.id",
"path": "Immunization.patient.id",
"max": "0"
},
{
"id": "Immunization.patient.reference",
"path": "Immunization.patient.reference",
"comment": "See Mappings",
"min": 1,
"mapping": [
{
"identity": "source-PIR",
"map": "fullURL of Panorama + \"Patient'+PIR Client ID"
}
]
},
{
"id": "Immunization.patient.type",
"path": "Immunization.patient.type",
"max": "0"
},
{
"id": "Immunization.patient.identifier",
"path": "Immunization.patient.identifier",
"max": "0"
},
{
"id": "Immunization.patient.display",
"path": "Immunization.patient.display",
"max": "0"
},
{
"id": "Immunization.occurrence[x]",
"path": "Immunization.occurrence[x]",
"definition": "Date vaccine administered",
"comment": "See Mappings",
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "source-PIR",
"map": "imms.h33_vaccination_master.vacc_date"
},
{
"identity": "source-PHSL",
"map": "vaccDate"
}
]
},
{
"id": "Immunization.occurrence[x].extension:_occurrenceDateTime",
"path": "Immunization.occurrence[x].extension",
"sliceName": "_occurrenceDateTime",
"short": "Estimated Flag for Vaccination Date",
"definition": "Estimated Flag for Vaccination Date",
"comment": "See Mappings",
"type": [
{
"code": "Extension",
"profile": [
"https://ehealthontario.ca/API/FHIR/StructureDefinition/ca-on-extension-estimated-date"
]
}
],
"mapping": [
{
"identity": "source-PHSL",
"map": "VM.VACC_DATE_ESTIMATED_IND = 'Y"
},
{
"identity": "source-PHSL",
"map": "note=\"E\""
}
]
},
{
"id": "Immunization.occurrence[x].extension:_occurrenceDateTime.value[x]",
"path": "Immunization.occurrence[x].extension.value[x]",
"comment": "Apply PIR: H33_VACCINATION_MASTER.VACC_DATE"
},
{
"id": "Immunization.location",
"path": "Immunization.location",
"short": "Immunization Service Delivery Location (SDL)",
"definition": "Immunization Service Delivery Location (SDL)",
"comment": "See Mappings",
"mapping": [
{
"identity": "source-PHSL",
"map": "serviceDeliveryLocationName"
},
{
"identity": "source-PIR",
"map": "H33_VACCINATION_MASTER.location_id"
}
]
},
{
"id": "Immunization.location.id",
"path": "Immunization.location.id",
"max": "0"
},
{
"id": "Immunization.location.reference",
"path": "Immunization.location.reference",
"comment": "fullURL of Panorama + 'Location' + PIR Loc ID + 'org' + PIR Imms Org ID",
"min": 1
},
{
"id": "Immunization.location.type",
"path": "Immunization.location.type",
"max": "0"
},
{
"id": "Immunization.location.identifier",
"path": "Immunization.location.identifier",
"max": "0"
},
{
"id": "Immunization.location.display",
"path": "Immunization.location.display",
"max": "0"
},
{
"id": "Immunization.lotNumber",
"path": "Immunization.lotNumber",
"comment": "See Mappings",
"mapping": [
{
"identity": "source-PIR",
"map": "INV_PRODUCT_LOT_INFO.LOT_NUMBER"
},
{
"identity": "source-PHSL",
"map": "lotNumber"
}
]
},
{
"id": "Immunization.site.id",
"path": "Immunization.site.id",
"max": "0"
},
{
"id": "Immunization.site.coding.id",
"path": "Immunization.site.coding.id",
"max": "0"
},
{
"id": "Immunization.site.coding.system",
"path": "Immunization.site.coding.system",
"comment": "Use 'http://snomed.info/sct''"
},
{
"id": "Immunization.site.coding.version",
"path": "Immunization.site.coding.version",
"max": "0"
},
{
"id": "Immunization.site.coding.code",
"path": "Immunization.site.coding.code",
"comment": "Apply SNOMED code"
},
{
"id": "Immunization.site.coding.userSelected",
"path": "Immunization.site.coding.userSelected",
"max": "0"
},
{
"id": "Immunization.site.text",
"path": "Immunization.site.text",
"max": "0"
},
{
"id": "Immunization.route.id",
"path": "Immunization.route.id",
"max": "0"
},
{
"id": "Immunization.route.coding.id",
"path": "Immunization.route.coding.id",
"max": "0"
},
{
"id": "Immunization.route.coding.system",
"path": "Immunization.route.coding.system",
"comment": "Use 'http://snomed.info/sct'"
},
{
"id": "Immunization.route.coding.version",
"path": "Immunization.route.coding.version",
"max": "0"
},
{
"id": "Immunization.route.coding.code",
"path": "Immunization.route.coding.code",
"comment": "Apply SNOMED code"
},
{
"id": "Immunization.route.coding.userSelected",
"path": "Immunization.route.coding.userSelected",
"max": "0"
},
{
"id": "Immunization.route.text",
"path": "Immunization.route.text",
"max": "0"
},
{
"id": "Immunization.doseQuantity.id",
"path": "Immunization.doseQuantity.id",
"max": "0"
},
{
"id": "Immunization.doseQuantity.value",
"path": "Immunization.doseQuantity.value",
"comment": "See Mappings",
"mapping": [
{
"identity": "source-PIR",
"map": "H33_VACCINATION_MASTER.CC_VOLUME"
},
{
"identity": "source-PHSL",
"map": "dosage"
}
]
},
{
"id": "Immunization.doseQuantity.unit",
"path": "Immunization.doseQuantity.unit",
"comment": "See Mappings",
"mapping": [
{
"identity": "source-PIR",
"map": "H33_VACCINATION_MASTER.DOSAGE_UOM_CNCPT_ID"
},
{
"identity": "source-PHSL",
"map": "dosageUOMDescription"
}
]
},
{
"id": "Immunization.doseQuantity.system",
"path": "Immunization.doseQuantity.system",
"max": "0"
},
{
"id": "Immunization.doseQuantity.code",
"path": "Immunization.doseQuantity.code",
"max": "0"
},
{
"id": "Immunization.performer.actor",
"path": "Immunization.performer.actor",
"short": "Provider who administered the vaccine",
"definition": "Provider who administered the vaccine"
},
{
"id": "Immunization.performer.actor.reference",
"path": "Immunization.performer.actor.reference",
"comment": "fullURL of Panorama + 'Practitioner' + PIR Provider ID"
},
{
"id": "Immunization.note",
"path": "Immunization.note",
"comment": "See Mappings",
"mapping": [
{
"identity": "source-PIR",
"map": "IMMUNIZATION_COMMENT.COMMENT_TEXT"
},
{
"identity": "source-PHSL",
"map": "commentText"
}
]
},
{
"id": "Immunization.reasonCode",
"path": "Immunization.reasonCode",
"max": "1"
},
{
"id": "Immunization.reasonReference",
"path": "Immunization.reasonReference",
"max": "1"
},
{
"id": "Immunization.isSubpotent",
"path": "Immunization.isSubpotent",
"definition": "Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent. If dose potency has been overriden, set to \"true\".",
"comment": "See Mappings",
"mapping": [
{
"identity": "source-PIR",
"map": "PIR imms.vaccine_status.status",
"comment": "If invalid, \"1350752\""
},
{
"identity": "source-PHSL",
"map": "note=\"O\""
}
]
},
{
"id": "Immunization.subpotentReason",
"path": "Immunization.subpotentReason",
"short": "Reason + Status for being subpotent",
"definition": "Reason why a dose is considered to be subpotent and Status.",
"comment": "See Mappings",
"mapping": [
{
"identity": "source-PIR",
"map": "imms.vaccine_status.status_reason"
}
]
},
{
"id": "Immunization.subpotentReason.coding",
"path": "Immunization.subpotentReason.coding",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "code"
}
],
"rules": "open"
},
"min": 1,
"max": "1"
},
{
"id": "Immunization.subpotentReason.coding:doseStatusReason",
"path": "Immunization.subpotentReason.coding",
"sliceName": "doseStatusReason",
"short": "Slice 1: Dose Status Overriden Reason",
"definition": "Dose Status Overriden Reason",
"comment": "To be applied when vaccine status = \"OI\", \"OV\".",
"max": "1"
},
{
"id": "Immunization.subpotentReason.coding:doseStatusReason.id",
"path": "Immunization.subpotentReason.coding.id",
"max": "0"
},
{
"id": "Immunization.subpotentReason.coding:doseStatusReason.system",
"path": "Immunization.subpotentReason.coding.system",
"comment": "See Mappings",
"min": 1,
"mapping": [
{
"identity": "source-PIR",
"map": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-panorama-code"
}
]
},
{
"id": "Immunization.subpotentReason.coding:doseStatusReason.code",
"path": "Immunization.subpotentReason.coding.code",
"min": 1
},
{
"id": "Immunization.subpotentReason.coding:doseStatusReason.display",
"path": "Immunization.subpotentReason.coding.display",
"comment": "See Mappings",
"min": 1,
"mapping": [
{
"identity": "source-PIR-doseStatusReason",
"map": "\"Reason - \" + BCYREPORTNG.RBCY_FN_GET_AGENT_STATUS(H33_VACCINATION_MASTER.IMMUNIZATION_ID)"
}
]
},
{
"id": "Immunization.subpotentReason.coding:doseStatus",
"path": "Immunization.subpotentReason.coding",
"sliceName": "doseStatus",
"short": "Dose Status if overriden",
"definition": "Dose Status if overriden (from Valid to Invalid) or (from Invalid to Valid)",
"min": 1,
"max": "1"
},
{
"id": "Immunization.subpotentReason.coding:doseStatus.system",
"path": "Immunization.subpotentReason.coding.system",
"comment": "Use 'https://ehealth.bc.ca/fhir/CodeSystem/ca-bc-dose-status'",
"min": 1
},
{
"id": "Immunization.subpotentReason.coding:doseStatus.code",
"path": "Immunization.subpotentReason.coding.code",
"comment": "See Mappings",
"min": 1,
"mapping": [
{
"identity": "source-PIR",
"map": "BCYREPORTNG.RBCY_FN_GET_AGENT_STATUS"
},
{
"identity": "source-PHSL",
"map": "agentOverrideStatus"
}
]
},
{
"id": "Immunization.subpotentReason.coding:doseStatus.display",
"path": "Immunization.subpotentReason.coding.display",
"comment": "See Mappings",
"min": 1,
"mapping": [
{
"identity": "source-PIR-status",
"map": "\"Status - \" + BCYREPORTNG.RBCY_FN_GET_AGENT_STATUS (VM.IMMUNIZATION_ID) = 'Valid (override)'"
}
]
},
{
"id": "Immunization.subpotentReason.text",
"path": "Immunization.subpotentReason.text",
"comment": "To be applied when vaccine status = \"FI\" Forecaster Invalid.\r\nPIR Forecaster invalidated the imms record for the following possible reasons:\r\n1. Non-WHO approved tradename\r\n2. Administered prior to eligibility – interval or age \r\n3. Additional dose resulting from use of multi-antigen agent\r\n4. Client administered with same agent on same day"
},
{
"id": "Immunization.education",
"path": "Immunization.education",
"max": "1"
},
{
"id": "Immunization.programEligibility",
"path": "Immunization.programEligibility",
"max": "1"
},
{
"id": "Immunization.reaction",
"path": "Immunization.reaction",
"max": "1"
},
{
"id": "Immunization.protocolApplied",
"path": "Immunization.protocolApplied",
"short": "Dose Number or Revised Dose Number",
"definition": "Dose Number or Revised Dose Number"
},
{
"id": "Immunization.protocolApplied.id",
"path": "Immunization.protocolApplied.id",
"max": "0"
},
{
"id": "Immunization.protocolApplied.series",
"path": "Immunization.protocolApplied.series",
"max": "0"
},
{
"id": "Immunization.protocolApplied.authority",
"path": "Immunization.protocolApplied.authority",
"max": "0"
},
{
"id": "Immunization.protocolApplied.targetDisease",
"path": "Immunization.protocolApplied.targetDisease",
"max": "0"
},
{
"id": "Immunization.protocolApplied.doseNumber[x]",
"path": "Immunization.protocolApplied.doseNumber[x]",
"definition": "Nominal position in a series based on Antigen.",
"comment": "Dose Number based on Antigen Level. See Mappings",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "source-PIR",
"map": "BCYREPORTNG.RBCY_FN_GET_AGENT_DOSE_NUM(VM.IMMUNIZATION_ID)"
},
{
"identity": "source-PHSL",
"map": "agentDoseNumber"
}
]
},
{
"id": "Immunization.protocolApplied.doseNumber[x].extension:_doseNumber",
"path": "Immunization.protocolApplied.doseNumber[x].extension",
"sliceName": "_doseNumber",
"short": "Revised Dose Number + Reason + comments",
"definition": "Revised Dose Number + Reason + comments",
"max": "1",
"type": [
{
"code": "Extension",
"profile": [
"http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/immz-revise-dose"
]
}
],
"isModifier": false
},
{
"id": "Immunization.protocolApplied.seriesDoses[x]",
"path": "Immunization.protocolApplied.seriesDoses[x]",
"max": "0"
}
]
}
}