FHIR IG analytics
| Package | ca.on.oh.setp.iar.dev |
| Resource Type | StructureDefinition |
| Id | patient-ca-core.json |
| FHIR Version | R4 |
| Source | https://simplifier.net/resolve?scope=ca.on.oh.setp.iar.dev@1.0.0-ballot1-dev&canonical=http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/patient-ca-core |
| URL | http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/patient-ca-core |
| Version | 1.0.0 |
| Status | draft |
| Date | 2025-03-17 |
| Name | PatientCACore |
| Title | Patient (CA-Core) |
| Realm | ca |
| Authority | hl7 |
| Description | This profile applies constraints to the Patient resource for CA Core+ to support identity, demographics, and administrative data in the pan-Canadian context. |
| Copyright | Copyright © 2025+ 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 |
| Kind | resource |
Resources that use this resource
Resources that this resource uses
Narrative
No narrative content found in resource
Source1
{
"resourceType": "StructureDefinition",
"id": "patient-ca-core",
"url": "http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/patient-ca-core",
"version": "1.0.0",
"name": "PatientCACore",
"title": "Patient (CA-Core)",
"status": "draft",
"experimental": false,
"date": "2025-03-17",
"publisher": "Canada Health Infoway",
"contact": [
{
"name": "National Standards Release Centre",
"telecom": [
{
"system": "url",
"value": "http://www.infoway-inforoute.ca"
},
{
"system": "email",
"value": "standards@infoway-inforoute.ca"
}
]
}
],
"description": "This profile applies constraints to the Patient resource for CA Core+ to support identity, demographics, and administrative data in the pan-Canadian context.",
"jurisdiction": [
{
"coding": [
{
"system": "urn:iso:std:iso:3166",
"code": "CA"
}
]
}
],
"copyright": "Copyright © 2025+ 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).",
"fhirVersion": "4.0.1",
"mapping": [
{
"identity": "pCHDCF-CACDI",
"name": "Pan-Canadian Health Data Content Framework - CACDI"
}
],
"kind": "resource",
"abstract": false,
"type": "Patient",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Patient",
"derivation": "constraint",
"differential": {
"element": [
{
"id": "Patient",
"path": "Patient",
"mapping": [
{
"identity": "pCHDCF-CACDI",
"map": "Patient"
},
{
"identity": "pCHDCF-CACDI",
"map": "Person*",
"comment": "*In the context of a person in a Party Role of Patient"
}
]
},
{
"id": "Patient.extension",
"path": "Patient.extension",
"slicing": {
"ordered": false,
"rules": "open"
}
},
{
"id": "Patient.extension:indigenousIdentity",
"path": "Patient.extension",
"sliceName": "indigenousIdentity",
"short": "Extension for representing a code classifying a person's indigenous identity.",
"definition": "A code classifying a person's self-identification as either First Nations, Inuk/Inuit and/or Métis.",
"comment": "This element is included in the CACDI. In future versions additional constraints or obligations may be applied to this element.",
"type": [
{
"code": "Extension",
"profile": [
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/indigenous-identity-ca-core"
]
}
],
"mapping": [
{
"identity": "pCHDCF-CACDI",
"map": "Person Indigenous Identity"
}
]
},
{
"id": "Patient.extension:indigenousIdentity.url",
"path": "Patient.extension.url",
"fixedUri": "http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/indigenous-identity-ca-core"
},
{
"id": "Patient.extension:racializedGroup",
"path": "Patient.extension",
"sliceName": "racializedGroup",
"short": "Extension for representing a code classifying a person's racialized group.",
"definition": "A code that identifies a social construct most often characterized by phenotype or appearance (e.g. skin colour) in which the client identifies.",
"comment": "This element is included in the CACDI. In future versions additional constraints or obligations may be applied to this element.",
"type": [
{
"code": "Extension",
"profile": [
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/racialized-group-ca-core"
]
}
],
"mapping": [
{
"identity": "pCHDCF-CACDI",
"map": "Person Racialized Group"
}
]
},
{
"id": "Patient.extension:racializedGroup.url",
"path": "Patient.extension.url",
"fixedUri": "http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/racialized-group-ca-core"
},
{
"id": "Patient.extension:recordedSexOrGender",
"path": "Patient.extension",
"sliceName": "recordedSexOrGender",
"short": "Recorded sex or gender (RSG) information includes the various sex and gender concepts.",
"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.",
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender"
]
}
]
},
{
"id": "Patient.extension:recordedSexOrGender.extension:value",
"path": "Patient.extension.extension",
"sliceName": "value"
},
{
"id": "Patient.extension:recordedSexOrGender.extension:value.url",
"path": "Patient.extension.extension.url",
"fixedUri": "value"
},
{
"id": "Patient.extension:recordedSexOrGender.extension:value.value[x]",
"path": "Patient.extension.extension.value[x]",
"binding": {
"strength": "extensible",
"valueSet": "https://fhir.infoway-inforoute.ca/ValueSet/recordedgender"
}
},
{
"id": "Patient.extension:recordedSexOrGender.extension:type",
"path": "Patient.extension.extension",
"sliceName": "type"
},
{
"id": "Patient.extension:recordedSexOrGender.extension:type.url",
"path": "Patient.extension.extension.url",
"fixedUri": "type"
},
{
"id": "Patient.extension:recordedSexOrGender.extension:type.value[x]",
"path": "Patient.extension.extension.value[x]",
"binding": {
"strength": "required",
"valueSet": "https://fhir.infoway-inforoute.ca/ValueSet/recordedgendertype"
}
},
{
"id": "Patient.extension:recordedSexOrGender.url",
"path": "Patient.extension.url",
"fixedUri": "http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender"
},
{
"id": "Patient.extension:genderIdentity",
"path": "Patient.extension",
"sliceName": "genderIdentity",
"short": "Extension for representing how the person prefers to self-describe.",
"definition": "A code that specifies an individual's personal experience of being a woman, man, nonbinary, or how the person prefers to self-describe. People may identify with more than one gender identity or use different gender identities in different settings.",
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/StructureDefinition/individual-genderIdentity"
]
}
],
"mapping": [
{
"identity": "pCHDCF-CACDI",
"map": "Person Gender Identity"
}
]
},
{
"id": "Patient.extension:genderIdentity.extension:value",
"path": "Patient.extension.extension",
"sliceName": "value"
},
{
"id": "Patient.extension:genderIdentity.extension:value.url",
"path": "Patient.extension.extension.url",
"fixedUri": "value"
},
{
"id": "Patient.extension:genderIdentity.extension:value.value[x]",
"path": "Patient.extension.extension.value[x]",
"binding": {
"strength": "extensible",
"valueSet": "https://fhir.infoway-inforoute.ca/ValueSet/genderidentityvaluecode"
}
},
{
"id": "Patient.extension:genderIdentity.url",
"path": "Patient.extension.url",
"fixedUri": "http://hl7.org/fhir/StructureDefinition/individual-genderIdentity"
},
{
"id": "Patient.extension:pronouns",
"path": "Patient.extension",
"sliceName": "pronouns",
"short": "Third-person pronouns that may reference a person's gender identity (e.g. he, she, they)",
"definition": "A linguistic tool used to refer to people instead of using their name, a noun, or a noun phrase. Gender pronouns are third-person pronouns that may reference a person's gender identity (e.g. he, she, they) and that may be a part of their gender expression.",
"type": [
{
"code": "Extension",
"profile": [
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/individual-pronouns-ca-core"
]
}
]
},
{
"id": "Patient.extension:pronouns.url",
"path": "Patient.extension.url",
"fixedUri": "http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/individual-pronouns-ca-core"
},
{
"id": "Patient.extension:birthsex",
"path": "Patient.extension",
"sliceName": "birthsex",
"short": "A code that specifies the sex of a person at birth which is a clinical finding",
"definition": "A code that specifies the sex of a person at birth which is a clinical finding, usually determined by a clinician based on phenotypic (e.g. genitals or gonads), physiologic (e.g. hormone levels) and/or genetic characteristics.",
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-patientbirthsex"
]
}
]
},
{
"id": "Patient.extension:birthsex.url",
"path": "Patient.extension.url",
"fixedUri": "http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-patientbirthsex"
},
{
"id": "Patient.extension:CommunicationBarrier",
"path": "Patient.extension",
"sliceName": "CommunicationBarrier",
"type": [
{
"code": "Extension",
"profile": [
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/ext-communicationbarrier"
]
}
]
},
{
"id": "Patient.extension:CommunicationBarrier.url",
"path": "Patient.extension.url",
"fixedUri": "http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/ext-communicationbarrier"
},
{
"id": "Patient.identifier",
"path": "Patient.identifier",
"slicing": {
"discriminator": [
{
"type": "pattern",
"path": "type"
}
],
"ordered": false,
"rules": "open"
},
"requirements": "Patients are generally assigned specific alphanumeric identifiers.",
"mustSupport": true,
"mapping": [
{
"identity": "pCHDCF-CACDI",
"map": "Patient Health Identifier"
},
{
"identity": "pCHDCF-CACDI",
"map": "Party Non-Health Identifier"
}
]
},
{
"id": "Patient.identifier.type",
"path": "Patient.identifier.type",
"min": 1,
"example": [
{
"label": "Jurisdictional Health Number",
"valueCodeableConcept": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "JHN"
}
]
}
},
{
"label": "Medical Record Number",
"valueCodeableConcept": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "MR"
}
]
}
},
{
"label": "Passport Number",
"valueCodeableConcept": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "PPN"
}
]
}
},
{
"label": "National Unique Identifier (Placeholder Concept)",
"valueCodeableConcept": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "NH"
}
]
}
}
],
"mustSupport": true,
"binding": {
"strength": "extensible",
"valueSet": "http://ontariohealth.ca/fhir/ehr/ValueSet/identifier-type"
},
"mapping": [
{
"identity": "pCHDCF-CACDI",
"map": "Patient Health Identifier Type Code"
},
{
"identity": "pCHDCF-CACDI",
"map": "Party Non-Health Identifier Type Code"
}
]
},
{
"id": "Patient.identifier.system",
"path": "Patient.identifier.system",
"min": 1,
"mustSupport": true,
"mapping": [
{
"identity": "pCHDCF-CACDI",
"map": "Patient Health Identifier System"
},
{
"identity": "pCHDCF-CACDI",
"map": "*Issued By",
"comment": "*Many FHIR implementers omit the assigner element if the identifier.system is uniquely tied to a single assigning organization/program. Identifiers that can not be uniquely identified against an assigner using system are expected to convey assigner in identifier.assigner"
}
]
},
{
"id": "Patient.identifier.value",
"path": "Patient.identifier.value",
"min": 1,
"mustSupport": true,
"mapping": [
{
"identity": "pCHDCF-CACDI",
"map": "Patient Health Identifier"
},
{
"identity": "pCHDCF-CACDI",
"map": "Party Non-Health Identifier"
}
]
},
{
"id": "Patient.identifier.period.start",
"path": "Patient.identifier.period.start",
"comment": "This attribute is considered 'Recommended - No Absent' in the current version of CACDI. No obligations have been applied at this time to recommended elements, however implementers are encouraged to support the element. Implementers that support this element should sent it if available and receivers should not produce failures or rejections if this element is provided (a base tenet of FHIR).",
"mapping": [
{
"identity": "pCHDCF-CACDI",
"map": "Patient Health Identifier Effective Date"
}
]
},
{
"id": "Patient.identifier.period.end",
"path": "Patient.identifier.period.end",
"comment": "This attribute is considered 'Recommended - Allow Absent' in the current version of CACDI. No obligations have been applied at this time to recommended elements, however implementers are encouraged to support the element. Implementers that support this element should sent it if available and receivers should not produce failures or rejections if this element is provided (a base tenet of FHIR).",
"mapping": [
{
"identity": "pCHDCF-CACDI",
"map": "Patient Health Identifier Expiry Date"
}
]
},
{
"id": "Patient.identifier.assigner",
"path": "Patient.identifier.assigner",
"mapping": [
{
"identity": "pCHDCF-CACDI",
"map": "Issued By",
"comment": "Many FHIR implementers omit the assigner element if the identifier.system is uniquely tied to a single assigning organization/program. Identifiers that can not be uniquely identified against an assigner using system are expected to convey assigner in identifier.assigner"
}
]
},
{
"id": "Patient.identifier:JHN",
"path": "Patient.identifier",
"sliceName": "JHN",
"short": "Jurisdictional Health Number",
"definition": "Patient and person health numbers used by all jurisdictions across Canada"
},
{
"id": "Patient.identifier:JHN.extension:versionCode",
"path": "Patient.identifier.extension",
"sliceName": "versionCode",
"short": "Health Number Version Code",
"max": "1",
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-identifierversion"
]
}
]
},
{
"id": "Patient.identifier:JHN.extension:versionCode.url",
"path": "Patient.identifier.extension.url",
"fixedUri": "http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-identifierversion"
},
{
"id": "Patient.identifier:JHN.type",
"path": "Patient.identifier.type",
"min": 1,
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/identifier-type"
},
"patternCodeableConcept": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "JHN",
"display": "Jurisdictional Health Number"
}
]
},
"mustSupport": true
},
{
"id": "Patient.identifier:JHN.system",
"path": "Patient.identifier.system",
"short": "A Health Number Naming System from the Canadian URI Registry",
"min": 1,
"mustSupport": true
},
{
"id": "Patient.identifier:JHN.value",
"path": "Patient.identifier.value",
"min": 1,
"mustSupport": true
},
{
"id": "Patient.identifier:MRN",
"path": "Patient.identifier",
"sliceName": "MRN",
"short": "Medical Record Number",
"definition": "A local patient identifier from the submitting PoS System",
"comment": "Some jurisdictions may consider the MRN identifier type to be an alternative to the JHN identifier type under certain scenarios. These business rules are outside the scope of this profile, however the slice is socialized to prepare implementers for potential use of this pattern within certain jurisdictions"
},
{
"id": "Patient.identifier:MRN.type",
"path": "Patient.identifier.type",
"min": 1,
"patternCodeableConcept": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "MR",
"display": "Medical Record Number"
}
]
},
"mustSupport": true
},
{
"id": "Patient.identifier:MRN.system",
"path": "Patient.identifier.system",
"short": "An identifier for the system supplying the MRN",
"min": 1,
"mustSupport": true
},
{
"id": "Patient.identifier:MRN.value",
"path": "Patient.identifier.value",
"min": 1,
"mustSupport": true
},
{
"id": "Patient.active",
"path": "Patient.active",
"comment": "it is strongly recommended to populate the active element, as it is a modifier element which changes the context of the resource. It is very valuable to include, especially for its search capabilities, e.g. searching for only active patients"
},
{
"id": "Patient.name",
"path": "Patient.name",
"requirements": "Need to be able to track the patient by multiple names. Examples are your official name and a partner name.\nThe Alphabetic representation of the name SHALL be always provided",
"min": 1,
"constraint": [
{
"key": "ca-core-pat-1",
"severity": "error",
"human": "Either Patient.name.given and/or Patient.name.family SHALL be present.",
"expression": "(family.exists() or given.exists())",
"xpath": "(/f:name/f:family or /f:name/f:given)"
}
],
"mustSupport": true,
"mapping": [
{
"identity": "pCHDCF-CACDI",
"map": "Person Name"
}
]
},
{
"id": "Patient.name.use",
"path": "Patient.name.use",
"mapping": [
{
"identity": "pCHDCF-CACDI",
"map": "Person Name Type Code"
}
]
},
{
"id": "Patient.name.text",
"path": "Patient.name.text",
"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",
"comment": "Some systems will not have a field for representing the full name as a string, these systems are still expected to be able to demonstrate they can construct name.text when developing the patient summary instance"
},
{
"id": "Patient.name.family",
"path": "Patient.name.family",
"mustSupport": true,
"mapping": [
{
"identity": "pCHDCF-CACDI",
"map": "Surname"
}
]
},
{
"id": "Patient.name.given",
"path": "Patient.name.given",
"orderMeaning": "Patient.name.given[0] is expected to be the first name in a sequence. Patient.name.given[i], where i>0, is expected to express a Patient's middle name(s)",
"mustSupport": true,
"mapping": [
{
"identity": "pCHDCF-CACDI",
"map": "Given Name"
},
{
"identity": "pCHDCF-CACDI",
"map": "Middle Name"
}
]
},
{
"id": "Patient.name.period.start",
"path": "Patient.name.period.start",
"comment": "This attribute is considered 'Recommended - No Absent' in the current version of CACDI. No obligations have been applied at this time to recommended elements, however implementers are encouraged to support the element. Implementers that support this element should sent it if available and receivers should not produce failures or rejections if this element is provided (a base tenet of FHIR).",
"mapping": [
{
"identity": "pCHDCF-CACDI",
"map": "Person Name Effective Date"
}
]
},
{
"id": "Patient.name.period.end",
"path": "Patient.name.period.end",
"comment": "This attribute is considered 'Recommended - Allow Absent' in the current version of CACDI. No obligations have been applied at this time to recommended elements, however implementers are encouraged to support the element. Implementers that support this element should sent it if available and receivers should not produce failures or rejections if this element is provided (a base tenet of FHIR).",
"mustSupport": true,
"mapping": [
{
"identity": "pCHDCF-CACDI",
"map": "Person Name Expiry Date"
}
]
},
{
"id": "Patient.telecom",
"path": "Patient.telecom",
"mustSupport": true,
"mapping": [
{
"identity": "pCHDCF-CACDI",
"map": "Contact Mechanism"
}
]
},
{
"id": "Patient.telecom.system",
"path": "Patient.telecom.system",
"mustSupport": true
},
{
"id": "Patient.telecom.value",
"path": "Patient.telecom.value",
"min": 1,
"mustSupport": true
},
{
"id": "Patient.telecom.use",
"path": "Patient.telecom.use",
"mustSupport": true
},
{
"id": "Patient.telecom.period.end",
"path": "Patient.telecom.period.end",
"mustSupport": true
},
{
"id": "Patient.gender",
"path": "Patient.gender",
"short": "The documented sex or gender of an individual used for clinical, official, or legal purposes where only one data field for sex and gender is available, and where it is the value found in the local system and/or historical documentation.",
"definition": "The documented sex or gender of an individual used for clinical, official, or legal purposes where only one data field for sex and gender is available, and where it is the value found in the local system and/or historical documentation.",
"mustSupport": true,
"mapping": [
{
"identity": "pCHDCF-CACDI",
"map": "Person Gender Used"
}
]
},
{
"id": "Patient.birthDate",
"path": "Patient.birthDate",
"comment": "This element is included in the CACDI. In future versions additional constraints or obligations may be applied to this element.",
"mapping": [
{
"identity": "pCHDCF-CACDI",
"map": "Person Birth Date"
}
]
},
{
"id": "Patient.birthDate.extension",
"path": "Patient.birthDate.extension",
"slicing": {
"ordered": false,
"rules": "open"
}
},
{
"id": "Patient.birthDate.extension:birthTime",
"path": "Patient.birthDate.extension",
"sliceName": "birthTime",
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/StructureDefinition/patient-birthTime"
]
}
]
},
{
"id": "Patient.deceased[x]",
"path": "Patient.deceased[x]",
"mapping": [
{
"identity": "pCHDCF-CACDI",
"map": "Person Death"
}
]
},
{
"id": "Patient.address",
"path": "Patient.address",
"type": [
{
"code": "Address",
"profile": [
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/address-ca-core"
]
}
],
"mustSupport": true
},
{
"id": "Patient.address.line",
"path": "Patient.address.line",
"mustSupport": true
},
{
"id": "Patient.address.city",
"path": "Patient.address.city",
"mustSupport": true
},
{
"id": "Patient.address.postalCode",
"path": "Patient.address.postalCode",
"mustSupport": true
},
{
"id": "Patient.address.country",
"path": "Patient.address.country",
"mustSupport": true
},
{
"id": "Patient.communication",
"path": "Patient.communication",
"comment": "This element is included in the CACDI. In future versions additional constraints or obligations may be applied to this element.",
"mapping": [
{
"identity": "pCHDCF-CACDI",
"map": "Party Service Language"
}
]
},
{
"id": "Patient.communication.language",
"path": "Patient.communication.language",
"binding": {
"strength": "preferred",
"valueSet": "http://fhir.infoway-inforoute.ca/cacore/ValueSet/ISO6393"
}
},
{
"id": "Patient.communication.language.coding.code",
"path": "Patient.communication.language.coding.code",
"mapping": [
{
"identity": "pCHDCF-CACDI",
"map": "Party Service Language Code"
}
]
},
{
"id": "Patient.generalPractitioner",
"path": "Patient.generalPractitioner",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/practitioner-ca-core",
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/practitionerRole-ca-core",
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/organization-ca-core"
]
}
],
"mustSupport": true
},
{
"id": "Patient.managingOrganization",
"path": "Patient.managingOrganization",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/organization-ca-core"
]
}
]
}
]
}
}