FHIR Artifacts > Structure Definition: Patient Profile

Structure Definition: Patient Profile

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

Simplifier project page: Patient

Derived from: Patient (CA:eReC)

Base FHIR: Patient (R4)

Formal Views of Profile Content

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

Differential View

profileS1..
id..0
version..0
userSelected..0
HealthCardNumberVersionCode..0
systemSFixed Value
codeS
displayS
versionCodeExtension(string)
system
code
display
textS
useS
prefixS..1
suffixS..1
gender1..
useS
typeS
lineS
cityS
stateS
system1..
code1..
display1..
text
system
code
display
address
gender
organization
systemS1..Fixed Value
codeS1..Binding
displayS1..
generalPractitionerReference(EReferralPractitionerRole)

Hybrid View

profileS1..
id..0
version..0
userSelected..0
HealthCardNumberVersionCode..0
systemSFixed Value
codeS
displayS
versionCodeExtension(string)
system
code
display
textS
useS
prefixS..1
suffixS..1
gender1..
useS
typeS
lineS
cityS
stateS
system1..
code1..
display1..
text
system
code
display
address
gender
organization
systemS1..Fixed Value
codeS1..Binding
displayS1..
generalPractitionerReference(EReferralPractitionerRole)

Snapshot View

profileS1..
id..0
version..0
userSelected..0
HealthCardNumberVersionCode..0
systemSFixed Value
codeS
displayS
versionCodeExtension(string)
system
code
display
textS
useS
prefixS..1
suffixS..1
gender1..
useS
typeS
lineS
cityS
stateS
system1..
code1..
display1..
text
system
code
display
address
gender
organization
systemS1..Fixed Value
codeS1..Binding
displayS1..
generalPractitionerReference(EReferralPractitionerRole)

Table View

Patient..
Patient.meta1..
Patient.meta.profile1..
Patient.meta.security..
Patient.meta.security.id..0
Patient.meta.security.version..0
Patient.meta.security.userSelected..0
Patient.identifier..
Patient.identifier.extension:HealthCardNumberVersionCode..0
Patient.identifier.extension:ReasonForNoHCN..1
Patient.identifier.extension:ReasonForNoHCN.value[x]..
Patient.identifier.extension:ReasonForNoHCN.value[x].coding..
Patient.identifier.extension:ReasonForNoHCN.value[x].coding.system..
Patient.identifier.extension:ReasonForNoHCN.value[x].coding.code..
Patient.identifier.extension:ReasonForNoHCN.value[x].coding.display..
Patient.identifier.extension:versionCodeExtension..
Patient.identifier.type..
Patient.identifier.type.coding..
Patient.identifier.type.coding.system..
Patient.identifier.type.coding.code..
Patient.identifier.type.coding.display..
Patient.identifier.type.text..
Patient.name..
Patient.name.use..
Patient.name.prefix..1
Patient.name.suffix..1
Patient.gender1..
Patient.address..
Patient.address.use..
Patient.address.type..
Patient.address.line..
Patient.address.city..
Patient.address.state..
Patient.maritalStatus..
Patient.maritalStatus.coding..
Patient.maritalStatus.coding.system1..
Patient.maritalStatus.coding.code1..
Patient.maritalStatus.coding.display1..
Patient.maritalStatus.text..
Patient.contact..
Patient.contact.relationship..
Patient.contact.relationship.coding..
Patient.contact.relationship.coding.system..
Patient.contact.relationship.coding.code..
Patient.contact.relationship.coding.display..
Patient.contact.address..
Patient.contact.gender..
Patient.contact.organization..
Patient.communication..
Patient.communication.language..
Patient.communication.language.coding1..1
Patient.communication.language.coding.system1..
Patient.communication.language.coding.code1..
Patient.communication.language.coding.display1..
Patient.generalPractitionerReference(EReferralPractitionerRole)..

JSON View

