{
"description": null,
"_filename": "MessageHeader.StructureDefinition.json",
"package_name": "ca.bc.bcy-ids",
"date": "2022-03-12T00:03:09.9131217+00:00",
"derivation": "constraint",
"meta": {
"versionId": "18",
"lastUpdated": "2025-01-24T22:57:28.3446711+00:00"
},
"publisher": null,
"fhirVersion": "4.0.1",
"name": "MessageHeader",
"mapping": [ {
"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"
} ],
"abstract": false,
"type": "MessageHeader",
"experimental": null,
"resourceType": "StructureDefinition",
"title": null,
"package_version": "1.0.0",
"status": "draft",
"id": "5f62e6db-9942-42f8-ab33-9e8f55c400a3",
"kind": "resource",
"url": "http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/MessageHeader",
"version": null,
"differential": {
"element": [ {
"id": "MessageHeader.id",
"min": 1,
"path": "MessageHeader.id",
"short": "Same unique GUID as resourceBundle.id",
"comment": "See Mappings",
"mapping": [ {
"map": "(bundle.id)",
"identity": "bundleID"
} ]
}, {
"id": "MessageHeader.meta",
"min": 1,
"path": "MessageHeader.meta"
}, {
"id": "MessageHeader.meta.versionId",
"path": "MessageHeader.meta.versionId",
"comment": "Apply '2025.01.1' (This indicates FHIR changes onJan 2025)."
}, {
"id": "MessageHeader.meta.lastUpdated",
"path": "MessageHeader.meta.lastUpdated",
"comment": "Updated: Relax the previously crossed-out elements."
}, {
"id": "MessageHeader.meta.profile",
"max": "1",
"min": 1,
"path": "MessageHeader.meta.profile",
"comment": "Use 'http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/MessageHeader'",
"fixedCanonical": "http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/MessageHeader"
}, {
"id": "MessageHeader.meta.security",
"max": "1",
"path": "MessageHeader.meta.security"
}, {
"id": "MessageHeader.meta.tag",
"max": "1",
"path": "MessageHeader.meta.tag"
}, {
"id": "MessageHeader.contained",
"max": "1",
"path": "MessageHeader.contained"
}, {
"id": "MessageHeader.event[x]",
"path": "MessageHeader.event[x]",
"type": [ {
"code": "uri"
} ],
"comment": "Apply 'http://ehealth.bc.ca/panorama/fhir/MessageHeader'",
"fixedUri": "http://ehealth.bc.ca/panorama/fhir/MessageHeader"
}, {
"id": "MessageHeader.destination",
"min": 1,
"path": "MessageHeader.destination"
}, {
"id": "MessageHeader.destination.name",
"min": 1,
"path": "MessageHeader.destination.name",
"comment": "See Mappings",
"mapping": [ {
"map": "fha",
"identity": "dest-fha"
}, {
"map": "hgwy",
"identity": "dest-HealthGateway"
}, {
"map": "iha",
"identity": "dest-iha"
}, {
"map": "nha",
"comment": "NHA COVID Immunization Record",
"identity": "dest-nha"
}, {
"map": "vcha",
"identity": "dest-vcha"
}, {
"map": "viha",
"comment": "VIHA COVID Immunization Record",
"identity": "dest-viha"
}, {
"map": "indigenous health organizations",
"identity": "dest-indigenousHealthOrganization"
} ]
}, {
"id": "MessageHeader.destination.target.id",
"max": "0",
"path": "MessageHeader.destination.target.id"
}, {
"id": "MessageHeader.destination.target.reference",
"max": "0",
"path": "MessageHeader.destination.target.reference"
}, {
"id": "MessageHeader.destination.target.type",
"max": "0",
"path": "MessageHeader.destination.target.type"
}, {
"id": "MessageHeader.destination.target.identifier",
"max": "0",
"path": "MessageHeader.destination.target.identifier"
}, {
"id": "MessageHeader.destination.target.display",
"max": "0",
"path": "MessageHeader.destination.target.display"
}, {
"id": "MessageHeader.destination.endpoint",
"path": "MessageHeader.destination.endpoint",
"comment": "See Mappings",
"mapping": [ {
"map": "[id-system-local-base]/ca-bc-fha",
"identity": "dest-fha"
}, {
"map": "[id-system-local-base]/ca-bc-healthGateway",
"identity": "dest-HealthGateway"
}, {
"map": "[id-system-local-base]/ca-bc-iha",
"identity": "dest-iha"
}, {
"map": "[id-system-local-base]/ca-bc-nha",
"comment": "NHA endpoint",
"identity": "dest-nha"
}, {
"map": "[id-system-local-base]/ca-bc-outofprovince",
"identity": "dest-OutOfBC"
}, {
"map": "[id-system-local-base]/ca-bc-vcha",
"identity": "dest-vch"
}, {
"map": "[id-system-local-base]/ca-bc-viha",
"comment": "VIHA endpoint",
"identity": "dest-viha"
}, {
"map": "[id-system-local-base]/ca-bc-indigenous health organizations",
"identity": "dest-IndigenousHealthOrganizations"
} ]
}, {
"id": "MessageHeader.source",
"path": "MessageHeader.source",
"short": "Message source application - PIR",
"definition": "The source application from which this message originated - Provincial Immunization Registry (PIR)"
}, {
"id": "MessageHeader.source.name",
"min": 1,
"path": "MessageHeader.source.name",
"comment": "Hardcode as \"PIR Immz\"",
"fixedString": "PIR Immz"
}, {
"id": "MessageHeader.source.endpoint",
"path": "MessageHeader.source.endpoint",
"comment": "See Mappings",
"mapping": [ {
"map": "https://pir.healthbc.org/test/immunization",
"comment": "PIR Test Environment",
"identity": "PIRtest"
}, {
"map": "https://pir.healthbc.org/prod/immunization",
"comment": "PIR Prod ennvironment",
"identity": "PIRprod"
} ]
}, {
"id": "MessageHeader.responsible",
"min": 1,
"path": "MessageHeader.responsible",
"short": "The Panorama Organizational Unit and/or Client Health Region which submitted the message contents.",
"comment": "See Mappings",
"mapping": [ {
"map": "CHR or Submitter's Org",
"identity": "source-PIR"
}, {
"map": "clientHealthRegion",
"identity": "source-PHSL"
} ],
"definition": "The Panorama Organizational Unit and/or Client Health Region (CHR) that accepts overall responsibility for the contents of the message. The implication is that the message event happened under the policies of the responsible party."
}, {
"id": "MessageHeader.responsible.reference",
"min": 1,
"path": "MessageHeader.responsible.reference",
"comment": "fullURL of Panorama + 'Organization' + (PIR Org ID)."
}, {
"id": "MessageHeader.reason",
"path": "MessageHeader.reason",
"comment": "See Mappings. List of event type(s) in alphabetical which have been triggered, also can be applied for filtering purposes.",
"mapping": [ {
"map": "CLIENT",
"identity": "trigger-CHR"
}, {
"map": "CLIENT",
"identity": "trriger-humanSubject"
}, {
"map": "RISKFACTOR",
"identity": "trigger-riskFactor"
}, {
"map": "CLIENT",
"identity": "trigger-subjectName"
}, {
"map": "CONSENT",
"identity": "trigger-consent"
}, {
"map": "CONSENTCMMT",
"identity": "trigger-consentComment"
}, {
"map": "AEFI",
"identity": "trigger-AEFI"
}, {
"map": "AEFI",
"identity": "trigger-aefiRecommendation"
}, {
"map": "IMMS",
"identity": "trigger-invalidVaccine"
}, {
"map": "DEFERRAL",
"identity": "trigger-deferral"
}, {
"map": "FORECAST",
"identity": "trigger-forecast"
}, {
"map": "IMMS",
"identity": "trigger-vaccination"
}, {
"map": "IMMSCMMTIC",
"identity": "trigger-immsComments-IC"
}, {
"map": "IMMSCMMTSC",
"identity": "trigger-immsComments-SC"
}, {
"map": "IMMSCMMTDF",
"identity": "trigger-immsComments-DF"
}, {
"map": "IMMSCMMTAE",
"identity": "trigger-immsComments-AE"
}, {
"map": "SPECIALCONSID",
"identity": "trigger-specialConsideration"
}, {
"map": "IMMS",
"identity": "trigger-vaccineStatus"
}, {
"map": "CLIENT",
"identity": "trigger-clientMerge"
} ]
}, {
"id": "MessageHeader.reason.id",
"max": "0",
"path": "MessageHeader.reason.id"
}, {
"id": "MessageHeader.reason.coding",
"max": "0",
"path": "MessageHeader.reason.coding"
}, {
"id": "MessageHeader.reason.text",
"path": "MessageHeader.reason.text",
"comment": "To be applied if IDS message contains only Forecasting data only. See Mappings.",
"mapping": [ {
"map": "Forecast",
"identity": "source-PIR"
} ]
}, {
"id": "MessageHeader.focus",
"max": "1",
"min": 1,
"path": "MessageHeader.focus",
"short": "The actual content of the message related to a specific patient.",
"definition": "The actual data of the message all related to a specific patient."
}, {
"id": "MessageHeader.focus.reference",
"min": 1,
"path": "MessageHeader.focus.reference",
"comment": "fullURL of Panorama + 'Patient' + PIR Client ID"
} ]
},
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/MessageHeader"
}