{
"description": "Proposed constraints and extensions on the Patient Resource. This represents client information.",
"_filename": "StructureDefinition.ca-on-mha-profile-Patient.json",
"package_name": "ca.on.mha.pds",
"date": "2024-10-03T13:43:06.889914+00:00",
"derivation": "constraint",
"meta": {
"lastUpdated": "2025-11-20T21:22:25.5942418+00:00"
},
"publisher": "HL7 Canada",
"fhirVersion": "4.0.1",
"purpose": "The Patient Profile will serve to exchange client related data including but not limited to identifiers and demographics.",
"name": "Patient",
"mapping": [ {
"name": "MHA PDS Mapping",
"identity": "MHA-PDS-Mapping"
} ],
"abstract": false,
"type": "Patient",
"experimental": null,
"resourceType": "StructureDefinition",
"title": "MHA Patient Profile",
"package_version": "2.0.0-snapshot1",
"status": "active",
"id": "612e741a-0137-4118-9f16-0497fd26b80d",
"kind": "resource",
"url": "http://ontariohealth.ca/fhir/StructureDefinition/ca-on-mha-profile-Patient",
"version": "2.0.0",
"differential": {
"element": [ {
"id": "Patient",
"path": "Patient",
"short": "Patient Profile",
"definition": "The Patient Profile is based upon the core FHIR Patient Resource",
"isModifier": false,
"mustSupport": true
}, {
"id": "Patient.meta",
"path": "Patient.meta"
}, {
"id": "Patient.meta.profile",
"path": "Patient.meta.profile",
"fixedCanonical": "http://ontariohealth.ca/fhir/StructureDefinition/ca-on-mha-profile-patient"
}, {
"id": "Patient.identifier",
"min": 1,
"path": "Patient.identifier",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "type",
"type": "pattern"
} ]
},
"mustSupport": true
}, {
"id": "Patient.identifier.type",
"min": 1,
"path": "Patient.identifier.type",
"binding": {
"strength": "required",
"valueSet": "http://ontariohealth.ca/fhir/ValueSet/client-identifier-type-code"
},
"mapping": [ {
"map": "Identifier Type",
"identity": "MHA-PDS-Mapping"
} ]
}, {
"id": "Patient.identifier.system",
"path": "Patient.identifier.system",
"isModifier": false
}, {
"id": "Patient.identifier.value",
"path": "Patient.identifier.value",
"short": "The value that is unique within the system.",
"isModifier": false
}, {
"id": "Patient.identifier:MRN",
"max": "1",
"min": 1,
"path": "Patient.identifier",
"sliceName": "MRN",
"mustSupport": true
}, {
"id": "Patient.identifier:MRN.type",
"path": "Patient.identifier.type",
"binding": {
"strength": "required",
"valueSet": "http://ontariohealth.ca/fhir/ValueSet/client-identifier-type-code"
},
"mustSupport": true,
"patternCodeableConcept": {
"coding": [ {
"code": "MR",
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"display": "Medical record number"
} ]
}
}, {
"id": "Patient.identifier:MRN.system",
"min": 1,
"path": "Patient.identifier.system",
"binding": {
"strength": "required",
"valueSet": "http://ontariohealth.ca/fhir/ValueSet/mha/patient-mrn-identifier-system",
"description": "MHA Patient MRN system URI values"
},
"mustSupport": true
}, {
"id": "Patient.identifier:MRN.value",
"min": 1,
"path": "Patient.identifier.value",
"mustSupport": true
}, {
"id": "Patient.identifier:JHN",
"max": "1",
"min": 1,
"path": "Patient.identifier",
"sliceName": "JHN",
"mustSupport": true
}, {
"id": "Patient.identifier:JHN.extension:mHADataAbsentReason",
"max": "1",
"path": "Patient.identifier.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://ontariohealth.ca/fhir/StructureDefinition/ext-ca-on-mha-data-absent-reason" ]
} ],
"sliceName": "mHADataAbsentReason",
"isModifier": false,
"mustSupport": true
}, {
"id": "Patient.identifier:JHN.type",
"min": 1,
"path": "Patient.identifier.type",
"binding": {
"strength": "required",
"valueSet": "http://ontariohealth.ca/fhir/ValueSet/client-identifier-type-code"
},
"mustSupport": true,
"patternCodeableConcept": {
"coding": [ {
"code": "JHN",
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"display": "Jurisdictional health number"
} ]
}
}, {
"id": "Patient.identifier:JHN.system",
"path": "Patient.identifier.system",
"binding": {
"strength": "required",
"valueSet": "http://ontariohealth.ca/fhir/ValueSet/mha/patient-jhn-identifier-system"
},
"mustSupport": true
}, {
"id": "Patient.identifier:JHN.value",
"path": "Patient.identifier.value",
"mustSupport": true
}, {
"id": "Patient.identifier:Anonymous",
"path": "Patient.identifier",
"sliceName": "Anonymous",
"mustSupport": true
}, {
"id": "Patient.identifier:Anonymous.type",
"min": 1,
"path": "Patient.identifier.type",
"binding": {
"strength": "required"
},
"mustSupport": true,
"patternCodeableConcept": {
"coding": [ {
"code": "ANON",
"system": "http://terminology.hl7.org/CodeSystem/v2-0203"
} ]
}
}, {
"id": "Patient.identifier:Anonymous.system",
"min": 1,
"path": "Patient.identifier.system",
"mustSupport": true
}, {
"id": "Patient.identifier:Anonymous.value",
"min": 1,
"path": "Patient.identifier.value",
"mustSupport": true
}, {
"id": "Patient.active",
"path": "Patient.active",
"definition": "Only use this field to mark a patient record is inactive.",
"mustSupport": true
}, {
"id": "Patient.name",
"max": "1",
"min": 1,
"path": "Patient.name",
"short": "A name associated with the patient(client)",
"constraint": [ {
"key": "ca-baseline-name",
"human": "Patient.name.given or Patient.name.family or both SHALL be present",
"xpath": "f:given or f:family",
"source": "http://hl7.org/fhir/ca/baseline/StructureDefinition/profile-patient",
"severity": "error",
"expression": "family.exists() or given.exists()"
} ],
"mustSupport": true
}, {
"id": "Patient.name.family",
"min": 1,
"path": "Patient.name.family",
"mapping": [ {
"map": "Client Last Name",
"identity": "MHA-PDS-Mapping"
} ],
"mustSupport": true
}, {
"id": "Patient.name.given",
"max": "2",
"min": 1,
"path": "Patient.name.given",
"mapping": [ {
"map": "Client First Name, Client Middle Name",
"identity": "MHA-PDS-Mapping"
} ],
"definition": "The first or given name of the client. If middle name is available, it should be provided as the second value.",
"mustSupport": true
}, {
"id": "Patient.birthDate",
"min": 1,
"path": "Patient.birthDate",
"comment": "At least an estimated year should be provided as a guess if the real DOB is unknown",
"mapping": [ {
"map": "Date of Birth",
"identity": "MHA-PDS-Mapping"
} ],
"constraint": [ {
"key": "bd-1",
"human": "birthDate must have a date value",
"severity": "error",
"expression": "hasValue() = true"
}, {
"key": "bd-2",
"human": "If birthDate is \"1900-01-01\", BirthDate estimated flag must be set to 'true'",
"severity": "error",
"expression": "$this = @1900-01-01 implies $this.extension.value = true"
}, {
"key": "bd-3",
"human": "BirthDate must not be before '1900-01-01' or after the current date and it must be a valid date",
"severity": "error",
"expression": "$this >= @1900-01-01 and $this < today()"
} ],
"mustSupport": true,
"requirements": "• Used to calculate the age of the person and which age group the person belongs to.\r\n• Used to categorize data for reporting."
}, {
"id": "Patient.birthDate.extension:BirthDateEstimatedFlag",
"max": "1",
"path": "Patient.birthDate.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://ontariohealth.ca/fhir/StructureDefinition/ca-on-ext-birthdate-estimated-flag" ]
} ],
"sliceName": "BirthDateEstimatedFlag",
"mustSupport": true
}, {
"id": "Patient.address",
"path": "Patient.address",
"constraint": [ {
"key": "adr-key-1",
"human": "Province must be provided if 'address use' is provided",
"severity": "error",
"expression": "use.exists() implies state.exists()"
} ],
"mustSupport": true
}, {
"id": "Patient.address.use",
"path": "Patient.address.use",
"mapping": [ {
"map": "Address Use",
"identity": "MHA-PDS-Mapping"
} ]
}, {
"id": "Patient.address.line",
"path": "Patient.address.line",
"mapping": [ {
"map": "Address Line 1",
"identity": "MHA-PDS-Mapping"
} ]
}, {
"id": "Patient.address.city",
"path": "Patient.address.city",
"mapping": [ {
"map": "City",
"identity": "MHA-PDS-Mapping"
} ],
"mustSupport": true
}, {
"id": "Patient.address.state",
"path": "Patient.address.state",
"binding": {
"strength": "required",
"valueSet": "https://fhir.infoway-inforoute.ca/ValueSet/canadianjurisdiction",
"description": "Codes to identify the provinces and territories of Canada"
},
"mapping": [ {
"map": "Province",
"identity": "MHA-PDS-Mapping"
} ],
"mustSupport": true
}, {
"id": "Patient.address.postalCode",
"min": 1,
"path": "Patient.address.postalCode",
"mapping": [ {
"map": "Postal Code",
"identity": "MHA-PDS-Mapping"
} ],
"mustSupport": true
}, {
"id": "Patient.address.postalCode.extension:mHADataAbsentReason",
"max": "1",
"path": "Patient.address.postalCode.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://ontariohealth.ca/fhir/StructureDefinition/ext-ca-on-mha-data-absent-reason" ]
} ],
"sliceName": "mHADataAbsentReason",
"isModifier": false,
"mustSupport": true
}, {
"id": "Patient.communication",
"path": "Patient.communication",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "extension.value.coding.code",
"type": "value"
} ]
},
"mustSupport": true
}, {
"id": "Patient.communication.extension",
"min": 1,
"path": "Patient.communication.extension"
}, {
"id": "Patient.communication.extension:languageUse",
"min": 1,
"path": "Patient.communication.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://ontariohealth.ca/fhir/StructureDefinition/ca-on-mha-ext-LanguageUse" ]
} ],
"sliceName": "languageUse"
}, {
"id": "Patient.communication.language",
"path": "Patient.communication.language",
"mapping": [ {
"map": "Preferred Language",
"identity": "MHA-PDS-Mapping"
} ]
}, {
"id": "Patient.communication.language.coding.system",
"min": 1,
"path": "Patient.communication.language.coding.system"
}, {
"id": "Patient.communication.language.coding.code",
"min": 1,
"path": "Patient.communication.language.coding.code",
"mustSupport": true
}, {
"id": "Patient.communication.language.coding.display",
"min": 1,
"path": "Patient.communication.language.coding.display",
"mustSupport": true
}, {
"id": "Patient.communication:languageOfComfort",
"max": "1",
"path": "Patient.communication",
"sliceName": "languageOfComfort",
"mustSupport": true
}, {
"id": "Patient.communication:languageOfComfort.extension",
"min": 1,
"path": "Patient.communication.extension"
}, {
"id": "Patient.communication:languageOfComfort.extension:languageUse",
"min": 1,
"path": "Patient.communication.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://ontariohealth.ca/fhir/StructureDefinition/ca-on-mha-ext-LanguageUse" ]
} ],
"sliceName": "languageUse"
}, {
"id": "Patient.communication:languageOfComfort.extension:languageUse.value[x]",
"min": 1,
"path": "Patient.communication.extension.value[x]"
}, {
"id": "Patient.communication:languageOfComfort.language",
"path": "Patient.communication.language",
"binding": {
"strength": "required",
"valueSet": "http://ontariohealth.ca/fhir/ValueSet/human-language",
"description": "Official languages of Canada."
},
"mustSupport": true
}, {
"id": "Patient.communication:languageOfComfort.language.coding",
"max": "1",
"min": 1,
"path": "Patient.communication.language.coding",
"mustSupport": true
}, {
"id": "Patient.communication:languageOfComfort.language.coding.system",
"min": 1,
"path": "Patient.communication.language.coding.system",
"mustSupport": true
}, {
"id": "Patient.communication:languageOfComfort.language.coding.code",
"min": 1,
"path": "Patient.communication.language.coding.code",
"mustSupport": true
}, {
"id": "Patient.communication:languageOfComfort.language.coding.display",
"min": 1,
"path": "Patient.communication.language.coding.display",
"mustSupport": true
}, {
"id": "Patient.communication:officialLanguage",
"max": "1",
"path": "Patient.communication",
"sliceName": "officialLanguage",
"mustSupport": true
}, {
"id": "Patient.communication:officialLanguage.extension",
"min": 1,
"path": "Patient.communication.extension"
}, {
"id": "Patient.communication:officialLanguage.extension:languageUse",
"min": 1,
"path": "Patient.communication.extension",
"type": [ {
"code": "Extension",
"profile": [ "http://ontariohealth.ca/fhir/StructureDefinition/ca-on-mha-ext-LanguageUse" ]
} ],
"sliceName": "languageUse"
}, {
"id": "Patient.communication:officialLanguage.extension:languageUse.value[x]",
"min": 1,
"path": "Patient.communication.extension.value[x]",
"label": "ServiceLanguage"
}, {
"id": "Patient.communication:officialLanguage.language",
"path": "Patient.communication.language",
"binding": {
"strength": "required",
"valueSet": "http://ontariohealth.ca/fhir/ValueSet/official-language",
"description": "Languages understood or supported by Ontario clients and organizations."
},
"mustSupport": true
}, {
"id": "Patient.communication:officialLanguage.language.coding",
"max": "1",
"min": 1,
"path": "Patient.communication.language.coding",
"mustSupport": true
}, {
"id": "Patient.communication:officialLanguage.language.coding.system",
"min": 1,
"path": "Patient.communication.language.coding.system",
"mustSupport": true
}, {
"id": "Patient.communication:officialLanguage.language.coding.code",
"min": 1,
"path": "Patient.communication.language.coding.code",
"mustSupport": true
}, {
"id": "Patient.communication:officialLanguage.language.coding.display",
"min": 1,
"path": "Patient.communication.language.coding.display",
"mustSupport": true
} ]
},
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Patient"
}