Profiles & Transactions > Patient Profile

Structure Definition: Patient Profile

Canonical URL:http://ehealthontario.on.ca/fhir/StructureDefinition/ca-on-cms-profile-Patient

Simplifier project page: StructureDefinition: Patient

Derived from: Patient (R4)

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work

Differential View

profileS1..
data-absent-reasonSExtension(code)
systemS
valueS
textS
familyS
givenS
systemS1..
valueS1..
genderS1..
birthDateS1..
deceased[x]
useS
typeS
lineS
cityS
stateS
postalCodeS
countryS
photo
}

Hybrid View

profileS1..
data-absent-reasonSExtension(code)
systemS
valueS
textS
familyS
givenS
systemS1..
valueS1..
genderS1..
birthDateS1..
deceased[x]
useS
typeS
lineS
cityS
stateS
postalCodeS
countryS
photo

Snapshot View

profileS1..
data-absent-reasonSExtension(code)
systemS
valueS
textS
familyS
givenS
systemS1..
valueS1..
genderS1..
birthDateS1..
deceased[x]
useS
typeS
lineS
cityS
stateS
postalCodeS
countryS
photo

Table View

Patient..
Patient.meta1..
Patient.meta.profile1..
Patient.identifier1..
Patient.identifier.extension:data-absent-reasonExtension..
Patient.identifier.system..
Patient.identifier.value..
Patient.name1..
Patient.name.text..
Patient.name.family..
Patient.name.given..
Patient.telecom..
Patient.telecom.system1..
Patient.telecom.value1..
Patient.gender1..
Patient.birthDate1..
Patient.deceased[x]..
Patient.address..
Patient.address.use..
Patient.address.type..
Patient.address.line..
Patient.address.city..
Patient.address.state..
Patient.address.postalCode..
Patient.address.country..
Patient.photo..

JSON View