{
"resourceType": "StructureDefinition",
"id": "ca-on-eReferral-profile-Patient",
"url": "http://ehealthontario.ca/fhir/StructureDefinition/ca-on-eReferral-profile-Patient",
"version": "1.1.0",
"name": "EReferralPatient",
"title": "Patient",
"status": "draft",
"description": "The Patient resources contain demographics and other administrative information about the individual who is the subject of the referral.",
"fhirVersion": "4.0.1",
"kind": "resource",
"abstract": false,
"type": "Patient",
"baseDefinition": "http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-Patient",
"derivation": "constraint",
"element": [
{
"id": "Patient.meta",
"path": "Patient.meta",
"min": 1,
"mustSupport": true
},
{
"id": "Patient.meta.profile",
"path": "Patient.meta.profile",
"comment": "#### **_` FOR eREFERRAL USAGE: The meta.profile = http://ehealthontario.ca/fhir/StructureDefinition/ca-on-eReferral-profile-Patient|1.1.0 `_**\n\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.meta.security",
"path": "Patient.meta.security"
},
{
"id": "Patient.meta.security.id",
"path": "Patient.meta.security.id",
"max": "0"
},
{
"id": "Patient.meta.security.version",
"path": "Patient.meta.security.version",
"max": "0"
},
{
"id": "Patient.meta.security.userSelected",
"path": "Patient.meta.security.userSelected",
"max": "0"
},
{
"id": "Patient.identifier",
"path": "Patient.identifier",
"comment": "Include patient health card number. May also include HCN version code extension."
},
{
"id": "Patient.identifier.extension:HealthCardNumberVersionCode",
"path": "Patient.identifier.extension",
"sliceName": "HealthCardNumberVersionCode",
"max": "0"
},
{
"id": "Patient.identifier.extension:ReasonForNoHCN",
"path": "Patient.identifier.extension",
"sliceName": "ReasonForNoHCN",
"max": "1",
"mustSupport": true
},
{
"id": "Patient.identifier.extension:ReasonForNoHCN.value[x]",
"path": "Patient.identifier.extension.value[x]",
"mustSupport": true
},
{
"id": "Patient.identifier.extension:ReasonForNoHCN.value[x].coding",
"path": "Patient.identifier.extension.value[x].coding",
"mustSupport": true
},
{
"id": "Patient.identifier.extension:ReasonForNoHCN.value[x].coding.system",
"path": "Patient.identifier.extension.value[x].coding.system",
"fixedUri": "http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-reason-for-no-HCN-EXT",
"mustSupport": true
},
{
"id": "Patient.identifier.extension:ReasonForNoHCN.value[x].coding.code",
"path": "Patient.identifier.extension.value[x].coding.code",
"mustSupport": true
},
{
"id": "Patient.identifier.extension:ReasonForNoHCN.value[x].coding.display",
"path": "Patient.identifier.extension.value[x].coding.display",
"mustSupport": true
},
{
"id": "Patient.identifier.extension:versionCode",
"path": "Patient.identifier.extension",
"sliceName": "versionCode",
"type": [
{
"code": "Extension",
"profile": [
"http://fhir.infoway-inforoute.ca/io/CA-eReC/StructureDefinition/CA-eReC-HCNV-code-EXT"
]
}
],
"isModifier": false
},
{
"id": "Patient.identifier.type",
"path": "Patient.identifier.type",
"mustSupport": false
},
{
"id": "Patient.identifier.type.coding",
"path": "Patient.identifier.type.coding",
"mustSupport": false
},
{
"id": "Patient.identifier.type.coding.system",
"path": "Patient.identifier.type.coding.system",
"mustSupport": false
},
{
"id": "Patient.identifier.type.coding.code",
"path": "Patient.identifier.type.coding.code",
"mustSupport": false
},
{
"id": "Patient.identifier.type.coding.display",
"path": "Patient.identifier.type.coding.display",
"mustSupport": false
},
{
"id": "Patient.identifier.type.text",
"path": "Patient.identifier.type.text",
"mustSupport": true
},
{
"id": "Patient.name",
"path": "Patient.name",
"comment": "name.family and name.given will only be used. \nMiddle name is supported by using subsequent given names."
},
{
"id": "Patient.name.use",
"path": "Patient.name.use",
"mustSupport": true
},
{
"id": "Patient.name.prefix",
"path": "Patient.name.prefix",
"max": "1",
"mustSupport": true
},
{
"id": "Patient.name.suffix",
"path": "Patient.name.suffix",
"max": "1",
"mustSupport": true
},
{
"id": "Patient.gender",
"path": "Patient.gender",
"min": 1
},
{
"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",
"mustSupport": true
},
{
"id": "Patient.address.city",
"path": "Patient.address.city",
"mustSupport": true
},
{
"id": "Patient.address.state",
"path": "Patient.address.state",
"mustSupport": true
},
{
"id": "Patient.maritalStatus",
"path": "Patient.maritalStatus",
"mustSupport": false
},
{
"id": "Patient.maritalStatus.coding",
"path": "Patient.maritalStatus.coding",
"mustSupport": false
},
{
"id": "Patient.maritalStatus.coding.system",
"path": "Patient.maritalStatus.coding.system",
"min": 1,
"mustSupport": false
},
{
"id": "Patient.maritalStatus.coding.code",
"path": "Patient.maritalStatus.coding.code",
"min": 1,
"mustSupport": false
},
{
"id": "Patient.maritalStatus.coding.display",
"path": "Patient.maritalStatus.coding.display",
"min": 1,
"mustSupport": false
},
{
"id": "Patient.maritalStatus.text",
"path": "Patient.maritalStatus.text",
"mustSupport": false
},
{
"id": "Patient.contact",
"path": "Patient.contact",
"mustSupport": false
},
{
"id": "Patient.contact.relationship.coding",
"path": "Patient.contact.relationship.coding",
"mustSupport": false
},
{
"id": "Patient.contact.relationship.coding.system",
"path": "Patient.contact.relationship.coding.system",
"mustSupport": false
},
{
"id": "Patient.contact.relationship.coding.code",
"path": "Patient.contact.relationship.coding.code",
"mustSupport": false
},
{
"id": "Patient.contact.relationship.coding.display",
"path": "Patient.contact.relationship.coding.display",
"mustSupport": false
},
{
"id": "Patient.contact.address",
"path": "Patient.contact.address",
"mustSupport": false
},
{
"id": "Patient.contact.gender",
"path": "Patient.contact.gender",
"mustSupport": false
},
{
"id": "Patient.contact.organization",
"path": "Patient.contact.organization",
"mustSupport": false
},
{
"id": "Patient.communication",
"path": "Patient.communication",
"mustSupport": false
},
{
"id": "Patient.communication.language",
"path": "Patient.communication.language",
"binding": {
"strength": "preferred",
"valueSet": "http://ehealthontario.ca/fhir/ValueSet/human-language"
}
},
{
"id": "Patient.communication.language.coding",
"path": "Patient.communication.language.coding",
"min": 1,
"max": "1",
"mustSupport": false,
"binding": {
"strength": "preferred",
"valueSet": "http://ehealthontario.ca/fhir/ValueSet/human-language"
}
},
{
"id": "Patient.communication.language.coding.system",
"path": "Patient.communication.language.coding.system",
"min": 1,
"fixedUri": "urn:ietf:bcp:47",
"mustSupport": true
},
{
"id": "Patient.communication.language.coding.code",
"path": "Patient.communication.language.coding.code",
"min": 1,
"mustSupport": true,
"binding": {
"strength": "preferred",
"valueSet": "http://ehealthontario.ca/fhir/ValueSet/human-language"
}
},
{
"id": "Patient.communication.language.coding.display",
"path": "Patient.communication.language.coding.display",
"min": 1,
"mustSupport": true
},
{
"id": "Patient.generalPractitioner",
"path": "Patient.generalPractitioner",
"type": [
{
"code": "Reference",
"http://ehealthontario.ca/fhir/StructureDefinition/ca-on-eReferral-profile-PractitionerRole"
],
"referenced"
]
}
],
"mustSupport": false
}
]
}
}

STABILITY RISK: This profile is undergoing Ontario Health harmonization and may be adjusted as part of this process (e.g., adjustments to Must Support obligations).

Usage

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

In an implementation environment where client registry integration is not present, patient demographic information SHOULD be included as part of a referral

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.1.0

.identifier

  • business identifier(s) for the patient, multiple allowed
  • SHALL include patient health card number identifiers or reason if an HCN is not provided (see: ReasonForNoHCN)
    • SHOULD also include an HCN version code (see: versionCode). HCN version code SHALL be included for eConsult
  • MAY include other business identifiers

.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)

.contact

  • used to identify alternate contacts for the patient
  • when used, .contact.relationship.coding SHOULD be populated with a code and display name from PatientContactRelationship

.generalPractitioner

  • identifies the patients primary care provider / family doctor
  • SHALL be populated with a reference to a PractitionerRole resource
  • if the information is being transmitted via messaging, the referenced resource SHALL be included in the message as a Bundle.entry