{
  "resourceType": "StructureDefinition",
  "id": "f68c0e19-c1e1-4a09-bb6a-9b071049522a",
  "meta": {
    "versionId": "10",
    "lastUpdated": "2025-12-05T22:02:50.2267777+00:00"
  },
  "url": "http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/Patient",
  "name": "Patient_CAbaseline",
  "status": "draft",
  "date": "2022-02-18T18:22:50.968212Z",
  "description": "Resource Patient is profiled based on Canadian Baseline",
  "fhirVersion": "4.0.1",
  "kind": "resource",
  "abstract": false,
  "type": "Patient",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Patient",
  "derivation": "constraint",
  "differential": {
    "element": [
      {
        "id": "Patient",
        "path": "Patient",
        "short": "IFHIR resource applies for PIR Client",
        "definition": "IFHIR resource applies for PIR Client"
      },
      {
        "id": "Patient.id",
        "path": "Patient.id",
        "short": "PIR Client ID",
        "definition": "Unique Panorama Client ID",
        "comment": "See Mappings",
        "min": 1,
        "mapping": [
          {
            "identity": "source-PIR",
            "map": "PIR subject_id"
          }
        ]
      },
      {
        "id": "Patient.meta",
        "path": "Patient.meta",
        "min": 1
      },
      {
        "id": "Patient.meta.versionId",
        "path": "Patient.meta.versionId",
        "comment": "Apply '2025.01.1' (This indicates the FHIR Specs changes on 2025 - Jan)"
      },
      {
        "id": "Patient.meta.lastUpdated",
        "path": "Patient.meta.lastUpdated",
        "comment": "Updated: Relax the previously crossed-out elements."
      },
      {
        "id": "Patient.meta.profile",
        "path": "Patient.meta.profile",
        "comment": "Use 'http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/Patient'",
        "min": 1,
        "max": "1"
      },
      {
        "id": "Patient.meta.security",
        "path": "Patient.meta.security",
        "max": "1"
      },
      {
        "id": "Patient.meta.tag",
        "path": "Patient.meta.tag",
        "max": "1"
      },
      {
        "id": "Patient.contained",
        "path": "Patient.contained",
        "max": "1"
      },
      {
        "id": "Patient.extension",
        "path": "Patient.extension",
        "min": 2
      },
      {
        "id": "Patient.extension:genderIdentityExtension",
        "path": "Patient.extension",
        "sliceName": "genderIdentityExtension",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "http://hl7.org/fhir/StructureDefinition/patient-genderIdentity"
            ]
          }
        ]
      },
      {
        "id": "Patient.extension:clientWarningExtension",
        "path": "Patient.extension",
        "sliceName": "clientWarningExtension",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "http://infoway-inforoute.ca/StructureDefinition/ca-bc-client-warning"
            ]
          }
        ],
        "isModifier": false
      },
      {
        "id": "Patient.extension:inactiveClientReasonExtension",
        "path": "Patient.extension",
        "sliceName": "inactiveClientReasonExtension",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "https://ehealth.bc.ca/fhir/StructureDefinition/ca-bc-inactive-client-reason"
            ]
          }
        ],
        "isModifier": false
      },
      {
        "id": "Patient.extension:pIRIdentifierExtension",
        "path": "Patient.extension",
        "sliceName": "pIRIdentifierExtension",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "https://ehealth.bc.ca/fhir/StructureDefinition/bcy-ids-pir-identifier"
            ]
          }
        ],
        "isModifier": false
      },
      {
        "id": "Patient.extension:pIRLockSeqNumberExtension",
        "path": "Patient.extension",
        "sliceName": "pIRLockSeqNumberExtension",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "https://ehealth.bc.ca/fhir/StructureDefinition/bcy-ids-pir-lock-sequence-number"
            ]
          }
        ],
        "isModifier": false
      },
      {
        "id": "Patient.identifier",
        "path": "Patient.identifier",
        "short": "Identifier(s) for this patient",
        "definition": "Different types of patient identifier which includes JHN (Jurisdictional Health Number e.g. BC PHN),  PI (Patient Internal Identifier e.g. PIR Client ID, HAs' Internal Client ID).",
        "comment": "Extract from PIR <client.human_subject>",
        "min": 1
      },
      {
        "id": "Patient.identifier.type",
        "path": "Patient.identifier.type",
        "min": 1
      },
      {
        "id": "Patient.identifier.type.coding",
        "path": "Patient.identifier.type.coding",
        "min": 1
      },
      {
        "id": "Patient.identifier.type.coding.system",
        "path": "Patient.identifier.type.coding.system",
        "comment": "http://terminology.hl7.org/CodeSystem/v2-0203",
        "fixedUri": "http://terminology.hl7.org/CodeSystem/v2-0203"
      },
      {
        "id": "Patient.identifier.type.coding.code",
        "path": "Patient.identifier.type.coding.code",
        "comment": "See Mappings",
        "mapping": [
          {
            "identity": "JHN",
            "map": "JHN",
            "comment": "For all Canadian provincial health card number"
          },
          {
            "identity": "JPID",
            "map": "JPID",
            "comment": "Jurisdictional Person Identification"
          },
          {
            "identity": "MR",
            "map": "MR",
            "comment": "Medical Record Number"
          },
          {
            "identity": "PI",
            "map": "PI",
            "comment": "Patient Internal Identifier"
          }
        ]
      },
      {
        "id": "Patient.identifier.type.text",
        "path": "Patient.identifier.type.text",
        "comment": "See Mappings",
        "mapping": [
          {
            "identity": "source-PIR",
            "map": "Panorama Client ID"
          },
          {
            "identity": "source-FHA",
            "map": "FHA-PARIS Client ID"
          },
          {
            "identity": "source-NHA-CeDaR",
            "map": "NHA- CeDaR ID"
          },
          {
            "identity": "source-NHA-MOIS",
            "map": "NHA - MOIS ID"
          },
          {
            "identity": "source-VCH",
            "map": "VCH-PARIS Client ID"
          },
          {
            "identity": "source-ProfileEMR",
            "map": "ProfileEMR_ClientID"
          },
          {
            "identity": "source-CAN-ArmedForces",
            "map": "Canadian Armed Forces IDentification Number"
          },
          {
            "identity": "source-CAN-RCMP",
            "map": "Canadian RCMP Regiment Number"
          },
          {
            "identity": "source-CAN-VeteranAffairs",
            "map": "Veteran Affairs CAnadian Identification Number"
          }
        ]
      },
      {
        "id": "Patient.identifier.system",
        "path": "Patient.identifier.system",
        "comment": "See Mappings below for appropriate URLs and URNs.",
        "min": 1,
        "mapping": [
          {
            "identity": "JHN-BC",
            "map": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-patient-healthcare-id",
            "comment": "British Columbia, Canada Personal Health Number"
          },
          {
            "identity": "PI-PIR",
            "map": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-panorama-client-id"
          },
          {
            "identity": "JHN-YT",
            "map": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-yt-patient-healthcare-id"
          },
          {
            "identity": "PI-FHA",
            "map": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-fha-patient-id"
          },
          {
            "identity": "PI-NHA",
            "map": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-nha-patient-id"
          },
          {
            "identity": "PI-VCH",
            "map": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-vcha-patient-id"
          },
          {
            "identity": "PI-CAN-ArmedForces",
            "map": "urn: 2.16.840.1.113883.3.51.1.1.6.15"
          },
          {
            "identity": "PI-RCMP",
            "map": "urn:2.16.840.1.113883.3.51.1.1.6.16"
          },
          {
            "identity": "PI-CAN-VeteranAffairs",
            "map": "urn:2.16.840.1.113883.3.51.1.1.6.18"
          },
          {
            "identity": "PI-ProfileEMR",
            "map": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-profile-emr-patient-id"
          }
        ]
      },
      {
        "id": "Patient.identifier.value",
        "path": "Patient.identifier.value",
        "comment": "PIR Client ID: Extract from PIR (client.human_subject.subject_id); BC PHN or Yukon PHN: Extract from PIR (client.human_subject.health_card_number)",
        "min": 1,
        "mapping": [
          {
            "identity": "JHN-BC",
            "map": "Extract from PIR (client.human_subject.health_card_number)"
          },
          {
            "identity": "JHN-YT",
            "map": "Extract from PIR (client.human_subject.health_card_number)"
          },
          {
            "identity": "PI-PIR",
            "map": "Extract from PIR (client.human_subject.subject_id)"
          },
          {
            "identity": "PI-FHA",
            "map": "FHA-PARIS Client ID"
          },
          {
            "identity": "PI-NHA",
            "map": "NHA- CeDaR ID"
          },
          {
            "identity": "PI-VCH",
            "map": "VCH-PARIS Client ID"
          }
        ]
      },
      {
        "id": "Patient.active",
        "path": "Patient.active",
        "short": "Whether this patient's record is in active use in PIR.",
        "definition": "It is used to filter patient lists to exclude inactive patients   Inactive patient lists include inactive reasons in (Created in Error, Retruned to Birth Parent, Adopted, Soft Deleted, Deceased).",
        "comment": "Hardcode as 'True' for all PIR active clients.",
        "min": 1
      },
      {
        "id": "Patient.name",
        "path": "Patient.name",
        "definition": "PIR Client Lastname, Firstname, Middlename",
        "comment": "Extract from PIR <client.human_subject>",
        "min": 1
      },
      {
        "id": "Patient.name.use",
        "path": "Patient.name.use",
        "comment": "See Mappings",
        "mapping": [
          {
            "identity": "legal",
            "map": "official"
          },
          {
            "identity": "alias",
            "map": "usual"
          }
        ]
      },
      {
        "id": "Patient.name.family",
        "path": "Patient.name.family",
        "short": "Patient Family Name",
        "definition": "Patient Family Name",
        "comment": "Patient Family Name",
        "min": 1
      },
      {
        "id": "Patient.name.given",
        "path": "Patient.name.given",
        "short": "Patient Given Names",
        "definition": "Patient Given Names",
        "comment": "Patient Given Names",
        "min": 1
      },
      {
        "id": "Patient.name.prefix",
        "path": "Patient.name.prefix",
        "max": "1"
      },
      {
        "id": "Patient.name.suffix",
        "path": "Patient.name.suffix",
        "max": "1"
      },
      {
        "id": "Patient.telecom",
        "path": "Patient.telecom",
        "short": "A contact detail for the PIR Client",
        "definition": "A contact detail (e.g. a telephone number or an email address) by which the PIR client may be contacted."
      },
      {
        "id": "Patient.telecom.id",
        "path": "Patient.telecom.id",
        "max": "0"
      },
      {
        "id": "Patient.telecom.system",
        "path": "Patient.telecom.system",
        "comment": "Use 'phone | email'. Extract the current phone or email from PIR, not the ones with 'Effective Date To' populated."
      },
      {
        "id": "Patient.telecom.value",
        "path": "Patient.telecom.value",
        "short": "Patient Phone Number or Email",
        "definition": "Patient Phone Number or Email",
        "comment": "Patient Phone Number | Email"
      },
      {
        "id": "Patient.telecom.use",
        "path": "Patient.telecom.use",
        "short": "home | work | mobile - purpose of this contact point",
        "comment": "Use \"home\" | \"work\" |\"mobile\"  (See Mappings).  If not listed in the mappings, drop the attirubte USE, do not send.",
        "mapping": [
          {
            "identity": "pirHOME",
            "map": "home"
          },
          {
            "identity": "pirBUSINESS",
            "map": "work"
          },
          {
            "identity": "pirMOBILE",
            "map": "mobile"
          }
        ]
      },
      {
        "id": "Patient.telecom.rank",
        "path": "Patient.telecom.rank",
        "max": "0"
      },
      {
        "id": "Patient.telecom.period.id",
        "path": "Patient.telecom.period.id",
        "max": "0"
      },
      {
        "id": "Patient.gender",
        "path": "Patient.gender",
        "definition": "Patient Administrative Gender.  PIR gender \"Undifferentiate\" is mapped to \"unknown\" in FHIR.",
        "comment": "Patient Administrative Gender",
        "min": 1
      },
      {
        "id": "Patient.gender.id",
        "path": "Patient.gender.id",
        "max": "0"
      },
      {
        "id": "Patient.birthDate",
        "path": "Patient.birthDate",
        "short": "Patient Date of Birth",
        "definition": "Patient Date of Birth",
        "comment": "Patient Date of Birth (yyyy-mm-dd)",
        "min": 1
      },
      {
        "id": "Patient.address",
        "path": "Patient.address",
        "comment": "If a HOME address exists in PIR, it will always be sent. If the Effective From of Postal Address > Effective From of Home Address, it will also be sent",
        "max": "2"
      },
      {
        "id": "Patient.address.use",
        "path": "Patient.address.use",
        "definition": "The purpose of this address: home | work",
        "comment": "See Mappings",
        "mapping": [
          {
            "identity": "pir-PrimaryHome",
            "map": "home"
          }
        ]
      },
      {
        "id": "Patient.address.type",
        "path": "Patient.address.type",
        "comment": "See Mappings.",
        "mapping": [
          {
            "identity": "pir-PostalAddress",
            "map": "postal"
          }
        ]
      },
      {
        "id": "Patient.address.line",
        "path": "Patient.address.line",
        "comment": "Use address.line for international address"
      },
      {
        "id": "Patient.address.line.extension:_line",
        "path": "Patient.address.line.extension",
        "sliceName": "_line",
        "type": [
          {
            "code": "Extension",
            "profile": [
              "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP"
            ]
          }
        ]
      },
      {
        "id": "Patient.photo",
        "path": "Patient.photo",
        "max": "1"
      },
      {
        "id": "Patient.contact",
        "path": "Patient.contact",
        "max": "1"
      },
      {
        "id": "Patient.communication",
        "path": "Patient.communication",
        "max": "1"
      },
      {
        "id": "Patient.generalPractitioner",
        "path": "Patient.generalPractitioner",
        "max": "1"
      },
      {
        "id": "Patient.link",
        "path": "Patient.link",
        "max": "1"
      },
      {
        "id": "Patient.link.other.id",
        "path": "Patient.link.other.id",
        "max": "0"
      },
      {
        "id": "Patient.link.other.reference",
        "path": "Patient.link.other.reference",
        "comment": "See Mappings",
        "min": 1,
        "mapping": [
          {
            "identity": "resrouceType-PIRID",
            "map": "fullURL of Panorama + 'Patient' + <PIR Client ID>"
          }
        ]
      },
      {
        "id": "Patient.link.type",
        "path": "Patient.link.type",
        "definition": "Use 'replaces' for resourcePatient as the survivor patient out of a merge.",
        "comment": "\"replaces\" non-survivor patient id with survivor patient id."
      }
    ]
  }
}