Patient Profile¶
| Canonical | ../StructureDefinition/nexus-emr-core-patient |
|---|---|
| Status | draft · 1.26.0 |
| Base | Patient (constraint) |
| Source | FSH · JSON |
Generic Nexus EMR core profile for patient demographic and administrative information, based on CA Core+. Designed to support a broad range of integration needs.
Elements / Snapshot
The full effective definition: base Patient with this profile's constraints applied.
| Element | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Patient | 0..* | Nexus EMR Patient Core Invariants: dom-2, dom-3, dom-4, dom-5, dom-6, patient-name-family-or-given, patient-indigenous-identity-absence-exclusive, patient-indigenous-identity-instances-clean, patient-racialized-group-absence-exclusive, patient-racialized-group-instances-clean, patient-indian-registration-number-format |
||
| id | S | 0..1 | http://hl7.org/fhirpath/System.String | Logical id of this artifact i |
| meta | 0..1 | Meta | Metadata about the resource Invariants: ele-1 |
|
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| versionId | 0..1 | id | Version specific identifier i Invariants: ele-1 |
|
| lastUpdated | 0..1 | instant | When the resource version last changed i Invariants: ele-1 |
|
| source | S | 0..1 | uri | Identifies EMR instance & pipeline version the resource came from i Invariants: ele-1 |
| profile | 0..* | canonical | Profiles this resource claims to conform to i Invariants: ele-1 |
|
| security | 0..* | Coding | Security Labels applied to this resource i Binding: security-labels ( extensible)Invariants: ele-1 |
|
| tag | 0..* | Coding | Tags applied to this resource i Binding: common-tags ( example)Invariants: ele-1 |
|
| implicitRules | ?! | 0..1 | uri | A set of rules under which this content was created i Invariants: ele-1 |
| language | 0..1 | code | Language of the resource content i Binding: languages ( preferred)Invariants: ele-1 |
|
| text | 0..1 | Narrative | Narrative i Invariants: ele-1 |
|
| contained | 0..* | Resource | Contained, inline Resources i | |
| extension | 0..* | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| extension:genderIdentity | S | 0..1 | Extension(individual-genderIdentity) | Gender identity (distinct from administrative gender) i Invariants: ele-1, ext-1 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 1..* | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| extension:value | 1..1 | Extension | The individual's gender identity i Invariants: ele-1, ext-1 |
|
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..0 | Extension | Extension Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| url | 1..1 | uri | identifies the meaning of the extension i Fixed: value |
|
| value[x] | 1..1 | CodeableConcept | Value of extension Binding: Gender Identity Value Set ( required)e.g. 446141000124107 · 446151000124109 · 33791000087105 …Invariants: ele-1 |
|
| extension:period | 0..1 | Extension | The time period during which the gender identity applies to the individual Invariants: ele-1, ext-1 |
|
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..0 | Extension | Extension Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| url | 1..1 | uri | identifies the meaning of the extension i Fixed: period |
|
| value[x] | 1..1 | Period | Value of extension Invariants: ele-1 |
|
| extension:comment | 0..1 | Extension | Text to further explain the use of the specified gender identity Invariants: ele-1, ext-1 |
|
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..0 | Extension | Extension Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| url | 1..1 | uri | identifies the meaning of the extension i Fixed: comment |
|
| value[x] | 1..1 | string | Value of extension Invariants: ele-1 |
|
| url | 1..1 | http://hl7.org/fhirpath/System.String | identifies the meaning of the extension i Fixed: http://hl7.org/fhir/StructureDefinition/individual-genderIdentity |
|
| value[x] | 0..0 | base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | Value of extension Invariants: ele-1 |
|
| extension:pronouns | S | 0..* | Extension(individual-pronouns) | Personal pronouns i Invariants: ele-1, ext-1 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 1..* | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| extension:value | 1..1 | Extension | The individual's pronouns Invariants: ele-1, ext-1 |
|
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..0 | Extension | Extension Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| url | 1..1 | uri | identifies the meaning of the extension i Fixed: value |
|
| value[x] | 1..1 | CodeableConcept | Value of extension Binding: Personal Pronouns Value Set ( extensible)e.g. LA29519-8 · LA29518-0 · LA29520-6Invariants: ele-1 |
|
| extension:period | 0..1 | Extension | When the pronouns apply to the individual Invariants: ele-1, ext-1 |
|
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..0 | Extension | Extension Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| url | 1..1 | uri | identifies the meaning of the extension i Fixed: period |
|
| value[x] | 1..1 | Period | Value of extension Invariants: ele-1 |
|
| extension:comment | 0..1 | Extension | Explaination about the use of the pronouns Invariants: ele-1, ext-1 |
|
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..0 | Extension | Extension Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| url | 1..1 | uri | identifies the meaning of the extension i Fixed: comment |
|
| value[x] | 1..1 | string | Value of extension Invariants: ele-1 |
|
| url | 1..1 | http://hl7.org/fhirpath/System.String | identifies the meaning of the extension i Fixed: http://hl7.org/fhir/StructureDefinition/individual-pronouns |
|
| value[x] | 0..0 | base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | Value of extension Invariants: ele-1 |
|
| extension:birthSex | S | 0..1 | Extension(ext-patientbirthsex) | Sex assigned at birth (CA Baseline) i Invariants: ele-1, ext-1 |
| extension:recordInactiveReason | 0..1 | Extension(Patient Record Inactive Reason Extension) | Why a heritage patient record is inactive i Invariants: ele-1, ext-1 |
|
| extension:indigenousIdentity | S | 0..* | Extension(patient-indigenousIdentity) | The Indigenous identity a patient self-identifies with i Invariants: ele-1, ext-1 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..0 | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| url | 1..1 | http://hl7.org/fhirpath/System.String | identifies the meaning of the extension i Fixed: http://fhir.infoway-inforoute.ca/ca-ext/StructureDefinition/patient-indigenousIdentity |
|
| value[x] | 0..1 | CodeableConcept | Value of extension Binding: Indigenous Identity Value Set ( extensible)e.g. 29921000087109 · 29931000087106 · 29941000087100 …Invariants: ele-1 |
|
| extension:racializedGroup | S | 0..* | Extension(patient-racializedGroup) | The racialized group a patient self-identifies with i Invariants: ele-1, ext-1 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..0 | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| url | 1..1 | http://hl7.org/fhirpath/System.String | identifies the meaning of the extension i Fixed: http://fhir.infoway-inforoute.ca/ca-ext/StructureDefinition/patient-racializedGroup |
|
| value[x] | 0..1 | CodeableConcept | Value of extension Binding: Racialized Group Value Set ( extensible)e.g. 413464008 · 26621000087107 · 26631000087109 …Invariants: ele-1 |
|
| extension:indianActRegistrationStatus | 0..1 | Extension(Indian Act Registration Status Extension) | Indian Act registration status, as stated i Invariants: ele-1, ext-1 |
|
| extension:firstNationRegistryGroup | 0..1 | Extension(First Nation Registry Group Extension) | Registry group (band) the registration is held under i Invariants: ele-1, ext-1 |
|
| extension:firstNationCommunity | 0..1 | Extension(First Nation Community Extension) | First Nation community the patient affiliates with i Invariants: ele-1, ext-1 |
|
| extension:interpreterRequired | S | 0..1 | Extension(patient-interpreterRequired) | Whether this patient needs an interpreter i Invariants: ele-1, ext-1 |
| extension:primaryCareAttachment | S | 0..1 | Extension(Primary Care Attachment) | Current primary-care roster/enrollment/attachment i Invariants: ele-1, ext-1 |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored i Invariants: ele-1, ext-1 |
| identifier | S | 0..* | Identifier | Patient identifiers (Nexus EMR ID recommended) Slicing: pattern:type (open) Invariants: ele-1 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| extension:reasonForNoHCN | S | 0..1 | Extension(CA-eReC-reason-for-no-HCN-EXT) | Why the patient has no health card number (Ontario CA-eReC extension) i Invariants: ele-1, ext-1 |
| use | ?! | 0..1 | code | usual | official | temp | secondary | old (If known) i Binding: identifier-use ( required)Invariants: ele-1 |
| type | 0..1 | CodeableConcept | Description of identifier i Binding: identifier-type ( extensible)Invariants: ele-1 |
|
| system | 1..1 | uri | The namespace for the identifier value i Invariants: ele-1 |
|
| value | 1..1 | string | The value that is unique i Invariants: ele-1 |
|
| period | 0..1 | Period | Time period when id is/was valid for use Invariants: ele-1 |
|
| assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) i Invariants: ele-1 |
|
| identifier:jurisdictional | S | 0..* | Identifier | Provincial/Territorial Health Number Invariants: ele-1 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| extension:reasonForNoHCN | S | 0..1 | Extension(CA-eReC-reason-for-no-HCN-EXT) | Why the patient has no health card number (Ontario CA-eReC extension) i Invariants: ele-1, ext-1 |
| extension:healthCardVersion | S | 0..1 | Extension(ext-identifierversion) | Health card version code (CA Baseline ext-identifierversion) i Invariants: ele-1, ext-1 |
| use | ?! | 0..1 | code | usual | official | temp | secondary | old (If known) i Pattern: officialBinding: identifier-use ( required)Invariants: ele-1 |
| type | 1..1 | CodeableConcept | Type or jurisdiction of the health card, which drives format validation i Pattern: {"coding":[{"code":"JHN","system":"http://terminology.hl7.org/CodeSystem/v2-0203","display":"Jurisdictional health numb…Binding: identifier-type ( extensible)Invariants: ele-1 |
|
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| coding | 1..1 | Coding | Code defined by a terminology system i Invariants: ele-1 |
|
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| system | 0..1 | uri | Identity of the terminology system i Fixed: http://terminology.hl7.org/CodeSystem/v2-0203Invariants: ele-1 |
|
| version | 0..1 | string | Version of the system - if relevant i Invariants: ele-1 |
|
| code | 0..1 | code | Symbol in syntax defined by the system Pattern: JHNInvariants: ele-1 |
|
| display | 0..1 | string | Representation defined by the system Pattern: Jurisdictional health numberInvariants: ele-1 |
|
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user i Invariants: ele-1 |
|
| text | 0..1 | string | Plain text representation of the concept i Invariants: ele-1 |
|
| system | 1..1 | uri | PHN system from Canadian PHN systems ValueSet i Binding: Canadian Provincial Health Number Systems ( required)e.g. https://fhir.infoway-inforoute.ca/NamingSystem/ca-ab-patient-healthcare-id · https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-patient-healthcare-id · https://fhir.infoway-inforoute.ca/NamingSystem/ca-mb-patient-healthcare-id …Invariants: ele-1 |
|
| value | 1..1 | string | The actual PHN value i Invariants: ele-1 |
|
| period | 0..1 | Period | Time period when id is/was valid for use Invariants: ele-1 |
|
| assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) i Invariants: ele-1 |
|
| identifier:mrn | S | 0..1 | Identifier | Medical Record Number (chart number) Invariants: ele-1 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| extension:reasonForNoHCN | S | 0..1 | Extension(CA-eReC-reason-for-no-HCN-EXT) | Why the patient has no health card number (Ontario CA-eReC extension) i Invariants: ele-1, ext-1 |
| use | ?! | 0..1 | code | usual | official | temp | secondary | old (If known) i Binding: identifier-use ( required)Invariants: ele-1 |
| type | 1..1 | CodeableConcept | Description of identifier i Pattern: {"coding":[{"code":"MR","system":"http://terminology.hl7.org/CodeSystem/v2-0203","display":"Medical record number"}]}Binding: identifier-type ( extensible)Invariants: ele-1 |
|
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| coding | 1..1 | Coding | Code defined by a terminology system i Invariants: ele-1 |
|
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| system | 0..1 | uri | Identity of the terminology system i Fixed: http://terminology.hl7.org/CodeSystem/v2-0203Invariants: ele-1 |
|
| version | 0..1 | string | Version of the system - if relevant i Invariants: ele-1 |
|
| code | 0..1 | code | Symbol in syntax defined by the system Pattern: MRInvariants: ele-1 |
|
| display | 0..1 | string | Representation defined by the system Pattern: Medical record numberInvariants: ele-1 |
|
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user i Invariants: ele-1 |
|
| text | 0..1 | string | Plain text representation of the concept i Invariants: ele-1 |
|
| system | 1..1 | uri | The namespace for the identifier value i Fixed: ../NamingSystem/patient-mrnInvariants: ele-1 |
|
| value | 1..1 | string | The value that is unique i Invariants: ele-1 |
|
| period | 0..1 | Period | Time period when id is/was valid for use Invariants: ele-1 |
|
| assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) i Invariants: ele-1 |
|
| active | S ?! | 0..1 | boolean | Whether this patient record is in active use i Invariants: ele-1 |
| name | S | 1..* | HumanName | A name associated with the patient i Invariants: ele-1 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| use | ?! | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden i Binding: name-use ( required)Invariants: ele-1 |
| text | 0..1 | string | Text representation of the full name i Invariants: ele-1 |
|
| family | S | 0..1 | string | Family name (often called 'Surname') i Invariants: ele-1 |
| given | S | 0..* | string | Given names (not always 'first') i Invariants: ele-1 |
| prefix | S | 0..* | string | Honorific prefix(es) (e.g. Dr., Mr., Ms.) Invariants: ele-1 |
| suffix | S | 0..* | string | Name suffix(es) (e.g. Jr., Sr.) Invariants: ele-1 |
| period | 0..1 | Period | Time period when name was/is in use Invariants: ele-1 |
|
| telecom | S | 0..* | ContactPoint | Contact details for the patient i Invariants: ele-1 |
| gender | S | 0..1 | code | Administrative gender (male | female | other | unknown) i Binding: administrative-gender ( required)Invariants: ele-1 |
| birthDate | S | 0..1 | date | The date of birth for the patient i Invariants: ele-1 |
| deceased[x] | S ?! | 0..1 | boolean, dateTime | Indicates if the patient is deceased i Invariants: ele-1 |
| address | S | 0..* | Address | Addresses for the patient i Invariants: ele-1, patient-address-country-alpha2 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| use | ?! | 0..1 | code | home | work | temp | old | billing - purpose of this address i Binding: address-use ( required)Invariants: ele-1 |
| type | 0..1 | code | postal | physical | both i Binding: address-type ( required)Invariants: ele-1 |
|
| text | 0..1 | string | Text representation of the address i Invariants: ele-1 |
|
| line | 0..* | string | Street name, number, direction & P.O. Box etc. Invariants: ele-1 |
|
| city | 0..1 | string | Name of city, town etc. Invariants: ele-1 |
|
| district | 0..1 | string | District name (aka county) i Invariants: ele-1 |
|
| state | S | 0..1 | string | Province / territory / state (bare two-letter subdivision code) i Binding: Province / Territory / State Value Set ( required)e.g. ON · BC · AB …Invariants: ele-1 |
| postalCode | S | 0..1 | string | Postal code for area Invariants: ele-1 |
| country | S | 0..1 | string | Country as ISO 3166-1 alpha-2 (CA, US) iBinding: iso3166-1-2 ( required)Invariants: ele-1 |
| period | 0..1 | Period | Time period when address was/is in use Invariants: ele-1 |
|
| maritalStatus | S | 0..1 | CodeableConcept | Marital status with raw code support Binding: marital-status ( extensible)Invariants: ele-1 |
| multipleBirth[x] | 0..1 | boolean, integer | Whether patient is part of multiple birth i Invariants: ele-1 |
|
| photo | 0..* | Attachment | Image of the patient i Invariants: ele-1 |
|
| contact | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient i Invariants: ele-1, pat-1 |
|
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Invariants: ele-1, ext-1 |
|
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored even if unrecognized i Invariants: ele-1, ext-1 |
| relationship | 0..* | CodeableConcept | The kind of relationship Binding: patient-contactrelationship ( extensible)Invariants: ele-1 |
|
| name | 0..1 | HumanName | A name associated with the contact person Invariants: ele-1 |
|
| telecom | 0..* | ContactPoint | A contact detail for the person i Invariants: ele-1 |
|
| address | 0..1 | Address | Address for the contact person Invariants: ele-1 |
|
| gender | 0..1 | code | male | female | other | unknown Binding: administrative-gender ( required)Invariants: ele-1 |
|
| organization | 0..1 | Reference(Organization) | Organization that is associated with the contact Invariants: ele-1 |
|
| period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient Invariants: ele-1 |
|
| communication | S | 0..* | BackboneElement | Language communication capabilities i Invariants: ele-1 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Invariants: ele-1, ext-1 |
|
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored even if unrecognized i Invariants: ele-1, ext-1 |
| language | S | 1..1 | CodeableConcept | Language with raw code support i Binding: languages ( preferred)Invariants: ele-1 |
| preferred | 0..1 | boolean | Language preference indicator i Invariants: ele-1 |
|
| generalPractitioner | S | 0..* | Reference(PractitionerRole Profile | Practitioner Profile) | Patient's primary care provider(s) i Invariants: ele-1 |
| managingOrganization | 1..1 | Reference(Organization Profile) | Organization that maintains the patient record i Invariants: ele-1 |
|
| link | ?! | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person i Invariants: ele-1 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Invariants: ele-1, ext-1 |
|
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored even if unrecognized i Invariants: ele-1, ext-1 |
| other | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to i Invariants: ele-1 |
|
| type | 1..1 | code | replaced-by | replaces | refer | seealso Binding: link-type ( required)Invariants: ele-1 |