{
"resourceType": "StructureDefinition",
"text": {
"status": "empty",
--- We have skipped the narrative for better readability of the resource ---
},
"url": "http://ehealthontario.on.ca/fhir/StructureDefinition/ca-on-cms-profile-Patient",
"version": "1.0.0",
"name": "CMSPatient",
"status": "draft",
"description": "The elements marked as MustSupport ('S' in a red box) must be supported if the data is present in the sending system. Please <a href= \"https://www.hl7.org/fhir/conformance-rules.html#mustSupport\" target=\"blank\">click here </a> for the details.",
"fhirVersion": "4.0.1",
"kind": "resource",
"abstract": false,
"type": "Patient",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Patient",
"derivation": "constraint",
"differential": {
"element": [
{
"id": "Patient.meta",
"path": "Patient.meta",
"min": 1,
"mustSupport": true
},
{
"id": "Patient.meta.profile",
"path": "Patient.meta.profile",
"comment": "#### **_` FOR CMS USAGE: The meta.profile = http://ehealthontario.ca/fhir/StructureDefinition/ca-on-cms-profile-Patient|1.0.0 `_**\nIt is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.",
"min": 1,
"mustSupport": true
},
{
"id": "Patient.identifier",
"path": "Patient.identifier",
"comment": "#### **_`FOR CMS USAGE: For Patient.identifier, Ontario Health Card Number (HCN) and Medical Record Number (MRN) are supported. In case of Ontario HCN, the identifier.system = \"https://fhir.infoway-inforoute.ca/NamingSystem/ca-on-patient-hcn\". In case of MRN, identifier.system should be the corresponding MRN of the healthcare facility. CMS will reject the request upon receiving multiple Ontario HCNs.`_**",
"min": 1,
"mustSupport": true
},
{
"id": "Patient.identifier.extension:data-absent-reason",
"path": "Patient.identifier.extension",
"sliceName": "data-absent-reason",
"definition": "Provides a reason why the expected value or elements in the element that is extended are missing.",
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/StructureDefinition/data-absent-reason"
]
}
],
"mustSupport": true
},
{
"id": "Patient.identifier.system",
"path": "Patient.identifier.system",
"mustSupport": true
},
{
"id": "Patient.identifier.value",
"path": "Patient.identifier.value",
"mustSupport": true
},
{
"id": "Patient.name",
"path": "Patient.name",
"min": 1,
"constraint": [
{
"key": "ele-2",
"severity": "error",
"human": "SHALL atleast contain a family name or text",
"expression": "family.exist() or text.exist()"
}
],
"mustSupport": true
},
{
"id": "Patient.name.text",
"path": "Patient.name.text",
"mustSupport": true
},
{
"id": "Patient.name.family",
"path": "Patient.name.family",
"mustSupport": true
},
{
"id": "Patient.name.given",
"path": "Patient.name.given",
"definition": "#### **_` FOR CMS USAGE: It is recommended to provide Patient's First Name in the first instance and the Middle Name(s) in the subsequent instances. CMS doesn't impose any limitations on the number of repetitions but recommends to align with Provincial Client Registry. `_**",
"mustSupport": true
},
{
"id": "Patient.telecom",
"path": "Patient.telecom",
"mustSupport": true
},
{
"id": "Patient.telecom.system",
"path": "Patient.telecom.system",
"min": 1,
"mustSupport": true
},
{
"id": "Patient.telecom.value",
"path": "Patient.telecom.value",
"min": 1,
"mustSupport": true
},
{
"id": "Patient.gender",
"path": "Patient.gender",
"min": 1,
"mustSupport": true
},
{
"id": "Patient.birthDate",
"path": "Patient.birthDate",
"min": 1,
"mustSupport": true
},
{
"id": "Patient.deceased[x]",
"path": "Patient.deceased[x]",
"mustSupport": false
},
{
"id": "Patient.address",
"path": "Patient.address",
"mustSupport": true
},
{
"id": "Patient.address.use",
"path": "Patient.address.use",
"mustSupport": true
},
{
"id": "Patient.address.type",
"path": "Patient.address.type",
"mustSupport": true
},
{
"id": "Patient.address.line",
"path": "Patient.address.line",
"definition": "This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.\n\n#### **_` FOR CMS USAGE: It's recommended to have 4 lines and each line to have a limit of 80 characters. `_**",
"mustSupport": true
},
{
"id": "Patient.address.city",
"path": "Patient.address.city",
"mustSupport": true
},
{
"id": "Patient.address.state",
"path": "Patient.address.state",
"mustSupport": true
},
{
"id": "Patient.address.postalCode",
"path": "Patient.address.postalCode",
"mustSupport": true
},
{
"id": "Patient.address.country",
"path": "Patient.address.country",
"mustSupport": true
},
{
"id": "Patient.photo",
"path": "Patient.photo",
"definition": "Image of the patient.\n\n#### **_` FOR CMS USAGE: The default cardinality is retained for this element. However, the current CMS Specification doesn't support any use-case to support photos due to their size and storage restrictions. `_**"
}
]
}
}

Usage

The Patient Resource is used to share demographics and other administrative information about the individual who is the subject of the ereferral.

Notes

.id

  • used to uniquely identify the resource
  • if a persistent identity for the resource is not available to use when constructing a message Bundle for transmission via Direct Messaging, a UUID SHOULD be used in this element (with a corresponding value in Bundle.entry.fullUrl)

.meta.profile

  • used to declare conformance to this profile
  • populate with a fixed value: http://ehealthontario.ca/fhir/StructureDefinition/ca-on-eReferral-profile-Patient|1.0.1

.identifier

  • business identifier(s) for the patient, multiple allowed
  • Patient's Health Card Number (HCN) and Medical Record Number (MRN) are supported

.name

  • the name of the patient
  • .name.family SHALL always be populated
  • .name.given use multiple instances if patient has multiple given names (e.g. first and middle names)