{
"description": "This profile represents the constraints applied to the Patient resource by the CA Core+ project to represent the minimum expectations for the Patient resource when used to promote capacity building for functionality found across Canadian FHIR implementations. It is informed by the constraints of shared across CIHI pCHDCF data sets and has also undergone analysis to assert alignment with the [Canadian Baseline Patient Profile](http://build.fhir.org/ig/HL7-Canada/ca-baseline/branches/master/StructureDefinition-profile-patient.html)",
"_filename": "structuredefinition-patient-ca-core.json",
"package_name": "ca.infoway.io.core",
"date": null,
"derivation": "constraint",
"publisher": null,
"fhirVersion": "4.0.1",
"name": "PatientCACore",
"mapping": [ {
"name": "Pan-Canadian Health Data Content Framework",
"identity": "pCHDCF"
} ],
"abstract": false,
"copyright": "Copyright © 2024+ Canada Health Infoway. All rights reserved. [Terms of Use and License Agreements](https://ic.infoway-inforoute.ca/en/about/tou). [Privacy Policy](https://www.infoway-inforoute.ca/en/legal/privacy-policy).",
"type": "Patient",
"experimental": "false",
"resourceType": "StructureDefinition",
"title": "Patient (CA-Core)",
"package_version": "0.2.0-dft",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-imposeProfile",
"valueCanonical": "http://hl7.org/fhir/ca/baseline/StructureDefinition/profile-patient"
} ],
"status": "draft",
"id": "7d7ac9de-24cf-41ed-b573-d00d56812da4",
"kind": "resource",
"url": "http://fhir.infoway-inforoute.ca/ca-core/StructureDefinition/patient-ca-core",
"version": null,
"differential": {
"element": [ {
"id": "Patient.extension:individual-recordedSexOrGender",
"path": "Patient.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://fhir.infoway-inforoute.ca/ca-core/StructureDefinition/individual-recordedSexOrGender-ca-core" ]
} ],
"short": "Extension for representing Recorded sex or gender (RSG) information.",
"mapping": [ {
"map": "Recorded Sex Or Gender",
"identity": "pCHDCF"
} ],
"sliceName": "individual-recordedSexOrGender",
"definition": "Recorded sex or gender (RSG) information includes the various sex and gender concepts that are often used in existing systems but are known NOT to represent a gender identity, sex parameter for clinical use, or attributes related to sexuality, such as sexual orientation, sexual activity, or sexual attraction. Examples of recorded sex or gender concepts include administrative gender, administrative sex, and sex assigned at birth. When exchanging this concept, refer to the guidance in the [Gender Harmony Implementation Guide](http://hl7.org/xprod/ig/uv/gender-harmony/)."
}, {
"id": "Patient.extension:individual-pronouns",
"path": "Patient.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://fhir.infoway-inforoute.ca/ca-core/StructureDefinition/individual-pronouns-ca-core" ]
} ],
"short": "Extension for representing the pronouns to use when referring to an individual in verbal or written communication.",
"mapping": [ {
"map": "Pronouns",
"identity": "pCHDCF"
} ],
"sliceName": "individual-pronouns",
"definition": "The pronouns to use when referring to an individual in verbal or written communication."
}, {
"id": "Patient.identifier",
"path": "Patient.identifier"
}, {
"id": "Patient.identifier.type",
"path": "Patient.identifier.type",
"example": [ {
"label": "Jurisdictional Health Number",
"valueCodeableConcept": {
"coding": [ {
"code": "JHN",
"system": "http://terminology.hl7.org/CodeSystem/v2-0203"
} ]
}
}, {
"label": "Medical Record Number",
"valueCodeableConcept": {
"coding": [ {
"code": "MR",
"system": "http://terminology.hl7.org/CodeSystem/v2-0203"
} ]
}
}, {
"label": "Passport Number",
"valueCodeableConcept": {
"coding": [ {
"code": "PPN",
"system": "http://terminology.hl7.org/CodeSystem/v2-0203"
} ]
}
}, {
"label": "National Unique Identifier (Placeholder Concept)",
"valueCodeableConcept": {
"coding": [ {
"code": "NH",
"system": "http://terminology.hl7.org/CodeSystem/v2-0203"
} ]
}
} ],
"mapping": [ {
"map": "Person Identifier Type",
"identity": "pCHDCF"
} ]
}, {
"id": "Patient.identifier.system",
"path": "Patient.identifier.system",
"mapping": [ {
"map": "Person Identifier System",
"identity": "pCHDCF"
} ]
}, {
"id": "Patient.identifier.value",
"path": "Patient.identifier.value",
"mapping": [ {
"map": "Person Identifier Value",
"identity": "pCHDCF"
} ]
}, {
"id": "Patient.identifier.period",
"path": "Patient.identifier.period",
"mapping": [ {
"map": "Person Identifier Period",
"identity": "pCHDCF"
} ]
}, {
"id": "Patient.identifier.assigner",
"path": "Patient.identifier.assigner",
"mapping": [ {
"map": "Person Identifier Assigner",
"identity": "pCHDCF"
} ]
}, {
"id": "Patient.active",
"path": "Patient.active",
"mapping": [ {
"map": "Person Active Status",
"identity": "pCHDCF"
} ]
}, {
"id": "Patient.name",
"path": "Patient.name",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "use",
"type": "pattern"
} ]
},
"constraint": [ {
"key": "ips-pat-2",
"human": "Either Patient.name.given and/or Patient.name.family and/or Patient.name.text SHALL be present or a Data Absent Reason Extension SHALL be present.",
"xpath": "(/f:name/f:extension/@url='http://hl7.org/fhir/StructureDefinition/data-absent-reason' and not(/f:name/f:family or /f:name/f:given or /f:name/f:text)) or (not(/f:name/f:extension/@url='http://hl7.org/fhir/StructureDefinition/data-absent-reason') and (/f:name/f:family or /f:name/f:given or /f:name/f:text))",
"severity": "error",
"expression": "(family.exists() or given.exists() or text.exists()) xor extension.where(url='http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()"
} ]
}, {
"id": "Patient.name.use",
"path": "Patient.name.use",
"mapping": [ {
"map": "Name Type",
"identity": "pCHDCF"
} ]
}, {
"id": "Patient.name.text",
"path": "Patient.name.text",
"mapping": [ {
"map": "Name Text",
"identity": "pCHDCF"
} ],
"definition": "Text representation of the full name. Due to the cultural variance around the world a consuming system may not know how to present the name correctly; moreover not all the parts of the name go in given or family. Creators are therefore strongly encouraged to provide through this element a presented version of the name. Future versions of this guide may require this element"
}, {
"id": "Patient.name.family",
"path": "Patient.name.family",
"mapping": [ {
"map": "Surname",
"identity": "pCHDCF"
} ]
}, {
"id": "Patient.name.given",
"path": "Patient.name.given",
"mapping": [ {
"map": "Given Name",
"identity": "pCHDCF"
}, {
"map": "Middle Name",
"identity": "pCHDCF"
} ]
}, {
"id": "Patient.name:used",
"path": "Patient.name",
"mapping": [ {
"map": "Name Used",
"identity": "pCHDCF"
} ],
"sliceName": "used"
}, {
"id": "Patient.name:used.use",
"path": "Patient.name.use",
"fixedCode": "usual"
}, {
"id": "Patient.name:used.family",
"path": "Patient.name.family",
"mapping": [ {
"map": "Surname*",
"comment": "*Surname in the context of the Name Used concept",
"identity": "pCHDCF"
} ]
}, {
"id": "Patient.name:used.given",
"path": "Patient.name.given",
"mapping": [ {
"map": "Given Name*",
"comment": "*Given Name in the context of the Name Used concept",
"identity": "pCHDCF"
}, {
"map": "Middle Name*",
"comment": "*Middle Name in the context of the Name Used concept",
"identity": "pCHDCF"
} ]
}, {
"id": "Patient.name:previous",
"path": "Patient.name",
"mapping": [ {
"map": "Previous Given Name",
"identity": "pCHDCF"
}, {
"map": "Previous Surname",
"identity": "pCHDCF"
} ],
"sliceName": "previous"
}, {
"id": "Patient.name:previous.use",
"path": "Patient.name.use",
"fixedCode": "old"
}, {
"id": "Patient.name:previous.family",
"path": "Patient.name.family",
"mapping": [ {
"map": "Previous Surname*",
"comment": "*Surname in the context of the name that was previously used",
"identity": "pCHDCF"
} ]
}, {
"id": "Patient.name:previous.given",
"path": "Patient.name.given",
"mapping": [ {
"map": "Previous Given Name*",
"comment": "*Given Name in the context of the name that was previously used",
"identity": "pCHDCF"
} ]
}, {
"id": "Patient.name.period",
"path": "Patient.name.period",
"mapping": [ {
"map": "Name Period",
"identity": "pCHDCF"
} ]
}, {
"id": "Patient.telecom",
"path": "Patient.telecom"
}, {
"id": "Patient.telecom.system",
"path": "Patient.telecom.system",
"mapping": [ {
"map": "Person Telecom System",
"identity": "pCHDCF"
} ]
}, {
"id": "Patient.telecom.value",
"path": "Patient.telecom.value",
"mapping": [ {
"map": "Person Telecom Value",
"identity": "pCHDCF"
} ]
}, {
"id": "Patient.telecom.use",
"path": "Patient.telecom.use",
"mapping": [ {
"map": "Person Telecom Use",
"identity": "pCHDCF"
} ]
}, {
"id": "Patient.telecom.rank",
"path": "Patient.telecom.rank",
"mapping": [ {
"map": "Person Telecom Rank",
"identity": "pCHDCF"
} ]
}, {
"id": "Patient.telecom.period",
"path": "Patient.telecom.period",
"mapping": [ {
"map": "Person Telecom Period",
"identity": "pCHDCF"
} ]
}, {
"id": "Patient.birthDate",
"path": "Patient.birthDate",
"mapping": [ {
"map": "Birth Date",
"identity": "pCHDCF"
} ]
}, {
"id": "Patient.deceased[x]",
"path": "Patient.deceased[x]",
"mapping": [ {
"map": "Date of Death*",
"comment": "*pCHDCF concept as currently defined is expected to map to the DateTime data type",
"identity": "pCHDCF"
} ],
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "$this",
"type": "type"
} ]
}
}, {
"id": "Patient.deceased[x]:deceasedDateTime",
"path": "Patient.deceased[x]",
"type": [ {
"code": "dateTime"
} ],
"mapping": [ {
"map": "Date of Death",
"identity": "pCHDCF"
} ],
"sliceName": "deceasedDateTime"
}, {
"id": "Patient.address",
"path": "Patient.address"
}, {
"id": "Patient.address.extension",
"path": "Patient.address.extension",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
}
}, {
"id": "Patient.address.extension:no-fixed-address",
"path": "Patient.address.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://fhir.infoway-inforoute.ca/ca-core/StructureDefinition/no-fixed-address-ca-core" ]
} ],
"short": "No fixed address indicator",
"mapping": [ {
"map": "Person No Fixed Address Flag",
"identity": "pCHDCF"
} ],
"sliceName": "no-fixed-address",
"definition": "This extension applies to the Address data type and is used to indicate that a location address is not a fixed address for an individual."
}, {
"id": "Patient.address.use",
"path": "Patient.address.use",
"mapping": [ {
"map": "Person Address Use",
"identity": "pCHDCF"
} ]
}, {
"id": "Patient.address.type",
"path": "Patient.address.type",
"mapping": [ {
"map": "Person Address Type",
"identity": "pCHDCF"
} ]
}, {
"id": "Patient.address.text",
"path": "Patient.address.text",
"mapping": [ {
"map": "Person Address*",
"comment": "*May be used to convey multiple pCHDCF address attributes (e.g., line, city, postal code) in a single string",
"identity": "pCHDCF"
} ]
}, {
"id": "Patient.address.line",
"path": "Patient.address.line",
"mapping": [ {
"map": "Person Address Street",
"identity": "pCHDCF"
} ]
}, {
"id": "Patient.address,city",
"path": "Patient.address.city",
"mapping": [ {
"map": "Person Address City",
"identity": "pCHDCF"
} ]
}, {
"id": "Patient.address.state",
"path": "Patient.address.state",
"mapping": [ {
"map": "Person Address Province",
"identity": "pCHDCF"
} ]
}, {
"id": "Patient.address.postalCode",
"path": "Patient.address.postalCode",
"mapping": [ {
"map": "Person Address Postal Code",
"identity": "pCHDCF"
} ]
}, {
"id": "Patient.address.country",
"path": "Patient.address.country",
"mapping": [ {
"map": "Person Address Country",
"identity": "pCHDCF"
} ]
}, {
"id": "Patient.address.period",
"path": "Patient.address.period",
"mapping": [ {
"map": "Person Address Period",
"identity": "pCHDCF"
} ]
}, {
"id": "Patient.contact",
"path": "Patient.contact"
}, {
"id": "Patient.contact.relationship",
"path": "Patient.contact.relationship",
"comment": "Reviewers should be aware that the modelling and terminology for contact.relationship is changing in R6 and that this profile may seek to pre-adopt the changes in order to accommodate better implementation against the pCHDCF concepts for relationship type and role. In the meantime, implementers may continue to provide both role (e.g., emergency contact) and type (e.g., mother) as repetitions on the relationship element which is a CodeableConcept element with 0..* cardinality",
"mapping": [ {
"map": "Contact Relationship Type",
"identity": "pCHDCF"
}, {
"map": "Contact Relationship Role*",
"comment": "*Mapping to current available element, reviewers should be aware that the modelling and terminology for contact.relationship is changing and this mapping target may evolve with those changes (see https://jira.hl7.org/browse/FHIR-15841)",
"identity": "pCHDCF"
} ]
}, {
"id": "Patient.contact.name",
"path": "Patient.contact.name"
}, {
"id": "Patient.contact.name.use",
"path": "Patient.contact.name.use",
"mapping": [ {
"map": "Contact Name Type",
"identity": "pCHDCF"
} ]
}, {
"id": "Patient.contact.name.family",
"path": "Patient.contact.name.family",
"mapping": [ {
"map": "Contact Surname",
"identity": "pCHDCF"
} ]
}, {
"id": "Patient.contact.name.given",
"path": "Patient.contact.name.given",
"mapping": [ {
"map": "Contact Given Name",
"identity": "pCHDCF"
} ]
}, {
"id": "Patient.contact.telecom",
"path": "Patient.contact.telecom"
}, {
"id": "Patient.contact.telecom.system",
"path": "Patient.contact.telecom.system",
"mapping": [ {
"map": "Contact Telcom System",
"identity": "pCHDCF"
} ]
}, {
"id": "Patient.contact.telecom.value",
"path": "Patient.contact.telecom.value",
"mapping": [ {
"map": "Contact Telcom Value",
"identity": "pCHDCF"
} ]
}, {
"id": "Patient.contact.telecom.use",
"path": "Patient.contact.telecom.use",
"mapping": [ {
"map": "Contact Telcom Use",
"identity": "pCHDCF"
} ]
}, {
"id": "Patient.contact.telecom.rank",
"path": "Patient.contact.telecom.rank",
"mapping": [ {
"map": "Contact Telcom Rank",
"identity": "pCHDCF"
} ]
}, {
"id": "Patient.contact.telecom.period",
"path": "Patient.contact.telecom.period",
"mapping": [ {
"map": "Contact Telcom Period",
"identity": "pCHDCF"
} ]
}, {
"id": "Patient.contact.address.use",
"path": "Patient.contact.address.use",
"mapping": [ {
"map": "Contact Address Use",
"identity": "pCHDCF"
} ]
}, {
"id": "Patient.contact.address.type",
"path": "Patient.contact.address.type",
"mapping": [ {
"map": "Contact Address Type",
"identity": "pCHDCF"
} ]
}, {
"id": "Patient.contact.address.text",
"path": "Patient.contact.address.text",
"mapping": [ {
"map": "Contact Address*",
"comment": "*May be used to convey multiple pCHDCF address attributes (e.g., line, city, postal code) in a single string",
"identity": "pCHDCF"
} ]
}, {
"id": "Patient.contact.address.line",
"path": "Patient.contact.address.line",
"mapping": [ {
"map": "Contact Address Street",
"identity": "pCHDCF"
} ]
}, {
"id": "Patient.contact.address.city",
"path": "Patient.contact.address.city",
"mapping": [ {
"map": "Contact Address City",
"identity": "pCHDCF"
} ]
}, {
"id": "Patient.contact.address.state",
"path": "Patient.contact.address.state",
"mapping": [ {
"map": "Contact Address Province",
"identity": "pCHDCF"
} ]
}, {
"id": "Patient.contact.address.postalCode",
"path": "Patient.contact.address.postalCode",
"mapping": [ {
"map": "Contact Address Postal Code",
"identity": "pCHDCF"
} ]
}, {
"id": "Patient.contact.address.country",
"path": "Patient.contact.address.country",
"mapping": [ {
"map": "Contact Address Country",
"identity": "pCHDCF"
} ]
}, {
"id": "Patient.contact.address.period",
"path": "Patient.contact.address.period",
"mapping": [ {
"map": "Contact Address Period",
"identity": "pCHDCF"
} ]
}, {
"id": "Patient.contact.period",
"path": "Patient.contact.period",
"mapping": [ {
"map": "Contact Period",
"identity": "pCHDCF"
} ]
}, {
"id": "Patient.generalPractitioner",
"path": "Patient.generalPractitioner",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://fhir.infoway-inforoute.ca/ca-core/StructureDefinition/practitioner-ca-core", "http://fhir.infoway-inforoute.ca/ca-core/StructureDefinition/practitionerRole-ca-core", "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/Organization" ]
} ],
"mapping": [ {
"map": "*Most Responsible Provider Details",
"comment": "*Used to convey additional details about the Most Responsible Provider as indicated in the pCHDCF artefacts",
"identity": "pCHDCF"
} ]
} ]
},
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Patient"
}