FHIR © HL7.org  |  Server Home  |  XIG Home  |  XIG Stats  |  Server Source  |  FHIR  

FHIR IG Statistics: StructureDefinition/f1b0af3a-c77c-4357-be00-acc45bdee22b

Packageca.bc.bcy-ids
Resource TypeStructureDefinition
Idf1b0af3a-c77c-4357-be00-acc45bdee22b
FHIR VersionR4
Sourcehttps://simplifier.net/resolve?scope=ca.bc.bcy-ids@1.0.0&canonical=http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/MessageHeader
URLhttp://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/MessageHeader
Statusdraft
Date2022-03-12T00:03:09.9131217+00:00
NameMessageHeader
TypeMessageHeader
Kindresource

Resources that use this resource

No resources found


Resources that this resource uses

No resources found


Narrative

No narrative content found in resource


Source

{
  "resourceType": "StructureDefinition",
  "id": "f1b0af3a-c77c-4357-be00-acc45bdee22b",
  "meta": {
    "versionId": "18",
    "lastUpdated": "2025-01-24T22:57:28.3446711+00:00"
  },
  "url": "http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/MessageHeader",
  "name": "MessageHeader",
  "status": "draft",
  "date": "2022-03-12T00:03:09.9131217+00:00",
  "fhirVersion": "4.0.1",
  "mapping": [
    {
      "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"
    }
  ],
  "kind": "resource",
  "abstract": false,
  "type": "MessageHeader",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/MessageHeader",
  "derivation": "constraint",
  "differential": {
    "element": [
      {
        "id": "MessageHeader.id",
        "path": "MessageHeader.id",
        "short": "Same unique GUID as resourceBundle.id",
        "comment": "See Mappings",
        "min": 1,
        "mapping": [
          {
            "identity": "bundleID",
            "map": "(bundle.id)"
          }
        ]
      },
      {
        "id": "MessageHeader.meta",
        "path": "MessageHeader.meta",
        "min": 1
      },
      {
        "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",
        "path": "MessageHeader.meta.profile",
        "comment": "Use 'http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/MessageHeader'",
        "min": 1,
        "max": "1",
        "fixedCanonical": "http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/MessageHeader"
      },
      {
        "id": "MessageHeader.meta.security",
        "path": "MessageHeader.meta.security",
        "max": "1"
      },
      {
        "id": "MessageHeader.meta.tag",
        "path": "MessageHeader.meta.tag",
        "max": "1"
      },
      {
        "id": "MessageHeader.contained",
        "path": "MessageHeader.contained",
        "max": "1"
      },
      {
        "id": "MessageHeader.event[x]",
        "path": "MessageHeader.event[x]",
        "comment": "Apply 'http://ehealth.bc.ca/panorama/fhir/MessageHeader'",
        "type": [
          {
            "code": "uri"
          }
        ],
        "fixedUri": "http://ehealth.bc.ca/panorama/fhir/MessageHeader"
      },
      {
        "id": "MessageHeader.destination",
        "path": "MessageHeader.destination",
        "min": 1
      },
      {
        "id": "MessageHeader.destination.name",
        "path": "MessageHeader.destination.name",
        "comment": "See Mappings",
        "min": 1,
        "mapping": [
          {
            "identity": "dest-fha",
            "map": "fha"
          },
          {
            "identity": "dest-HealthGateway",
            "map": "hgwy"
          },
          {
            "identity": "dest-iha",
            "map": "iha"
          },
          {
            "identity": "dest-nha",
            "map": "nha",
            "comment": "NHA COVID Immunization Record"
          },
          {
            "identity": "dest-vcha",
            "map": "vcha"
          },
          {
            "identity": "dest-viha",
            "map": "viha",
            "comment": "VIHA  COVID Immunization Record"
          },
          {
            "identity": "dest-indigenousHealthOrganization",
            "map": "indigenous health organizations"
          }
        ]
      },
      {
        "id": "MessageHeader.destination.target.id",
        "path": "MessageHeader.destination.target.id",
        "max": "0"
      },
      {
        "id": "MessageHeader.destination.target.reference",
        "path": "MessageHeader.destination.target.reference",
        "max": "0"
      },
      {
        "id": "MessageHeader.destination.target.type",
        "path": "MessageHeader.destination.target.type",
        "max": "0"
      },
      {
        "id": "MessageHeader.destination.target.identifier",
        "path": "MessageHeader.destination.target.identifier",
        "max": "0"
      },
      {
        "id": "MessageHeader.destination.target.display",
        "path": "MessageHeader.destination.target.display",
        "max": "0"
      },
      {
        "id": "MessageHeader.destination.endpoint",
        "path": "MessageHeader.destination.endpoint",
        "comment": "See Mappings",
        "mapping": [
          {
            "identity": "dest-fha",
            "map": "[id-system-local-base]/ca-bc-fha"
          },
          {
            "identity": "dest-HealthGateway",
            "map": "[id-system-local-base]/ca-bc-healthGateway"
          },
          {
            "identity": "dest-iha",
            "map": "[id-system-local-base]/ca-bc-iha"
          },
          {
            "identity": "dest-nha",
            "map": "[id-system-local-base]/ca-bc-nha",
            "comment": "NHA endpoint"
          },
          {
            "identity": "dest-OutOfBC",
            "map": "[id-system-local-base]/ca-bc-outofprovince"
          },
          {
            "identity": "dest-vch",
            "map": "[id-system-local-base]/ca-bc-vcha"
          },
          {
            "identity": "dest-viha",
            "map": "[id-system-local-base]/ca-bc-viha",
            "comment": "VIHA endpoint"
          },
          {
            "identity": "dest-IndigenousHealthOrganizations",
            "map": "[id-system-local-base]/ca-bc-indigenous health organizations"
          }
        ]
      },
      {
        "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",
        "path": "MessageHeader.source.name",
        "comment": "Hardcode as \"PIR Immz\"",
        "min": 1,
        "fixedString": "PIR Immz"
      },
      {
        "id": "MessageHeader.source.endpoint",
        "path": "MessageHeader.source.endpoint",
        "comment": "See Mappings",
        "mapping": [
          {
            "identity": "PIRtest",
            "map": "https://pir.healthbc.org/test/immunization",
            "comment": "PIR Test Environment"
          },
          {
            "identity": "PIRprod",
            "map": "https://pir.healthbc.org/prod/immunization",
            "comment": "PIR Prod ennvironment"
          }
        ]
      },
      {
        "id": "MessageHeader.responsible",
        "path": "MessageHeader.responsible",
        "short": "The Panorama Organizational Unit and/or Client Health Region which submitted the message contents.",
        "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.",
        "comment": "See Mappings",
        "min": 1,
        "mapping": [
          {
            "identity": "source-PIR",
            "map": "CHR or Submitter's Org"
          },
          {
            "identity": "source-PHSL",
            "map": "clientHealthRegion"
          }
        ]
      },
      {
        "id": "MessageHeader.responsible.reference",
        "path": "MessageHeader.responsible.reference",
        "comment": "fullURL of Panorama + 'Organization' + (PIR Org ID).",
        "min": 1
      },
      {
        "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": [
          {
            "identity": "trigger-CHR",
            "map": "CLIENT"
          },
          {
            "identity": "trriger-humanSubject",
            "map": "CLIENT"
          },
          {
            "identity": "trigger-riskFactor",
            "map": "RISKFACTOR"
          },
          {
            "identity": "trigger-subjectName",
            "map": "CLIENT"
          },
          {
            "identity": "trigger-consent",
            "map": "CONSENT"
          },
          {
            "identity": "trigger-consentComment",
            "map": "CONSENTCMMT"
          },
          {
            "identity": "trigger-AEFI",
            "map": "AEFI"
          },
          {
            "identity": "trigger-aefiRecommendation",
            "map": "AEFI"
          },
          {
            "identity": "trigger-invalidVaccine",
            "map": "IMMS"
          },
          {
            "identity": "trigger-deferral",
            "map": "DEFERRAL"
          },
          {
            "identity": "trigger-forecast",
            "map": "FORECAST"
          },
          {
            "identity": "trigger-vaccination",
            "map": "IMMS"
          },
          {
            "identity": "trigger-immsComments-IC",
            "map": "IMMSCMMTIC"
          },
          {
            "identity": "trigger-immsComments-SC",
            "map": "IMMSCMMTSC"
          },
          {
            "identity": "trigger-immsComments-DF",
            "map": "IMMSCMMTDF"
          },
          {
            "identity": "trigger-immsComments-AE",
            "map": "IMMSCMMTAE"
          },
          {
            "identity": "trigger-specialConsideration",
            "map": "SPECIALCONSID"
          },
          {
            "identity": "trigger-vaccineStatus",
            "map": "IMMS"
          },
          {
            "identity": "trigger-clientMerge",
            "map": "CLIENT"
          }
        ]
      },
      {
        "id": "MessageHeader.reason.id",
        "path": "MessageHeader.reason.id",
        "max": "0"
      },
      {
        "id": "MessageHeader.reason.coding",
        "path": "MessageHeader.reason.coding",
        "max": "0"
      },
      {
        "id": "MessageHeader.reason.text",
        "path": "MessageHeader.reason.text",
        "comment": "To be applied if IDS message contains only Forecasting data only.  See Mappings.",
        "mapping": [
          {
            "identity": "source-PIR",
            "map": "Forecast"
          }
        ]
      },
      {
        "id": "MessageHeader.focus",
        "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.",
        "min": 1,
        "max": "1"
      },
      {
        "id": "MessageHeader.focus.reference",
        "path": "MessageHeader.focus.reference",
        "comment": "fullURL of Panorama + 'Patient' + PIR Client ID",
        "min": 1
      }
    ]
  }
}