Canadian Baseline
1.2.0 - CI Build
Canadian Baseline, published by HL7 Canada - FHIR Implementation Work Group. This guide is not an authorized publication; it is the continuous build for version 1.2.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7-Canada/ca-baseline/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/ca/baseline/StructureDefinition/profile-patient | Version: 1.2.0 | |||
Draft as of 2024-12-27 | Computable Name: PatientProfile |
Proposed constraints and extensions on the Patient Resource as scoped to human patients
This profile is seeking community and implementer feedback on whether further relaxation of the 1..1 cardinality is needed on the Patient.identifier.type & .system & .value elements.
Due Diligence Reviews identified the above elements as 1..1 cardinality but not in the equivalent eReferral Specification profile. This variance is believed to be due to the eReferral Specification profile not necessarily expecting a Patient to always have a health card (or at minimum a health card number). General consensus from Due Diligence Review is that the cardinalities should not be relaxed in the CA Baseline. Feedback can be provided through the Simplifier issue log for this profile.
Feedback can be provided through the Simplifier issue log for this profile.
</div>
This Patient profile sets minimum expectations for the Patient resource to record, search and fetch demographics and other administrative information about an individual receiving care or other health-related services.
Since not all concepts are included within the base FHIR Patient resource, this profile defines localization concepts for use in an Canadian context.
All elements or attributes defined in FHIR have cardinality as part of their definition - a minimum number of required appearances and a maximum number.
Most elements in FHIR specification have a minimum cardinality of 0, which means that they may be missing from a resource when it is exchanged between systems.
In this Canadian Baseline Patient Profile all elements are optional, i.e., there is no element with a minimum cardinality of 1. However, some optional elements (e.g., identifier) have required components that MUST be present if that optional element is provided.
In situations where the minimum cardinality of an element or attribute is 1 and information is missing and the Responder knows the precise reason for the absence of data, Responders SHALL send the reason for the missing information using values (such as NullFlavor) from the value set where they exist or using the DataAbsentReason extension.
Some elements are labeled as MustSupport meaning that implementations that produce or consume resources SHALL provide "support" for the element in some meaningful way (see Must Support definition).
Following elements are marked as Must Support in the Canadian Patient profile to aid record matching in databases with many pediatric records.
Must Support elements:
Some of the typical use cases where the Patient profile may be used:
This profile includes an invariant that enforces that a family.name, given.name, or both be present. This is intended to enforce minimum constraints while allowing for cases where the patient may only have one name.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Other representations of profile: CSV, Excel, Schematron
Multiple individual healthcare identifiers may be provided in Patient.identifier element.
However, to support particular types of federal patient and person health numbers used by all jurisdictions across Canada following optional types are defined to uniquely identifying patients:
A unique number assigned to the document affirming that a person is a citizen of Canada.
URI to use with this identifier type: https://fhir.infoway-inforoute.ca/NamingSystem/ca-passport-number
Example:
{
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "PPN"
}
]
},
"system": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-passport-number",
"value": "AB123456",
"period": {
"start": "2005-05-11",
"end": "2015-05-11"
}
}
This patient identifier type identifies a number issued in Canada to administer various government programs.
URIs used with this identifier type:
Example:
{
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "JPID"
}
]
},
"system": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-social-insurance-number",
"value": "923456789"
}
}
Following URIs are registered to identify health card numbers for provinces and territories:
Following identifier types identify health card numbers issued in Canada to let a patient to be recognized for services and stay connected to related support programs:
The full list of identifiers can be found on Canadian URI Registry. Canada Health Infoway provides Canadian URI Registry search tool to simplify search.
Version Code
The Version Code extension is added to indicate the currency/validity of an identifier.
The rational is that the version code is current captured separately from the JHN because, in Ontario at least, the JHN is a stable identifier whereas the version code changes over time.
Example:
{
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "JHN"
}
]
},
"system": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-armed-forces-health-id",
"value": "A98765439"
}
}
Many systems and organizations only provide a single attribute to represent all aspects of a patient's gender and sex with a single value. However, there are many considerations around sex and gender documentation and interoperability.
The FHIR Specification provides guidance and background for representing patient gender.
In addition to that Canadian Patient profile defines following extensions:
!! TO BE COMPLETED !!
A Patient may have multiple ways to be contacted with different uses or applicable periods. This Patient profile allows multiple contact points (e.g. a telephone number or an email address) by which the individual may be contacted.
To indicate the preferred way to contact use Patient.telecom.rank attribute (i.e., the ContactPoint.rank component) that specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.
The Patient profile is provided for use in a Canadian context where some constraint on content is desirable to guarantee the quality of the Canadian address whilst still supporting other type of address (e.g., other countries or UNstructured addresses).
If an address in the Patient resource instance represents Canadian address, it SHOULD follow Canadian postal code format.
The Canadian Postal Code SHOULD be a six-character uniformly structured uppercase alphanumeric code in the form of "ANA NAN", where "A" represents an alphabetic character and "N" represents a numeric character, with one space between the first three and the last three characters.
A hyphen SHOULD NOT be used (example of UNacceptable format: T0L-1K0).
The Patient.address MAY have a Preferred extension. This is the FHIR standard defined extension used as a flag denoting whether parent address item is preferred.
The Patient.address MAY have a No Fixed Address extension. This extension is to indicate that there is an assertion that there is no fixed address (e.g., homeless).
The binding for the Patient.maritalStatus element is extensible meaning that to be conformant, codes in this element SHALL be from the specified value set if any of the codes within the value set can apply to the concept being communicated.
Systems can send additional codes (Stats Canada, SNOMED CT, etc.) but can only do that if they also send the relevant HL7-assigned codes.