{
"description": "This profile represents the constraints applied to the Patient resource by the CA Core+t 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 v1.1.0](http://build.fhir.org/ig/HL7-Canada/ca-baseline/branches/master/StructureDefinition-profile-patient.html)",
"_filename": "structuredefinition-profile-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 © 2021,2022,2023 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.1.0-DFT-Ballot",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "code",
"valueCode": "can-send"
}, {
"url": "elementId",
"valueString": "text"
}, {
"url": "elementId",
"valueString": "identifier"
}, {
"url": "elementId",
"valueString": "identifier:MRN"
}, {
"url": "elementId",
"valueString": "name"
}, {
"url": "elementId",
"valueString": "name.text"
}, {
"url": "elementId",
"valueString": "name.family"
}, {
"url": "elementId",
"valueString": "name.given"
}, {
"url": "elementId",
"valueString": "name:previous"
}, {
"url": "elementId",
"valueString": "telecom"
}, {
"url": "elementId",
"valueString": "telecom:Phone"
}, {
"url": "elementId",
"valueString": "telecom:Email"
}, {
"url": "elementId",
"valueString": "birthDate"
}, {
"url": "elementId",
"valueString": "deceasedDateTime"
}, {
"url": "elementId",
"valueString": "address"
}, {
"url": "elementId",
"valueString": "address:Home"
}, {
"url": "elementId",
"valueString": "contact:Emergency"
}, {
"url": "elementId",
"valueString": "generalPractitioner"
}, {
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/server"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "code",
"valueCode": "no-error"
}, {
"url": "elementId",
"valueString": "text"
}, {
"url": "elementId",
"valueString": "identifier"
}, {
"url": "elementId",
"valueString": "identifier:MRN"
}, {
"url": "elementId",
"valueString": "name"
}, {
"url": "elementId",
"valueString": "name.text"
}, {
"url": "elementId",
"valueString": "name.family"
}, {
"url": "elementId",
"valueString": "name.given"
}, {
"url": "elementId",
"valueString": "name:previous"
}, {
"url": "elementId",
"valueString": "telecom"
}, {
"url": "elementId",
"valueString": "telecom:Phone"
}, {
"url": "elementId",
"valueString": "telecom:Email"
}, {
"url": "elementId",
"valueString": "birthDate"
}, {
"url": "elementId",
"valueString": "deceasedDateTime"
}, {
"url": "elementId",
"valueString": "address"
}, {
"url": "elementId",
"valueString": "address:Home"
}, {
"url": "elementId",
"valueString": "contact:Emergency"
}, {
"url": "elementId",
"valueString": "generalPractitioner"
}, {
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/client"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-imposeProfile",
"valueCanonical": "http://hl7.org/fhir/ca/baseline/StructureDefinition/profile-patient"
} ],
"status": "draft",
"id": "2691b651-1ca7-45cd-bdec-ba1fde4f2ee5",
"kind": "resource",
"url": "http://fhir.infoway-inforoute.ca/ca-core/StructureDefinition/patient-ca-core",
"version": null,
"differential": {
"element": [ {
"id": "Patient.text",
"path": "Patient.text"
}, {
"id": "Patient.extension:individual-pronouns",
"path": "Patient.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/StructureDefinition/individual-pronouns" ]
} ],
"short": "Extension for representing the pronouns to use when referring to an individual in verbal or written communication.",
"sliceName": "individual-pronouns",
"definition": "The pronouns to use when referring to an individual in verbal or written communication."
}, {
"id": "Patient.identifier",
"path": "Patient.identifier",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "type",
"type": "pattern"
} ]
}
}, {
"id": "Patient.identifier.type",
"path": "Patient.identifier.type",
"comment": "The slices provided below are examples of identifier types used by jurisdictions. These are not required, and the slicing is open meaning that other types can be provided and used in an implementation."
}, {
"id": "Patient.identifier.system",
"min": 1,
"path": "Patient.identifier.system"
}, {
"id": "Patient.identifier.value",
"min": 1,
"path": "Patient.identifier.value"
}, {
"id": "Patient.identifier:NH",
"path": "Patient.identifier",
"short": "National Unique Health Identifier Placeholder",
"mapping": [ {
"map": "National Unique Health Identifier",
"identity": "pCHDCF"
} ],
"sliceName": "NH",
"definition": "A national unique health identification number (to be developed)."
}, {
"id": "Patient.identifier:NH.type.coding.code",
"path": "Patient.identifier.type.coding.code",
"fixedCode": "NH"
}, {
"id": "Patient.identifier:JHN",
"path": "Patient.identifier",
"short": "Jurisdictional Health Number",
"mapping": [ {
"map": "Jurisdictional Health Care Number",
"identity": "pCHDCF"
} ],
"sliceName": "JHN",
"definition": "Federal patient and person health numbers used by all jurisdictions across Canada"
}, {
"id": "Patient.identifier:JHN.type",
"min": 1,
"path": "Patient.identifier.type",
"fixedCodeableConcept": {
"coding": [ {
"code": "JHN",
"system": "http://terminology.hl7.org/CodeSystem/v2-0203"
} ]
}
}, {
"id": "Patient.identifier:MRN",
"path": "Patient.identifier",
"short": "Medical Record Number",
"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",
"mapping": [ {
"map": "Medical Record Number",
"identity": "pCHDCF"
} ],
"sliceName": "MRN",
"definition": "A local patient identifier from the submitting PoS System"
}, {
"id": "Patient.identifier:MRN.type",
"min": 1,
"path": "Patient.identifier.type",
"fixedCodeableConcept": {
"coding": [ {
"code": "MR",
"system": "http://terminology.hl7.org/CodeSystem/v2-0203"
} ]
}
}, {
"id": "Patient.name",
"path": "Patient.name",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "use",
"type": "pattern"
} ]
},
"constraint": [ {
"key": "cacore-pat-1",
"human": "Patient.name.given and Patient.name.family or Patient.name.text SHOULD be present",
"xpath": "f:given and f:family or f:text",
"severity": "warning",
"expression": "family.exists() and given.exists() or text.exists()"
} ]
}, {
"id": "Patient.name.extension:effectivePeriod",
"path": "Patient.name.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod" ]
} ],
"short": "Extension for representing the period during which the resource content was or is planned to be effective.",
"sliceName": "effectivePeriod",
"definition": "The period during which the resource content was or is planned to be effective."
}, {
"id": "Patient.name.text",
"path": "Patient.name.text",
"mapping": [ {
"map": "Name*",
"comment": "*May be used to convey multiple pCHDCF name attributes (e.g., first name, last name) in a single string",
"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": "Last Name",
"identity": "pCHDCF"
} ]
}, {
"id": "Patient.name.given",
"path": "Patient.name.given",
"mapping": [ {
"map": "First Name",
"identity": "pCHDCF"
}, {
"map": "Middle Name",
"identity": "pCHDCF"
} ]
}, {
"id": "Patient.name:previous",
"path": "Patient.name",
"sliceName": "previous"
}, {
"id": "Patient.name:previous.use",
"path": "Patient.name.use",
"mapping": [ {
"map": "Previous First Name",
"identity": "pCHDCF"
}, {
"map": "Previous Last Name",
"identity": "pCHDCF"
} ],
"fixedCode": "old"
}, {
"id": "Patient.telecom",
"path": "Patient.telecom",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "system",
"type": "pattern"
} ]
}
}, {
"id": "Patient.telecom.extension:preferred",
"path": "Patient.telecom.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://hl7.org/fhir/StructureDefinition/iso21090-preferred" ]
} ],
"short": "Flag for denoting whether parent item is preferred - e.g., a preferred address or telephone number.",
"sliceName": "preferred",
"definition": "Extension for denoting whether parent item is preferred - e.g., a preferred address or telephone number."
}, {
"id": "Patient.telecom:Phone",
"path": "Patient.telecom",
"sliceName": "Phone"
}, {
"id": "Patient.telecom:Phone.system",
"path": "Patient.telecom.system",
"mapping": [ {
"map": "Primary Phone Number",
"comment": "The preferred extension is used to differentiate between the primary phone number and any alternate phone numbers",
"identity": "pCHDCF"
}, {
"map": "Alternate Phone Number",
"identity": "pCHDCF"
} ],
"fixedCode": "phone"
}, {
"id": "Patient.telecom:Email",
"path": "Patient.telecom",
"sliceName": "Email"
}, {
"id": "Patient.telecom:Email.system",
"path": "Patient.telecom.system",
"mapping": [ {
"map": "Email address",
"identity": "pCHDCF"
} ],
"fixedCode": "email"
}, {
"id": "Patient.birthDate",
"path": "Patient.birthDate",
"mapping": [ {
"map": "Birth Date",
"identity": "pCHDCF"
} ]
}, {
"id": "Patient.deceased[x]",
"path": "Patient.deceased[x]",
"type": [ {
"code": "dateTime",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "code",
"valueCode": "can-send"
}, {
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/server"
} ]
}, {
"url": "http://hl7.org/fhir/StructureDefinition/obligation",
"extension": [ {
"url": "code",
"valueCode": "no-error"
}, {
"url": "actor",
"valueCanonical": "http://fhir.infoway-inforoute.ca/ca-core/ActorDefinition/client"
} ]
} ]
}, {
"code": "boolean"
} ],
"mapping": [ {
"map": "Deceased Date",
"identity": "pCHDCF"
} ]
}, {
"id": "Patient.address",
"path": "Patient.address",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "use",
"type": "value"
} ]
}
}, {
"id": "Patient.address:Home",
"path": "Patient.address",
"comment": "This slice is included to ensure at least one address corresponds to a Home Address",
"mapping": [ {
"map": "Home*",
"comment": "*Used to convey that the address is a Home address which is indicated in the pCHDCF artefacts",
"identity": "pCHDCF"
} ],
"sliceName": "Home"
}, {
"id": "Patient.address:Home.use",
"path": "Patient.address.use",
"mapping": [ {
"map": "Home*",
"comment": "*Used to convey that the address is a Home address which is indicated in the pCHDCF artefacts",
"identity": "pCHDCF"
} ],
"fixedCode": "home"
}, {
"id": "Patient.address:Home.text",
"path": "Patient.address.text",
"mapping": [ {
"map": "Home 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:Home.line",
"path": "Patient.address.line",
"mapping": [ {
"map": "Home Address Street",
"identity": "pCHDCF"
} ]
}, {
"id": "Patient.address:Home.city",
"path": "Patient.address.city",
"mapping": [ {
"map": "Home Address City",
"identity": "pCHDCF"
} ]
}, {
"id": "Patient.address:Home.state",
"path": "Patient.address.state",
"mapping": [ {
"map": "Home Address Province",
"identity": "pCHDCF"
} ]
}, {
"id": "Patient.address:Home.postalCode",
"path": "Patient.address.postalCode",
"mapping": [ {
"map": "Home Address Postal Code",
"identity": "pCHDCF"
} ]
}, {
"id": "Patient.address:Home.country",
"path": "Patient.address.country",
"comment": "This element is included for socialization purposes",
"mapping": [ {
"map": "Home Address Country",
"identity": "pCHDCF"
} ]
}, {
"id": "Patient.contact",
"path": "Patient.contact",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "relationship",
"type": "pattern"
} ]
}
}, {
"id": "Patient.contact:Emergency",
"path": "Patient.contact",
"sliceName": "Emergency"
}, {
"id": "Patient.contact:Emergency.relationship",
"path": "Patient.contact.relationship",
"comment": "Used to convey that the contact is for Emergency purposes as indicated in the pCHDCF artefacts as well as to convey additional information about the relationship that is relevant to that person's role as an emergency contact (e.g., friend, mother, father). The relatedPerson resource should be used for conveying details on patient's relationships outside the context of Emergency Contact.",
"mapping": [ {
"map": "Emergency Contact Relationship",
"identity": "pCHDCF"
} ]
}, {
"id": "Patient.contact:Emergency.name",
"path": "Patient.contact.name",
"comment": "This element is included for socialization purposes"
}, {
"id": "Patient.contact:Emergency.name.text",
"path": "Patient.contact.name.text",
"comment": "This element is included for socialization purposes",
"mapping": [ {
"map": "Emergency Contact Name*",
"comment": "*May be used to convey multiple attributes related to Emergency Contact Name in the pCHDCF artefacts",
"identity": "pCHDCF"
} ]
}, {
"id": "Patient.contact:Emergency.name.family",
"path": "Patient.contact.name.family",
"comment": "This element is included for socialization purposes",
"mapping": [ {
"map": "Emergency Contact Last Name",
"identity": "pCHDCF"
} ]
}, {
"id": "Patient.contact:Emergency.name.given",
"path": "Patient.contact.name.given",
"comment": "This element is included for socialization purposes",
"mapping": [ {
"map": "Emergency Contact First Name",
"identity": "pCHDCF"
} ]
}, {
"id": "Patient.contact:Emergency.telecom",
"path": "Patient.contact.telecom",
"comment": "This element is included for socialization purposes"
}, {
"id": "Patient.contact:Emergency.telecom.system",
"path": "Patient.contact.telecom.system",
"mapping": [ {
"map": "Contact Type*",
"comment": "*Used to convey that the contact method is for telephone or an email which is indicated in the pCHDCF artefacts",
"identity": "pCHDCF"
} ]
}, {
"id": "Patient.contact:Emergency.telecom.value",
"path": "Patient.contact.telecom.value",
"mapping": [ {
"map": "Emergency Contact Phone Number",
"identity": "pCHDCF"
}, {
"map": "Emergency Contact Email Address",
"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" ]
} ],
"comment": "This element is included for socialization purposes",
"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"
}