{
"description": "Resource Patient is profiled based on Canadian Baseline",
"_filename": "Patient.StructureDefinition.json",
"package_name": "BC-BCY_IDS.01",
"date": "2022-02-18T18:22:50.968212Z",
"derivation": "constraint",
"meta": {
"versionId": "10",
"lastUpdated": "2024-03-19T21:51:12.972571+00:00"
},
"publisher": null,
"fhirVersion": "4.0.1",
"name": "Patient_CAbaseline",
"abstract": false,
"type": "Patient",
"experimental": null,
"resourceType": "StructureDefinition",
"title": null,
"package_version": "1.0.0",
"status": "draft",
"id": "869c48be-70a1-4e8f-a4bf-5e8ff49b8265",
"kind": "resource",
"url": "http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/Patient",
"version": null,
"differential": {
"element": [ {
"id": "Patient",
"path": "Patient",
"short": "IFHIR resource applies for PIR Client",
"definition": "IFHIR resource applies for PIR Client"
}, {
"id": "Patient.id",
"min": 1,
"path": "Patient.id",
"short": "PIR Client ID",
"comment": "See Mappings",
"mapping": [ {
"map": "PIR subject_id",
"identity": "source-PIR"
} ],
"definition": "Unique Panorama Client ID"
}, {
"id": "Patient.meta",
"min": 1,
"path": "Patient.meta"
}, {
"id": "Patient.meta.id",
"max": "0",
"path": "Patient.meta.id"
}, {
"id": "Patient.meta.versionId",
"path": "Patient.meta.versionId",
"comment": "Apply '2024.03' (This indicates the FHIR Specs changes on 2024-Mar)"
}, {
"id": "Patient.meta.lastUpdated",
"max": "0",
"path": "Patient.meta.lastUpdated"
}, {
"id": "Patient.meta.source",
"max": "0",
"path": "Patient.meta.source"
}, {
"id": "Patient.meta.profile",
"max": "1",
"min": 1,
"path": "Patient.meta.profile",
"comment": "Use 'http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/Patient'"
}, {
"id": "Patient.meta.security",
"max": "0",
"path": "Patient.meta.security"
}, {
"id": "Patient.meta.tag",
"max": "0",
"path": "Patient.meta.tag"
}, {
"id": "Patient.implicitRules",
"max": "0",
"path": "Patient.implicitRules"
}, {
"id": "Patient.language",
"max": "0",
"path": "Patient.language"
}, {
"id": "Patient.text",
"max": "0",
"path": "Patient.text"
}, {
"id": "Patient.contained",
"max": "0",
"path": "Patient.contained"
}, {
"id": "Patient.extension:genderIdentityExtension",
"path": "Patient.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/StructureDefinition/patient-genderIdentity" ]
} ],
"sliceName": "genderIdentityExtension"
}, {
"id": "Patient.extension:genderIdentityExtension.value[x].coding.code",
"path": "Patient.extension.value[x].coding.code",
"mapping": [ {
"map": "CLIENT.HUMAN_SUBJECT.GENDER_IDENTITY_CODED_CNCPT_ID",
"identity": "source-PIR"
} ]
}, {
"id": "Patient.extension:genderIdentityExtension.value[x].text",
"path": "Patient.extension.value[x].text",
"mapping": [ {
"map": "CLIENT.HUMAN_SUBJECT.GENDER_IDENTITY_OTHER",
"identity": "source-PIR"
} ]
}, {
"id": "Patient.identifier",
"min": 1,
"path": "Patient.identifier",
"short": "Identifier(s) for this patient",
"comment": "Extract from PIR ",
"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)."
}, {
"id": "Patient.identifier.id",
"max": "0",
"path": "Patient.identifier.id"
}, {
"id": "Patient.identifier.use",
"max": "0",
"path": "Patient.identifier.use"
}, {
"id": "Patient.identifier.type",
"min": 1,
"path": "Patient.identifier.type"
}, {
"id": "Patient.identifier.type.id",
"max": "0",
"path": "Patient.identifier.type.id"
}, {
"id": "Patient.identifier.type.coding",
"min": 1,
"path": "Patient.identifier.type.coding"
}, {
"id": "Patient.identifier.type.coding.id",
"max": "0",
"path": "Patient.identifier.type.coding.id"
}, {
"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.version",
"max": "0",
"path": "Patient.identifier.type.coding.version"
}, {
"id": "Patient.identifier.type.coding.code",
"path": "Patient.identifier.type.coding.code",
"comment": "See Mappings",
"mapping": [ {
"map": "JHN",
"comment": "For all Canadian provincial health card number",
"identity": "JHN"
}, {
"map": "JPID",
"comment": "Jurisdictional Person Identification",
"identity": "JPID"
}, {
"map": "MR",
"comment": "Medical Record Number",
"identity": "MR"
}, {
"map": "PI",
"comment": "Patient Internal Identifier",
"identity": "PI"
} ]
}, {
"id": "Patient.identifier.type.coding.display",
"max": "0",
"path": "Patient.identifier.type.coding.display"
}, {
"id": "Patient.identifier.type.coding.userSelected",
"max": "0",
"path": "Patient.identifier.type.coding.userSelected"
}, {
"id": "Patient.identifier.type.text",
"path": "Patient.identifier.type.text",
"comment": "See Mappings",
"mapping": [ {
"map": "Panorama Client ID",
"identity": "source-PIR"
}, {
"map": "FHA-PARIS Client ID",
"identity": "source-FHA"
}, {
"map": "NHA- CeDaR ID",
"identity": "source-NHA-CeDaR"
}, {
"map": "NHA - MOIS ID",
"identity": "source-NHA-MOIS"
}, {
"map": "VCH-PARIS Client ID",
"identity": "source-VCH"
}, {
"map": "ProfileEMR_ClientID",
"identity": "source-ProfileEMR"
}, {
"map": "Canadian Armed Forces IDentification Number",
"identity": "source-CAN-ArmedForces"
}, {
"map": "Canadian RCMP Regiment Number",
"identity": "source-CAN-RCMP"
}, {
"map": "Veteran Affairs CAnadian Identification Number",
"identity": "source-CAN-VeteranAffairs"
} ]
}, {
"id": "Patient.identifier.system",
"min": 1,
"path": "Patient.identifier.system",
"comment": "See Mappings below for appropriate URLs and URNs.",
"mapping": [ {
"map": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-patient-healthcare-id",
"comment": "British Columbia, Canada Personal Health Number",
"identity": "JHN-BC"
}, {
"map": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-panorama-client-id",
"identity": "PI-PIR"
}, {
"map": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-yt-patient-healthcare-id",
"identity": "JHN-YT"
}, {
"map": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-fha-patient-id",
"identity": "PI-FHA"
}, {
"map": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-nha-patient-id",
"identity": "PI-NHA"
}, {
"map": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-vcha-patient-id",
"identity": "PI-VCH"
}, {
"map": "urn: 2.16.840.1.113883.3.51.1.1.6.15",
"identity": "PI-CAN-ArmedForces"
}, {
"map": "urn:2.16.840.1.113883.3.51.1.1.6.16",
"identity": "PI-RCMP"
}, {
"map": "urn:2.16.840.1.113883.3.51.1.1.6.18",
"identity": "PI-CAN-VeteranAffairs"
}, {
"map": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-profile-emr-patient-id",
"identity": "PI-ProfileEMR"
} ]
}, {
"id": "Patient.identifier.value",
"min": 1,
"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)",
"mapping": [ {
"map": "Extract from PIR (client.human_subject.health_card_number)",
"identity": "JHN-BC"
}, {
"map": "Extract from PIR (client.human_subject.health_card_number)",
"identity": "JHN-YT"
}, {
"map": "Extract from PIR (client.human_subject.subject_id)",
"identity": "PI-PIR"
}, {
"map": "FHA-PARIS Client ID",
"identity": "PI-FHA"
}, {
"map": "NHA- CeDaR ID",
"identity": "PI-NHA"
}, {
"map": "VCH-PARIS Client ID",
"identity": "PI-VCH"
} ]
}, {
"id": "Patient.identifier.period",
"max": "0",
"path": "Patient.identifier.period"
}, {
"id": "Patient.identifier.period.id",
"max": "0",
"path": "Patient.identifier.period.id"
}, {
"id": "Patient.identifier.assigner",
"max": "0",
"path": "Patient.identifier.assigner"
}, {
"id": "Patient.active",
"min": 1,
"path": "Patient.active",
"short": "Whether this patient's record is in active use in PIR.",
"comment": "Hardcode as 'True' for all PIR active clients.",
"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)."
}, {
"id": "Patient.name",
"min": 1,
"path": "Patient.name",
"comment": "Extract from PIR ",
"definition": "PIR Client Lastname, Firstname, Middlename"
}, {
"id": "Patient.name.id",
"max": "0",
"path": "Patient.name.id"
}, {
"id": "Patient.name.use",
"path": "Patient.name.use",
"comment": "See Mappings",
"mapping": [ {
"map": "official",
"identity": "legal"
}, {
"map": "usual",
"identity": "alias"
} ]
}, {
"id": "Patient.name.text",
"max": "0",
"path": "Patient.name.text"
}, {
"id": "Patient.name.family",
"min": 1,
"path": "Patient.name.family",
"short": "Patient Family Name",
"comment": "Patient Family Name",
"definition": "Patient Family Name"
}, {
"id": "Patient.name.given",
"min": 1,
"path": "Patient.name.given",
"short": "Patient Given Names",
"comment": "Patient Given Names",
"definition": "Patient Given Names"
}, {
"id": "Patient.name.prefix",
"max": "0",
"path": "Patient.name.prefix"
}, {
"id": "Patient.name.suffix",
"max": "0",
"path": "Patient.name.suffix"
}, {
"id": "Patient.name.period",
"max": "0",
"path": "Patient.name.period"
}, {
"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",
"max": "0",
"path": "Patient.telecom.id"
}, {
"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",
"comment": "Patient Phone Number | Email",
"definition": "Patient Phone Number or 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": [ {
"map": "home",
"identity": "pirHOME"
}, {
"map": "work",
"identity": "pirBUSINESS"
}, {
"map": "mobile",
"identity": "pirMOBILE"
} ]
}, {
"id": "Patient.telecom.rank",
"max": "0",
"path": "Patient.telecom.rank"
}, {
"id": "Patient.telecom.period.id",
"max": "0",
"path": "Patient.telecom.period.id"
}, {
"id": "Patient.gender",
"min": 1,
"path": "Patient.gender",
"comment": "Patient Administrative Gender",
"definition": "Patient Administrative Gender. PIR gender \"Undifferentiate\" is mapped to \"unknown\" in FHIR."
}, {
"id": "Patient.gender.id",
"max": "0",
"path": "Patient.gender.id"
}, {
"id": "Patient.birthDate",
"min": 1,
"path": "Patient.birthDate",
"short": "Patient Date of Birth",
"comment": "Patient Date of Birth (yyyy-mm-dd)",
"definition": "Patient Date of Birth"
}, {
"id": "Patient.deceased[x]",
"max": "0",
"path": "Patient.deceased[x]"
}, {
"id": "Patient.address",
"max": "1",
"path": "Patient.address",
"comment": "Extract the LATEST client address from PIR"
}, {
"id": "Patient.address.id",
"max": "0",
"path": "Patient.address.id"
}, {
"id": "Patient.address.use",
"path": "Patient.address.use",
"comment": "See Mappings",
"mapping": [ {
"map": "home",
"identity": "pir-PrimaryHome"
} ],
"definition": "The purpose of this address: home | work"
}, {
"id": "Patient.address.type",
"path": "Patient.address.type",
"comment": "See Mappings.",
"mapping": [ {
"map": "postal",
"identity": "pir-PostalAddress"
} ]
}, {
"id": "Patient.address.text",
"max": "0",
"path": "Patient.address.text"
}, {
"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",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP" ]
} ],
"sliceName": "_line"
}, {
"id": "Patient.address.district",
"max": "0",
"path": "Patient.address.district"
}, {
"id": "Patient.address.period.id",
"max": "0",
"path": "Patient.address.period.id"
}, {
"id": "Patient.maritalStatus",
"max": "0",
"path": "Patient.maritalStatus"
}, {
"id": "Patient.multipleBirth[x]",
"max": "0",
"path": "Patient.multipleBirth[x]"
}, {
"id": "Patient.photo",
"max": "0",
"path": "Patient.photo"
}, {
"id": "Patient.contact",
"max": "0",
"path": "Patient.contact"
}, {
"id": "Patient.communication",
"max": "0",
"path": "Patient.communication"
}, {
"id": "Patient.generalPractitioner",
"max": "0",
"path": "Patient.generalPractitioner"
}, {
"id": "Patient.managingOrganization",
"max": "0",
"path": "Patient.managingOrganization"
}, {
"id": "Patient.link",
"max": "0",
"path": "Patient.link"
}, {
"id": "Patient.link.id",
"max": "0",
"path": "Patient.link.id"
}, {
"id": "Patient.link.other.id",
"max": "0",
"path": "Patient.link.other.id"
}, {
"id": "Patient.link.other.reference",
"min": 1,
"path": "Patient.link.other.reference",
"comment": "See Mappings",
"mapping": [ {
"map": "fullURL of Panorama + 'Patient' + ",
"identity": "resrouceType-PIRID"
} ]
}, {
"id": "Patient.link.other.type",
"max": "0",
"path": "Patient.link.other.type"
}, {
"id": "Patient.link.other.identifier",
"max": "0",
"path": "Patient.link.other.identifier"
}, {
"id": "Patient.link.other.display",
"max": "0",
"path": "Patient.link.other.display"
}, {
"id": "Patient.link.type",
"path": "Patient.link.type",
"comment": "\"replaces\" non-survivor patient id with survivor patient id.",
"definition": "Use 'replaces' for resourcePatient as the survivor patient out of a merge."
} ]
},
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Patient"
}