{
"description": null,
"_filename": "Immunization.StructureDefinition.json",
"package_name": "BC-BCY_IDS.01",
"date": "2022-02-04T19:50:20.0867005+00:00",
"derivation": "constraint",
"meta": {
"versionId": "26",
"lastUpdated": "2024-04-25T20:31:42.6598872+00:00"
},
"publisher": null,
"fhirVersion": "4.0.1",
"name": "Immunization",
"mapping": [ {
"uri": "http://hl7.org/fhir/workflow",
"name": "Workflow Pattern",
"identity": "workflow"
}, {
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping",
"identity": "v2"
}, {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
}, {
"uri": "http://hl7.org/fhir/fivews",
"name": "FiveWs Pattern Mapping",
"identity": "w5"
}, {
"uri": "http://hl7.org/v3/cda",
"name": "CDA (R2)",
"identity": "cda"
} ],
"abstract": false,
"type": "Immunization",
"experimental": null,
"resourceType": "StructureDefinition",
"title": null,
"package_version": "1.0.0",
"status": "draft",
"id": "9695bcc6-f33b-4ec2-badd-9b9daf8a0201",
"kind": "resource",
"url": "http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/Immunization",
"version": null,
"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",
"min": 1,
"path": "Immunization.id",
"short": "PIR Internal Immunization ID",
"comment": "See Mappings",
"mapping": [ {
"map": "PIR Imms ID",
"identity": "source-PIR"
}, {
"map": "immunizationId",
"identity": "source-PHSL"
} ],
"definition": "PIR Internal Immunization ID"
}, {
"id": "Immunization.meta",
"min": 1,
"path": "Immunization.meta"
}, {
"id": "Immunization.meta.id",
"max": "0",
"path": "Immunization.meta.id"
}, {
"id": "Immunization.meta.versionId",
"path": "Immunization.meta.versionId",
"comment": "Apply \"2024.04\". This indicates the FHIR Specs as of year 2024 April. Replaces CVC code with NVC code."
}, {
"id": "Immunization.meta.lastUpdated",
"max": "0",
"path": "Immunization.meta.lastUpdated"
}, {
"id": "Immunization.meta.source",
"max": "0",
"path": "Immunization.meta.source"
}, {
"id": "Immunization.meta.profile",
"max": "1",
"min": 1,
"path": "Immunization.meta.profile",
"comment": "Use 'http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/Immunization'"
}, {
"id": "Immunization.meta.security",
"max": "0",
"path": "Immunization.meta.security"
}, {
"id": "Immunization.meta.tag",
"max": "0",
"path": "Immunization.meta.tag"
}, {
"id": "Immunization.implicitRules",
"max": "0",
"path": "Immunization.implicitRules"
}, {
"id": "Immunization.language",
"max": "0",
"path": "Immunization.language"
}, {
"id": "Immunization.text",
"max": "0",
"path": "Immunization.text"
}, {
"id": "Immunization.contained",
"max": "0",
"path": "Immunization.contained"
}, {
"id": "Immunization.extension:antigenDose",
"path": "Immunization.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/immz-antigen" ]
} ],
"short": "Antgien(s) + Antigen Dose Number + Antigen Dose Status associated with the Agent administered",
"sliceName": "antigenDose",
"definition": "Antgien(s) + Antigen Dose Number + Antigen Dose Status associated with the Agent administered",
"isModifier": false
}, {
"id": "Immunization.extension:antigenDose.extension:antigenCode",
"path": "Immunization.extension.extension",
"sliceName": "antigenCode"
}, {
"id": "Immunization.extension:antigenDose.extension:antigenCode.value[x].coding.system",
"path": "Immunization.extension.extension.value[x].coding.system",
"mapping": [ {
"map": "https://nvc-cnv.canada.ca",
"identity": "code-NVC"
} ]
}, {
"id": "Immunization.identifier",
"min": 1,
"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)."
}, {
"id": "Immunization.identifier.id",
"max": "0",
"path": "Immunization.identifier.id"
}, {
"id": "Immunization.identifier.use",
"max": "0",
"path": "Immunization.identifier.use"
}, {
"id": "Immunization.identifier.type",
"min": 1,
"path": "Immunization.identifier.type"
}, {
"id": "Immunization.identifier.type.id",
"max": "0",
"path": "Immunization.identifier.type.id"
}, {
"id": "Immunization.identifier.type.coding",
"max": "0",
"path": "Immunization.identifier.type.coding"
}, {
"id": "Immunization.identifier.type.text",
"min": 1,
"path": "Immunization.identifier.type.text",
"comment": "See Mappings",
"mapping": [ {
"map": "PANORAMAIMMZID'",
"identity": "source-PIR"
}, {
"map": "NHACEDARIMMS",
"identity": "source-NHA"
}, {
"map": "VCHPARISIMMS",
"identity": "source-VCH"
}, {
"map": "FHAPARISIMMS",
"identity": "source-FHA"
}, {
"map": "PHARMANETIMMS",
"identity": "source-PNet"
}, {
"map": "CZNSUBIMMSID",
"identity": "source-CznSub"
}, {
"map": "HEALTHCONNECT",
"identity": "source-immsBC"
}, {
"map": "EFORMIMMSID",
"identity": "source-eForms"
} ]
}, {
"id": "Immunization.identifier.system",
"min": 1,
"path": "Immunization.identifier.system",
"comment": "See Mappings",
"mapping": [ {
"map": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-panorama-document-number",
"identity": "source-PIR"
}, {
"map": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-nha",
"identity": "source-NHA"
}, {
"map": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-fha",
"identity": "source-FHA"
}, {
"map": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-vcha",
"identity": "source-VCH"
}, {
"map": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-pharmanet-document-number",
"identity": "source-PNet"
}, {
"map": "https://ehealthbc.ca/NamingSystem/ca-bc-citizen-submission",
"identity": "source-CznSub"
}, {
"map": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-eForm",
"identity": "source-eForms"
}, {
"map": "https://ehealthbc.ca/NamingSystem/ca-bc-health-connect",
"identity": "source-immsBC"
} ]
}, {
"id": "Immunization.identifier.value",
"min": 1,
"path": "Immunization.identifier.value",
"comment": "See Mappings",
"mapping": [ {
"map": "PIR Immunization ID",
"identity": "source-PIR"
}, {
"map": "FHA PARIS Immunization ID",
"identity": "source-FHA"
}, {
"map": "NHA CeDaR Immunization ID",
"identity": "source-NHA"
}, {
"map": "VCH PARIS Immunization ID",
"identity": "source-VCH"
}, {
"map": "PharmaNet Immunization ID",
"identity": "source-PNet"
}, {
"map": "immunizationId",
"identity": "source-PHSL"
} ]
}, {
"id": "Immunization.identifier.period",
"max": "0",
"path": "Immunization.identifier.period"
}, {
"id": "Immunization.identifier.assigner",
"max": "0",
"path": "Immunization.identifier.assigner"
}, {
"id": "Immunization.status",
"path": "Immunization.status",
"short": "completed | entered-in-error |",
"comment": "IDS sends \"completed\" or \"entered-in-error\" immunization records only.",
"definition": "Indicates the current status of the immunization record."
}, {
"id": "Immunization.statusReason",
"max": "0",
"path": "Immunization.statusReason"
}, {
"id": "Immunization.vaccineCode",
"path": "Immunization.vaccineCode",
"definition": "Vaccine that was administered."
}, {
"id": "Immunization.vaccineCode.id",
"max": "0",
"path": "Immunization.vaccineCode.id"
}, {
"id": "Immunization.vaccineCode.coding",
"path": "Immunization.vaccineCode.coding",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "code",
"type": "value"
} ]
}
}, {
"id": "Immunization.vaccineCode.coding.id",
"max": "0",
"path": "Immunization.vaccineCode.coding.id"
}, {
"id": "Immunization.vaccineCode.coding:AgentNVC",
"max": "1",
"min": 1,
"path": "Immunization.vaccineCode.coding",
"short": "Agent administered",
"sliceName": "AgentNVC",
"definition": "Agent code and name in NVC"
}, {
"id": "Immunization.vaccineCode.coding:AgentNVC.id",
"max": "0",
"path": "Immunization.vaccineCode.coding.id"
}, {
"id": "Immunization.vaccineCode.coding:AgentNVC.system",
"min": 1,
"path": "Immunization.vaccineCode.coding.system",
"comment": "See Mappings",
"mapping": [ {
"map": "https://nvc-cnv.canada.ca",
"identity": "code-NVC"
}, {
"map": "http://snomed.info/sct",
"identity": "code-SNOMED"
} ]
}, {
"id": "Immunization.vaccineCode.coding:AgentNVC.version",
"max": "0",
"path": "Immunization.vaccineCode.coding.version"
}, {
"id": "Immunization.vaccineCode.coding:AgentNVC.code",
"min": 1,
"path": "Immunization.vaccineCode.coding.code",
"comment": "See Mappings",
"mapping": [ {
"map": "BCYREPORTING.RBCY_FN_GET_CONCEPT_CODE(H33_VACCINATION_MASTER_ASIIS_VACC_CODE)",
"identity": "source-PIR"
}, {
"map": "immunizationAgentCode",
"identity": "source-PHSL"
} ]
}, {
"id": "Immunization.vaccineCode.coding:AgentNVC.display",
"min": 1,
"path": "Immunization.vaccineCode.coding.display",
"comment": "See Mappings",
"mapping": [ {
"map": "REPORTING.GET_ITERM_DESC(H33_VACCINATION_MASTER_ASIIS_VACC_CODE)",
"identity": "source-PIR"
}, {
"map": "immunizationAgentDescription",
"identity": "source-PHSL"
} ]
}, {
"id": "Immunization.vaccineCode.coding:AgentNVC.userSelected",
"max": "0",
"path": "Immunization.vaccineCode.coding.userSelected"
}, {
"id": "Immunization.vaccineCode.coding:AgentPIR",
"max": "1",
"path": "Immunization.vaccineCode.coding",
"sliceName": "AgentPIR"
}, {
"id": "Immunization.vaccineCode.coding:AgentPIR.id",
"max": "0",
"path": "Immunization.vaccineCode.coding.id"
}, {
"id": "Immunization.vaccineCode.coding:AgentPIR.system",
"min": 1,
"path": "Immunization.vaccineCode.coding.system",
"comment": "See Mappings",
"mapping": [ {
"map": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-panorama-code",
"identity": "code-PIR"
} ]
}, {
"id": "Immunization.vaccineCode.coding:AgentPIR.version",
"max": "0",
"path": "Immunization.vaccineCode.coding.version"
}, {
"id": "Immunization.vaccineCode.coding:AgentPIR.code",
"min": 1,
"path": "Immunization.vaccineCode.coding.code"
}, {
"id": "Immunization.vaccineCode.coding:AgentPIR.display",
"min": 1,
"path": "Immunization.vaccineCode.coding.display"
}, {
"id": "Immunization.vaccineCode.coding:AgentPIR.userSelected",
"max": "0",
"path": "Immunization.vaccineCode.coding.userSelected"
}, {
"id": "Immunization.vaccineCode.coding:Tradename",
"max": "1",
"path": "Immunization.vaccineCode.coding",
"short": "Tradename administered",
"comment": "Tradename of agent administered",
"sliceName": "Tradename",
"definition": "Tradename of agent administered"
}, {
"id": "Immunization.vaccineCode.coding:Tradename.id",
"max": "0",
"path": "Immunization.vaccineCode.coding.id"
}, {
"id": "Immunization.vaccineCode.coding:Tradename.system",
"min": 1,
"path": "Immunization.vaccineCode.coding.system",
"comment": "See Mappings",
"mapping": [ {
"map": "https://cvc.canimmunize.ca",
"identity": "code-CVC"
}, {
"map": "http://snomed.info/sct",
"identity": "code-SNOMED"
} ]
}, {
"id": "Immunization.vaccineCode.coding:Tradename.version",
"max": "0",
"path": "Immunization.vaccineCode.coding.version"
}, {
"id": "Immunization.vaccineCode.coding:Tradename.code",
"min": 1,
"path": "Immunization.vaccineCode.coding.code",
"comment": "See Mappings",
"mapping": [ {
"map": "BCYREPORTNG.RBCY_FN_GET_CONCEPT_CODE (H33_VACCINATION_MASTER.ASIIS_VACC_CODE)",
"identity": "source-PIR"
}, {
"map": "tradeName",
"identity": "source-PHSL"
} ]
}, {
"id": "Immunization.vaccineCode.coding:Tradename.display",
"path": "Immunization.vaccineCode.coding.display",
"comment": "See Mappings",
"mapping": [ {
"map": "REPORTNG.GET_ITERM_DESC(H33_VACCINATION_MASTER.ASIIS_VACC_CODE)",
"identity": "source-PIR"
} ]
}, {
"id": "Immunization.vaccineCode.coding:Tradename.userSelected",
"max": "0",
"path": "Immunization.vaccineCode.coding.userSelected"
}, {
"id": "Immunization.vaccineCode.text",
"path": "Immunization.vaccineCode.text",
"comment": "See Mappings",
"mapping": [ {
"map": "immunizationAgentCombineDescription",
"identity": "source-PIR"
}, {
"map": "immunizationAgentCombineDescription",
"identity": "source-PHSL"
} ]
}, {
"id": "Immunization.patient.id",
"max": "0",
"path": "Immunization.patient.id"
}, {
"id": "Immunization.patient.reference",
"min": 1,
"path": "Immunization.patient.reference",
"comment": "See Mappings",
"mapping": [ {
"map": "fullURL of Panorama + \"Patient'+PIR Client ID",
"identity": "source-PIR"
} ]
}, {
"id": "Immunization.patient.type",
"max": "0",
"path": "Immunization.patient.type"
}, {
"id": "Immunization.patient.identifier",
"max": "0",
"path": "Immunization.patient.identifier"
}, {
"id": "Immunization.patient.display",
"max": "0",
"path": "Immunization.patient.display"
}, {
"id": "Immunization.encounter",
"max": "0",
"path": "Immunization.encounter"
}, {
"id": "Immunization.occurrence[x]",
"path": "Immunization.occurrence[x]",
"type": [ {
"code": "dateTime"
} ],
"comment": "See Mappings",
"mapping": [ {
"map": "imms.h33_vaccination_master.vacc_date",
"identity": "source-PIR"
}, {
"map": "vaccDate",
"identity": "source-PHSL"
} ],
"definition": "Date vaccine administered"
}, {
"id": "Immunization.occurrence[x].extension:_occurrenceDateTime",
"path": "Immunization.occurrence[x].extension",
"type": [ {
"code": "Extension",
"profile": [ "https://ehealthontario.ca/API/FHIR/StructureDefinition/ca-on-extension-estimated-date" ]
} ],
"short": "Estimated Flag for Vaccination Date",
"comment": "See Mappings",
"mapping": [ {
"map": "VM.VACC_DATE_ESTIMATED_IND = 'Y",
"identity": "source-PHSL"
}, {
"map": "note=\"E\"",
"identity": "source-PHSL"
} ],
"sliceName": "_occurrenceDateTime",
"definition": "Estimated Flag for Vaccination Date"
}, {
"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.recorded",
"max": "0",
"path": "Immunization.recorded"
}, {
"id": "Immunization.primarySource",
"max": "0",
"path": "Immunization.primarySource"
}, {
"id": "Immunization.reportOrigin",
"max": "0",
"path": "Immunization.reportOrigin"
}, {
"id": "Immunization.location",
"path": "Immunization.location",
"short": "Immunization Service Delivery Location (SDL)",
"comment": "See Mappings",
"mapping": [ {
"map": "serviceDeliveryLocationName",
"identity": "source-PHSL"
}, {
"map": "H33_VACCINATION_MASTER.location_id",
"identity": "source-PIR"
} ],
"definition": "Immunization Service Delivery Location (SDL)"
}, {
"id": "Immunization.location.id",
"max": "0",
"path": "Immunization.location.id"
}, {
"id": "Immunization.location.reference",
"min": 1,
"path": "Immunization.location.reference",
"comment": "fullURL of Panorama + 'Location' + PIR Loc ID + 'org' + PIR Imms Org ID"
}, {
"id": "Immunization.location.type",
"max": "0",
"path": "Immunization.location.type"
}, {
"id": "Immunization.location.identifier",
"max": "0",
"path": "Immunization.location.identifier"
}, {
"id": "Immunization.location.display",
"max": "0",
"path": "Immunization.location.display"
}, {
"id": "Immunization.manufacturer",
"max": "0",
"path": "Immunization.manufacturer"
}, {
"id": "Immunization.lotNumber",
"path": "Immunization.lotNumber",
"comment": "See Mappings",
"mapping": [ {
"map": "INV_PRODUCT_LOT_INFO.LOT_NUMBER",
"identity": "source-PIR"
}, {
"map": "lotNumber",
"identity": "source-PHSL"
} ]
}, {
"id": "Immunization.site.id",
"max": "0",
"path": "Immunization.site.id"
}, {
"id": "Immunization.site.coding.id",
"max": "0",
"path": "Immunization.site.coding.id"
}, {
"id": "Immunization.site.coding.system",
"path": "Immunization.site.coding.system",
"comment": "Use 'http://snomed.info/sct''"
}, {
"id": "Immunization.site.coding.version",
"max": "0",
"path": "Immunization.site.coding.version"
}, {
"id": "Immunization.site.coding.code",
"path": "Immunization.site.coding.code",
"comment": "Apply SNOMED code"
}, {
"id": "Immunization.site.coding.userSelected",
"max": "0",
"path": "Immunization.site.coding.userSelected"
}, {
"id": "Immunization.site.text",
"max": "0",
"path": "Immunization.site.text"
}, {
"id": "Immunization.route.id",
"max": "0",
"path": "Immunization.route.id"
}, {
"id": "Immunization.route.coding.id",
"max": "0",
"path": "Immunization.route.coding.id"
}, {
"id": "Immunization.route.coding.system",
"path": "Immunization.route.coding.system",
"comment": "Use 'http://snomed.info/sct'"
}, {
"id": "Immunization.route.coding.version",
"max": "0",
"path": "Immunization.route.coding.version"
}, {
"id": "Immunization.route.coding.code",
"path": "Immunization.route.coding.code",
"comment": "Apply SNOMED code"
}, {
"id": "Immunization.route.coding.userSelected",
"max": "0",
"path": "Immunization.route.coding.userSelected"
}, {
"id": "Immunization.route.text",
"max": "0",
"path": "Immunization.route.text"
}, {
"id": "Immunization.doseQuantity.id",
"max": "0",
"path": "Immunization.doseQuantity.id"
}, {
"id": "Immunization.doseQuantity.value",
"path": "Immunization.doseQuantity.value",
"comment": "See Mappings",
"mapping": [ {
"map": "H33_VACCINATION_MASTER.CC_VOLUME",
"identity": "source-PIR"
}, {
"map": "dosage",
"identity": "source-PHSL"
} ]
}, {
"id": "Immunization.doseQuantity.unit",
"path": "Immunization.doseQuantity.unit",
"comment": "See Mappings",
"mapping": [ {
"map": "H33_VACCINATION_MASTER.DOSAGE_UOM_CNCPT_ID",
"identity": "source-PIR"
}, {
"map": "dosageUOMDescription",
"identity": "source-PHSL"
} ]
}, {
"id": "Immunization.doseQuantity.system",
"max": "0",
"path": "Immunization.doseQuantity.system"
}, {
"id": "Immunization.doseQuantity.code",
"max": "0",
"path": "Immunization.doseQuantity.code"
}, {
"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": [ {
"map": "IMMUNIZATION_COMMENT.COMMENT_TEXT",
"identity": "source-PIR"
}, {
"map": "commentText",
"identity": "source-PHSL"
} ]
}, {
"id": "Immunization.reasonCode",
"max": "0",
"path": "Immunization.reasonCode"
}, {
"id": "Immunization.reasonReference",
"max": "0",
"path": "Immunization.reasonReference"
}, {
"id": "Immunization.isSubpotent",
"path": "Immunization.isSubpotent",
"comment": "See Mappings",
"mapping": [ {
"map": "PIR imms.vaccine_status.status",
"comment": "If invalid, \"1350752\"",
"identity": "source-PIR"
}, {
"map": "note=\"O\"",
"identity": "source-PHSL"
} ],
"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\"."
}, {
"id": "Immunization.subpotentReason",
"path": "Immunization.subpotentReason",
"short": "Reason + Status for being subpotent",
"comment": "See Mappings",
"mapping": [ {
"map": "imms.vaccine_status.status_reason",
"identity": "source-PIR"
} ],
"definition": "Reason why a dose is considered to be subpotent and Status."
}, {
"id": "Immunization.subpotentReason.id",
"max": "0",
"path": "Immunization.subpotentReason.id"
}, {
"id": "Immunization.subpotentReason.coding",
"max": "1",
"min": 1,
"path": "Immunization.subpotentReason.coding",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "code",
"type": "value"
} ]
}
}, {
"id": "Immunization.subpotentReason.coding.id",
"max": "0",
"path": "Immunization.subpotentReason.coding.id"
}, {
"id": "Immunization.subpotentReason.coding.system",
"max": "0",
"path": "Immunization.subpotentReason.coding.system"
}, {
"id": "Immunization.subpotentReason.coding.version",
"max": "0",
"path": "Immunization.subpotentReason.coding.version"
}, {
"id": "Immunization.subpotentReason.coding.userSelected",
"max": "0",
"path": "Immunization.subpotentReason.coding.userSelected"
}, {
"id": "Immunization.subpotentReason.coding:doseStatusReason",
"max": "1",
"path": "Immunization.subpotentReason.coding",
"short": "Slice 1: Dose Status Overriden Reason",
"comment": "To be applied when vaccine status = \"OI\", \"OV\".",
"sliceName": "doseStatusReason",
"definition": "Dose Status Overriden Reason"
}, {
"id": "Immunization.subpotentReason.coding:doseStatusReason.id",
"max": "0",
"path": "Immunization.subpotentReason.coding.id"
}, {
"id": "Immunization.subpotentReason.coding:doseStatusReason.system",
"min": 1,
"path": "Immunization.subpotentReason.coding.system",
"comment": "See Mappings",
"mapping": [ {
"map": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-panorama-code",
"identity": "source-PIR"
} ]
}, {
"id": "Immunization.subpotentReason.coding:doseStatusReason.version",
"max": "0",
"path": "Immunization.subpotentReason.coding.version"
}, {
"id": "Immunization.subpotentReason.coding:doseStatusReason.code",
"min": 1,
"path": "Immunization.subpotentReason.coding.code"
}, {
"id": "Immunization.subpotentReason.coding:doseStatusReason.display",
"min": 1,
"path": "Immunization.subpotentReason.coding.display",
"comment": "See Mappings",
"mapping": [ {
"map": "\"Reason - \" + BCYREPORTNG.RBCY_FN_GET_AGENT_STATUS(H33_VACCINATION_MASTER.IMMUNIZATION_ID)",
"identity": "source-PIR-doseStatusReason"
} ]
}, {
"id": "Immunization.subpotentReason.coding:doseStatusReason.userSelected",
"max": "0",
"path": "Immunization.subpotentReason.coding.userSelected"
}, {
"id": "Immunization.subpotentReason.coding:doseStatus",
"max": "1",
"min": 1,
"path": "Immunization.subpotentReason.coding",
"short": "Dose Status if overriden",
"sliceName": "doseStatus",
"definition": "Dose Status if overriden (from Valid to Invalid) or (from Invalid to Valid)"
}, {
"id": "Immunization.subpotentReason.coding:doseStatus.id",
"max": "0",
"path": "Immunization.subpotentReason.coding.id"
}, {
"id": "Immunization.subpotentReason.coding:doseStatus.system",
"min": 1,
"path": "Immunization.subpotentReason.coding.system",
"comment": "Use 'https://ehealth.bc.ca/fhir/CodeSystem/ca-bc-dose-status'"
}, {
"id": "Immunization.subpotentReason.coding:doseStatus.version",
"max": "0",
"path": "Immunization.subpotentReason.coding.version"
}, {
"id": "Immunization.subpotentReason.coding:doseStatus.code",
"min": 1,
"path": "Immunization.subpotentReason.coding.code",
"comment": "See Mappings",
"mapping": [ {
"map": "BCYREPORTNG.RBCY_FN_GET_AGENT_STATUS",
"identity": "source-PIR"
}, {
"map": "agentOverrideStatus",
"identity": "source-PHSL"
} ]
}, {
"id": "Immunization.subpotentReason.coding:doseStatus.display",
"min": 1,
"path": "Immunization.subpotentReason.coding.display",
"comment": "See Mappings",
"mapping": [ {
"map": "\"Status - \" + BCYREPORTNG.RBCY_FN_GET_AGENT_STATUS (VM.IMMUNIZATION_ID) = 'Valid (override)'",
"identity": "source-PIR-status"
} ]
}, {
"id": "Immunization.subpotentReason.coding:doseStatus.userSelected",
"max": "0",
"path": "Immunization.subpotentReason.coding.userSelected"
}, {
"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",
"max": "0",
"path": "Immunization.education"
}, {
"id": "Immunization.programEligibility",
"max": "0",
"path": "Immunization.programEligibility"
}, {
"id": "Immunization.fundingSource",
"max": "0",
"path": "Immunization.fundingSource"
}, {
"id": "Immunization.reaction",
"max": "0",
"path": "Immunization.reaction"
}, {
"id": "Immunization.protocolApplied",
"path": "Immunization.protocolApplied",
"short": "Dose Number or Revised Dose Number",
"definition": "Dose Number or Revised Dose Number"
}, {
"id": "Immunization.protocolApplied.id",
"max": "0",
"path": "Immunization.protocolApplied.id"
}, {
"id": "Immunization.protocolApplied.series",
"max": "0",
"path": "Immunization.protocolApplied.series"
}, {
"id": "Immunization.protocolApplied.authority",
"max": "0",
"path": "Immunization.protocolApplied.authority"
}, {
"id": "Immunization.protocolApplied.targetDisease",
"max": "0",
"path": "Immunization.protocolApplied.targetDisease"
}, {
"id": "Immunization.protocolApplied.doseNumber[x]",
"path": "Immunization.protocolApplied.doseNumber[x]",
"type": [ {
"code": "string"
} ],
"comment": "Dose Number based on Antigen Level. See Mappings",
"mapping": [ {
"map": "BCYREPORTNG.RBCY_FN_GET_AGENT_DOSE_NUM(VM.IMMUNIZATION_ID)",
"identity": "source-PIR"
}, {
"map": "agentDoseNumber",
"identity": "source-PHSL"
} ],
"definition": "Nominal position in a series based on Antigen."
}, {
"id": "Immunization.protocolApplied.doseNumber[x].extension:_doseNumber",
"max": "1",
"path": "Immunization.protocolApplied.doseNumber[x].extension",
"type": [ {
"code": "Extension",
"profile": [ "http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/immz-revise-dose" ]
} ],
"short": "Revised Dose Number + Reason + comments",
"sliceName": "_doseNumber",
"definition": "Revised Dose Number + Reason + comments",
"isModifier": false
}, {
"id": "Immunization.protocolApplied.seriesDoses[x]",
"max": "0",
"path": "Immunization.protocolApplied.seriesDoses[x]"
} ]
},
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Immunization"
}