Polaris Core Patient Profile

Overview

The Polaris Core Patient profile represents patient demographic and administrative information within primary care EMR systems. This profile establishes the foundational requirements for patient identification, demographics, and care relationships across the Polaris ecosystem.

Future Considerations

Potential enhancements being evaluated:

• Birth sex extension for clinical decision support
• Indigenous identity extensions per TRC requirements
• Expanded language coding for indigenous languages
• Social determinants of health extensions
• Patient portal access credentials

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	Patient	Polaris Patient Core Constraints: patient-has-polaris-id, patient-name-family-or-given
id	SΣ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
source	SΣ	0..1	uri	Identifies EMR instance & pipeline version the resource came from
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
text		0..1	Narrative	Narrative This profile does not constrain the narrative in regard to content, language, or traceability to data elements
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣ	1..*	Identifier	Patient identifiers (Polaris ID required) Slice: Unordered, Open by pattern:system, pattern:type
identifier:polarisId	SΣ	1..1	Identifier	Polaris Patient ID
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official
system	Σ	1..1	uri	Polaris patient identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-patient-identifier Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The actual Polaris patient ID value: unique in source system Example General: 123456
identifier:rawCode	SΣ	0..*	Identifier	Source EMR patient identifier
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: secondary
system	Σ	1..1	uri	Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-patient-raw-code Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456
identifier:jurisdictional	SΣ	0..*	Identifier	Provincial/Territorial Health Number
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official
type	Σ	0..1	CodeableConcept	Assume #JHN if absent Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
coding	Σ	1..1	Coding	Code defined by a terminology system
system	Σ	0..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
code	Σ	0..1	code	Symbol in syntax defined by the system Required Pattern: JHN
display	Σ	0..1	string	Representation defined by the system Required Pattern: Jurisdictional health number
system	Σ	1..1	uri	PHN system from Canadian PHN systems ValueSet Binding: Canadian Provincial Health Number Systems (required) Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The actual PHN value Example General: 123456
active	?!SΣ	0..1	boolean	Whether this patient record is in active use
name	SΣ	1..*	HumanName	A name associated with the patient
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
family	SΣ	0..1	string	Family name (often called 'Surname')
given	SΣ	0..*	string	Given names (not always 'first') This repeating element order: Given Names appear in the correct order for presenting the name
telecom	SΣ	0..*	ContactPoint	Contact details for the patient
gender	SΣ	0..1	code	Administrative gender (male | female | other | unknown) Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	SΣ	0..1	date	The date of birth for the patient
deceased[x]	?!SΣ	0..1		Indicates if the patient is deceased
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	SΣ	0..*	Address	Addresses for the patient
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
postalCode	SΣ	0..1	string	Postal code for area Example General: 9132
maritalStatus	S	0..1	CodeableConcept	Marital status with raw code support Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
Slices for coding	Σ	0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:system
coding:standard	SΣ	0..*	Coding	Standard marital status code
system	Σ	1..1	uri	Standard terminology system URI
code	Σ	1..1	code	Symbol in syntax defined by the system
coding:rawCode	SΣ	0..*	Coding	Source EMR marital status code
system	Σ	1..1	uri	Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-patient-maritalstatus-raw-code
code	Σ	1..1	code	EMR-specific marital status code
display	Σ	1..1	string	EMR's display text for this marital status
multipleBirth[x]		0..1		Whether patient is part of multiple birth
multipleBirthBoolean			boolean
multipleBirthInteger			integer
communication	S	0..*	BackboneElement	Language communication capabilities
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
language	S	1..1	CodeableConcept	Language with raw code support Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Slices for coding	Σ	0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:system
coding:standard	SΣ	0..*	Coding	Standard language code (ISO 639, BCP 47)
system	Σ	1..1	uri	Standard language system URI
code	Σ	1..1	code	Symbol in syntax defined by the system
coding:rawCode	SΣ	0..*	Coding	Source EMR language code
system	Σ	1..1	uri	Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-patient-language-raw-code
code	Σ	1..1	code	EMR-specific language code
display	Σ	1..1	string	EMR's display text for this language
generalPractitioner	S	0..*	Reference(Polaris PractitionerRole Core)	Patient's primary care provider(s)
managingOrganization	Σ	1..1	Reference(Polaris Organization Core)	Organization that maintains the patient record
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Patient.identifier:polarisId.use	required	Pattern Value: official http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Patient.identifier:rawCode.use	required	Pattern Value: secondary http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Patient.identifier:jurisdictional.use	required	Pattern Value: official http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Patient.identifier:jurisdictional.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Patient.identifier:jurisdictional.system	required	CanadianPHNSystems(a valid code from Canadian Provincial Health Number Systems CodeSystem) https://fhir.apps.health/ValueSet/canadian-phn-systems From this IG
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 From the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender From the FHIR Standard
Patient.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 From the FHIR Standard
Patient.maritalStatus	extensible	Marital Status Codes http://hl7.org/fhir/ValueSet/marital-status From the FHIR Standard
Patient.communication.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Patient	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
patient-has-polaris-id	error	Patient	Must have at least one identifier whose system matches the Polaris EMR pattern. : identifier.exists(system.matches('^https://fhir.apps.health/NamingSystem/[a-zA-Z0-9.-]+-patient-identifier$'))
patient-name-family-or-given	error	Patient	Patient must have at least one name with either a family or given name. : name.exists(family.exists() or given.exists())

This structure is derived from Patient

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	Patient	Polaris Patient Core Constraints: patient-has-polaris-id, patient-name-family-or-given
id	S	0..1	id	Logical id of this artifact
meta
source	S	0..1	uri	Identifies EMR instance & pipeline version the resource came from
text		0..1	Narrative	Narrative
Slices for identifier	S	1..*	Identifier	Patient identifiers (Polaris ID required) Slice: Unordered, Open by pattern:system, pattern:type
identifier:polarisId	S	1..1	Identifier	Polaris Patient ID
use		0..1	code	usual | official | temp | secondary | old (If known) Required Pattern: official
system		1..1	uri	Polaris patient identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-patient-identifier
value		1..1	string	The actual Polaris patient ID value: unique in source system
identifier:rawCode	S	0..*	Identifier	Source EMR patient identifier
use		0..1	code	usual | official | temp | secondary | old (If known) Required Pattern: secondary
system		1..1	uri	Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-patient-raw-code
value		1..1	string	The value that is unique
identifier:jurisdictional	S	0..*	Identifier	Provincial/Territorial Health Number
use		0..1	code	usual | official | temp | secondary | old (If known) Required Pattern: official
type		0..1	CodeableConcept	Assume #JHN if absent
coding		1..1	Coding	Code defined by a terminology system
system		0..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
code		0..1	code	Symbol in syntax defined by the system Required Pattern: JHN
display		0..1	string	Representation defined by the system Required Pattern: Jurisdictional health number
system		1..1	uri	PHN system from Canadian PHN systems ValueSet Binding: Canadian Provincial Health Number Systems (required)
value		1..1	string	The actual PHN value
active	S	0..1	boolean	Whether this patient record is in active use
name	S	1..*	HumanName	A name associated with the patient
family	S	0..1	string	Family name (often called 'Surname')
given	S	0..*	string	Given names (not always 'first')
telecom	S	0..*	ContactPoint	Contact details for the patient
gender	S	0..1	code	Administrative gender (male | female | other | unknown) Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	S	0..1	date	The date of birth for the patient
deceased[x]	S	0..1	boolean, dateTime	Indicates if the patient is deceased
address	S	0..*	Address	Addresses for the patient
postalCode	S	0..1	string	Postal code for area
maritalStatus	S	0..1	CodeableConcept	Marital status with raw code support
Slices for coding		0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:system
coding:standard	S	0..*	Coding	Standard marital status code
system		1..1	uri	Standard terminology system URI
code		1..1	code	Symbol in syntax defined by the system
coding:rawCode	S	0..*	Coding	Source EMR marital status code
system		1..1	uri	Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-patient-maritalstatus-raw-code
code		1..1	code	EMR-specific marital status code
display		1..1	string	EMR's display text for this marital status
multipleBirth[x]		0..1	boolean, integer	Whether patient is part of multiple birth
communication	S	0..*	BackboneElement	Language communication capabilities
language	S	1..1	CodeableConcept	Language with raw code support
Slices for coding		0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:system
coding:standard	S	0..*	Coding	Standard language code (ISO 639, BCP 47)
system		1..1	uri	Standard language system URI
code		1..1	code	Symbol in syntax defined by the system
coding:rawCode	S	0..*	Coding	Source EMR language code
system		1..1	uri	Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-patient-language-raw-code
code		1..1	code	EMR-specific language code
display		1..1	string	EMR's display text for this language
generalPractitioner	S	0..*	Reference(Polaris PractitionerRole Core)	Patient's primary care provider(s)
managingOrganization		1..1	Reference(Polaris Organization Core)	Organization that maintains the patient record
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Patient.identifier:jurisdictional.system	required	CanadianPHNSystems(a valid code from Canadian Provincial Health Number Systems CodeSystem) https://fhir.apps.health/ValueSet/canadian-phn-systems From this IG
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
patient-has-polaris-id	error	Patient	Must have at least one identifier whose system matches the Polaris EMR pattern. : identifier.exists(system.matches('^https://fhir.apps.health/NamingSystem/[a-zA-Z0-9.-]+-patient-identifier$'))
patient-name-family-or-given	error	Patient	Patient must have at least one name with either a family or given name. : name.exists(family.exists() or given.exists())

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	Patient	Polaris Patient Core Constraints: patient-has-polaris-id, patient-name-family-or-given
id	SΣ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	SΣ	0..1	uri	Identifies EMR instance & pipeline version the resource came from
profile	Σ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Narrative This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣ	1..*	Identifier	Patient identifiers (Polaris ID required) Slice: Unordered, Open by pattern:system, pattern:type
identifier:polarisId	SΣ	1..1	Identifier	Polaris Patient ID
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	Polaris patient identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-patient-identifier Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The actual Polaris patient ID value: unique in source system Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:rawCode	SΣ	0..*	Identifier	Source EMR patient identifier
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: secondary
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-patient-raw-code Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:jurisdictional	SΣ	0..*	Identifier	Provincial/Territorial Health Number
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official
type	Σ	0..1	CodeableConcept	Assume #JHN if absent Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	1..1	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system Required Pattern: JHN
display	Σ	0..1	string	Representation defined by the system Required Pattern: Jurisdictional health number
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
system	Σ	1..1	uri	PHN system from Canadian PHN systems ValueSet Binding: Canadian Provincial Health Number Systems (required) Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The actual PHN value Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
active	?!SΣ	0..1	boolean	Whether this patient record is in active use
name	SΣ	1..*	HumanName	A name associated with the patient
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	Σ	0..1	string	Text representation of the full name
family	SΣ	0..1	string	Family name (often called 'Surname')
given	SΣ	0..*	string	Given names (not always 'first') This repeating element order: Given Names appear in the correct order for presenting the name
prefix	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
telecom	SΣ	0..*	ContactPoint	Contact details for the patient
gender	SΣ	0..1	code	Administrative gender (male | female | other | unknown) Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	SΣ	0..1	date	The date of birth for the patient
deceased[x]	?!SΣ	0..1		Indicates if the patient is deceased
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	SΣ	0..*	Address	Addresses for the patient
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type	Σ	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	Σ	0..*	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	Σ	0..1	string	Name of city, town etc. Example General: Erewhon
district	Σ	0..1	string	District name (aka county) Example General: Madison
state	Σ	0..1	string	Sub-unit of country (abbreviations ok)
postalCode	SΣ	0..1	string	Postal code for area Example General: 9132
country	Σ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
period	Σ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
maritalStatus	S	0..1	CodeableConcept	Marital status with raw code support Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for coding	Σ	0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:system
coding:standard	SΣ	0..*	Coding	Standard marital status code
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Standard terminology system URI
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
coding:rawCode	SΣ	0..*	Coding	Source EMR marital status code
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-patient-maritalstatus-raw-code
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	EMR-specific marital status code
display	Σ	1..1	string	EMR's display text for this marital status
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
multipleBirth[x]		0..1		Whether patient is part of multiple birth
multipleBirthBoolean			boolean
multipleBirthInteger			integer
photo		0..*	Attachment	Image of the patient
contact	C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relationship		0..*	CodeableConcept	The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
name		0..1	HumanName	A name associated with the contact person
telecom		0..*	ContactPoint	A contact detail for the person
address		0..1	Address	Address for the contact person
gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization	C	0..1	Reference(Organization)	Organization that is associated with the contact
period		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
communication	S	0..*	BackboneElement	Language communication capabilities
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
language	S	1..1	CodeableConcept	Language with raw code support Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for coding	Σ	0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:system
coding:standard	SΣ	0..*	Coding	Standard language code (ISO 639, BCP 47)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Standard language system URI
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
coding:rawCode	SΣ	0..*	Coding	Source EMR language code
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-patient-language-raw-code
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	EMR-specific language code
display	Σ	1..1	string	EMR's display text for this language
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
preferred		0..1	boolean	Language preference indicator
generalPractitioner	S	0..*	Reference(Polaris PractitionerRole Core)	Patient's primary care provider(s)
managingOrganization	Σ	1..1	Reference(Polaris Organization Core)	Organization that maintains the patient record
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Patient.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels From the FHIR Standard
Patient.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags From the FHIR Standard
Patient.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.identifier:polarisId.use	required	Pattern Value: official http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Patient.identifier:polarisId.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Patient.identifier:rawCode.use	required	Pattern Value: secondary http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Patient.identifier:rawCode.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Patient.identifier:jurisdictional.use	required	Pattern Value: official http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Patient.identifier:jurisdictional.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Patient.identifier:jurisdictional.system	required	CanadianPHNSystems(a valid code from Canadian Provincial Health Number Systems CodeSystem) https://fhir.apps.health/ValueSet/canadian-phn-systems From this IG
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 From the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender From the FHIR Standard
Patient.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 From the FHIR Standard
Patient.address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1 From the FHIR Standard
Patient.maritalStatus	extensible	Marital Status Codes http://hl7.org/fhir/ValueSet/marital-status From the FHIR Standard
Patient.contact.relationship	extensible	PatientContactRelationship http://hl7.org/fhir/ValueSet/patient-contactrelationship From the FHIR Standard
Patient.contact.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 From the FHIR Standard
Patient.communication.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Patient	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
pat-1	error	Patient.contact	SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists()
patient-has-polaris-id	error	Patient	Must have at least one identifier whose system matches the Polaris EMR pattern. : identifier.exists(system.matches('^https://fhir.apps.health/NamingSystem/[a-zA-Z0-9.-]+-patient-identifier$'))
patient-name-family-or-given	error	Patient	Patient must have at least one name with either a family or given name. : name.exists(family.exists() or given.exists())

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	Patient	Polaris Patient Core Constraints: patient-has-polaris-id, patient-name-family-or-given
id	SΣ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
source	SΣ	0..1	uri	Identifies EMR instance & pipeline version the resource came from
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
text		0..1	Narrative	Narrative This profile does not constrain the narrative in regard to content, language, or traceability to data elements
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣ	1..*	Identifier	Patient identifiers (Polaris ID required) Slice: Unordered, Open by pattern:system, pattern:type
identifier:polarisId	SΣ	1..1	Identifier	Polaris Patient ID
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official
system	Σ	1..1	uri	Polaris patient identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-patient-identifier Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The actual Polaris patient ID value: unique in source system Example General: 123456
identifier:rawCode	SΣ	0..*	Identifier	Source EMR patient identifier
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: secondary
system	Σ	1..1	uri	Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-patient-raw-code Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456
identifier:jurisdictional	SΣ	0..*	Identifier	Provincial/Territorial Health Number
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official
type	Σ	0..1	CodeableConcept	Assume #JHN if absent Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
coding	Σ	1..1	Coding	Code defined by a terminology system
system	Σ	0..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
code	Σ	0..1	code	Symbol in syntax defined by the system Required Pattern: JHN
display	Σ	0..1	string	Representation defined by the system Required Pattern: Jurisdictional health number
system	Σ	1..1	uri	PHN system from Canadian PHN systems ValueSet Binding: Canadian Provincial Health Number Systems (required) Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The actual PHN value Example General: 123456
active	?!SΣ	0..1	boolean	Whether this patient record is in active use
name	SΣ	1..*	HumanName	A name associated with the patient
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
family	SΣ	0..1	string	Family name (often called 'Surname')
given	SΣ	0..*	string	Given names (not always 'first') This repeating element order: Given Names appear in the correct order for presenting the name
telecom	SΣ	0..*	ContactPoint	Contact details for the patient
gender	SΣ	0..1	code	Administrative gender (male | female | other | unknown) Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	SΣ	0..1	date	The date of birth for the patient
deceased[x]	?!SΣ	0..1		Indicates if the patient is deceased
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	SΣ	0..*	Address	Addresses for the patient
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
postalCode	SΣ	0..1	string	Postal code for area Example General: 9132
maritalStatus	S	0..1	CodeableConcept	Marital status with raw code support Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
Slices for coding	Σ	0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:system
coding:standard	SΣ	0..*	Coding	Standard marital status code
system	Σ	1..1	uri	Standard terminology system URI
code	Σ	1..1	code	Symbol in syntax defined by the system
coding:rawCode	SΣ	0..*	Coding	Source EMR marital status code
system	Σ	1..1	uri	Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-patient-maritalstatus-raw-code
code	Σ	1..1	code	EMR-specific marital status code
display	Σ	1..1	string	EMR's display text for this marital status
multipleBirth[x]		0..1		Whether patient is part of multiple birth
multipleBirthBoolean			boolean
multipleBirthInteger			integer
communication	S	0..*	BackboneElement	Language communication capabilities
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
language	S	1..1	CodeableConcept	Language with raw code support Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
Slices for coding	Σ	0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:system
coding:standard	SΣ	0..*	Coding	Standard language code (ISO 639, BCP 47)
system	Σ	1..1	uri	Standard language system URI
code	Σ	1..1	code	Symbol in syntax defined by the system
coding:rawCode	SΣ	0..*	Coding	Source EMR language code
system	Σ	1..1	uri	Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-patient-language-raw-code
code	Σ	1..1	code	EMR-specific language code
display	Σ	1..1	string	EMR's display text for this language
generalPractitioner	S	0..*	Reference(Polaris PractitionerRole Core)	Patient's primary care provider(s)
managingOrganization	Σ	1..1	Reference(Polaris Organization Core)	Organization that maintains the patient record
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Patient.identifier:polarisId.use	required	Pattern Value: official http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Patient.identifier:rawCode.use	required	Pattern Value: secondary http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Patient.identifier:jurisdictional.use	required	Pattern Value: official http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Patient.identifier:jurisdictional.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Patient.identifier:jurisdictional.system	required	CanadianPHNSystems(a valid code from Canadian Provincial Health Number Systems CodeSystem) https://fhir.apps.health/ValueSet/canadian-phn-systems From this IG
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 From the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender From the FHIR Standard
Patient.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 From the FHIR Standard
Patient.maritalStatus	extensible	Marital Status Codes http://hl7.org/fhir/ValueSet/marital-status From the FHIR Standard
Patient.communication.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Patient	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
patient-has-polaris-id	error	Patient	Must have at least one identifier whose system matches the Polaris EMR pattern. : identifier.exists(system.matches('^https://fhir.apps.health/NamingSystem/[a-zA-Z0-9.-]+-patient-identifier$'))
patient-name-family-or-given	error	Patient	Patient must have at least one name with either a family or given name. : name.exists(family.exists() or given.exists())

Differential View

This structure is derived from Patient

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	Patient	Polaris Patient Core Constraints: patient-has-polaris-id, patient-name-family-or-given
id	S	0..1	id	Logical id of this artifact
meta
source	S	0..1	uri	Identifies EMR instance & pipeline version the resource came from
text		0..1	Narrative	Narrative
Slices for identifier	S	1..*	Identifier	Patient identifiers (Polaris ID required) Slice: Unordered, Open by pattern:system, pattern:type
identifier:polarisId	S	1..1	Identifier	Polaris Patient ID
use		0..1	code	usual | official | temp | secondary | old (If known) Required Pattern: official
system		1..1	uri	Polaris patient identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-patient-identifier
value		1..1	string	The actual Polaris patient ID value: unique in source system
identifier:rawCode	S	0..*	Identifier	Source EMR patient identifier
use		0..1	code	usual | official | temp | secondary | old (If known) Required Pattern: secondary
system		1..1	uri	Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-patient-raw-code
value		1..1	string	The value that is unique
identifier:jurisdictional	S	0..*	Identifier	Provincial/Territorial Health Number
use		0..1	code	usual | official | temp | secondary | old (If known) Required Pattern: official
type		0..1	CodeableConcept	Assume #JHN if absent
coding		1..1	Coding	Code defined by a terminology system
system		0..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
code		0..1	code	Symbol in syntax defined by the system Required Pattern: JHN
display		0..1	string	Representation defined by the system Required Pattern: Jurisdictional health number
system		1..1	uri	PHN system from Canadian PHN systems ValueSet Binding: Canadian Provincial Health Number Systems (required)
value		1..1	string	The actual PHN value
active	S	0..1	boolean	Whether this patient record is in active use
name	S	1..*	HumanName	A name associated with the patient
family	S	0..1	string	Family name (often called 'Surname')
given	S	0..*	string	Given names (not always 'first')
telecom	S	0..*	ContactPoint	Contact details for the patient
gender	S	0..1	code	Administrative gender (male | female | other | unknown) Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	S	0..1	date	The date of birth for the patient
deceased[x]	S	0..1	boolean, dateTime	Indicates if the patient is deceased
address	S	0..*	Address	Addresses for the patient
postalCode	S	0..1	string	Postal code for area
maritalStatus	S	0..1	CodeableConcept	Marital status with raw code support
Slices for coding		0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:system
coding:standard	S	0..*	Coding	Standard marital status code
system		1..1	uri	Standard terminology system URI
code		1..1	code	Symbol in syntax defined by the system
coding:rawCode	S	0..*	Coding	Source EMR marital status code
system		1..1	uri	Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-patient-maritalstatus-raw-code
code		1..1	code	EMR-specific marital status code
display		1..1	string	EMR's display text for this marital status
multipleBirth[x]		0..1	boolean, integer	Whether patient is part of multiple birth
communication	S	0..*	BackboneElement	Language communication capabilities
language	S	1..1	CodeableConcept	Language with raw code support
Slices for coding		0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:system
coding:standard	S	0..*	Coding	Standard language code (ISO 639, BCP 47)
system		1..1	uri	Standard language system URI
code		1..1	code	Symbol in syntax defined by the system
coding:rawCode	S	0..*	Coding	Source EMR language code
system		1..1	uri	Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-patient-language-raw-code
code		1..1	code	EMR-specific language code
display		1..1	string	EMR's display text for this language
generalPractitioner	S	0..*	Reference(Polaris PractitionerRole Core)	Patient's primary care provider(s)
managingOrganization		1..1	Reference(Polaris Organization Core)	Organization that maintains the patient record
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Patient.identifier:jurisdictional.system	required	CanadianPHNSystems(a valid code from Canadian Provincial Health Number Systems CodeSystem) https://fhir.apps.health/ValueSet/canadian-phn-systems From this IG
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
patient-has-polaris-id	error	Patient	Must have at least one identifier whose system matches the Polaris EMR pattern. : identifier.exists(system.matches('^https://fhir.apps.health/NamingSystem/[a-zA-Z0-9.-]+-patient-identifier$'))
patient-name-family-or-given	error	Patient	Patient must have at least one name with either a family or given name. : name.exists(family.exists() or given.exists())

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	Patient	Polaris Patient Core Constraints: patient-has-polaris-id, patient-name-family-or-given
id	SΣ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	SΣ	0..1	uri	Identifies EMR instance & pipeline version the resource came from
profile	Σ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Narrative This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣ	1..*	Identifier	Patient identifiers (Polaris ID required) Slice: Unordered, Open by pattern:system, pattern:type
identifier:polarisId	SΣ	1..1	Identifier	Polaris Patient ID
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	Polaris patient identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-patient-identifier Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The actual Polaris patient ID value: unique in source system Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:rawCode	SΣ	0..*	Identifier	Source EMR patient identifier
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: secondary
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-patient-raw-code Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:jurisdictional	SΣ	0..*	Identifier	Provincial/Territorial Health Number
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official
type	Σ	0..1	CodeableConcept	Assume #JHN if absent Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	1..1	Coding	Code defined by a terminology system
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system Required Pattern: JHN
display	Σ	0..1	string	Representation defined by the system Required Pattern: Jurisdictional health number
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
system	Σ	1..1	uri	PHN system from Canadian PHN systems ValueSet Binding: Canadian Provincial Health Number Systems (required) Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The actual PHN value Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
active	?!SΣ	0..1	boolean	Whether this patient record is in active use
name	SΣ	1..*	HumanName	A name associated with the patient
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	Σ	0..1	string	Text representation of the full name
family	SΣ	0..1	string	Family name (often called 'Surname')
given	SΣ	0..*	string	Given names (not always 'first') This repeating element order: Given Names appear in the correct order for presenting the name
prefix	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
telecom	SΣ	0..*	ContactPoint	Contact details for the patient
gender	SΣ	0..1	code	Administrative gender (male | female | other | unknown) Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	SΣ	0..1	date	The date of birth for the patient
deceased[x]	?!SΣ	0..1		Indicates if the patient is deceased
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	SΣ	0..*	Address	Addresses for the patient
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type	Σ	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	Σ	0..*	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	Σ	0..1	string	Name of city, town etc. Example General: Erewhon
district	Σ	0..1	string	District name (aka county) Example General: Madison
state	Σ	0..1	string	Sub-unit of country (abbreviations ok)
postalCode	SΣ	0..1	string	Postal code for area Example General: 9132
country	Σ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code)
period	Σ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
maritalStatus	S	0..1	CodeableConcept	Marital status with raw code support Binding: Marital Status Codes (extensible): The domestic partnership status of a person.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for coding	Σ	0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:system
coding:standard	SΣ	0..*	Coding	Standard marital status code
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Standard terminology system URI
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
coding:rawCode	SΣ	0..*	Coding	Source EMR marital status code
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-patient-maritalstatus-raw-code
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	EMR-specific marital status code
display	Σ	1..1	string	EMR's display text for this marital status
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
multipleBirth[x]		0..1		Whether patient is part of multiple birth
multipleBirthBoolean			boolean
multipleBirthInteger			integer
photo		0..*	Attachment	Image of the patient
contact	C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relationship		0..*	CodeableConcept	The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient.
name		0..1	HumanName	A name associated with the contact person
telecom		0..*	ContactPoint	A contact detail for the person
address		0..1	Address	Address for the contact person
gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization	C	0..1	Reference(Organization)	Organization that is associated with the contact
period		0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient
communication	S	0..*	BackboneElement	Language communication capabilities
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
language	S	1..1	CodeableConcept	Language with raw code support Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for coding	Σ	0..*	Coding	Code defined by a terminology system Slice: Unordered, Open by pattern:system
coding:standard	SΣ	0..*	Coding	Standard language code (ISO 639, BCP 47)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Standard language system URI
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
coding:rawCode	SΣ	0..*	Coding	Source EMR language code
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-patient-language-raw-code
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	EMR-specific language code
display	Σ	1..1	string	EMR's display text for this language
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
preferred		0..1	boolean	Language preference indicator
generalPractitioner	S	0..*	Reference(Polaris PractitionerRole Core)	Patient's primary care provider(s)
managingOrganization	Σ	1..1	Reference(Polaris Organization Core)	Organization that maintains the patient record
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Patient.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels From the FHIR Standard
Patient.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags From the FHIR Standard
Patient.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.identifier:polarisId.use	required	Pattern Value: official http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Patient.identifier:polarisId.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Patient.identifier:rawCode.use	required	Pattern Value: secondary http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Patient.identifier:rawCode.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Patient.identifier:jurisdictional.use	required	Pattern Value: official http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Patient.identifier:jurisdictional.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Patient.identifier:jurisdictional.system	required	CanadianPHNSystems(a valid code from Canadian Provincial Health Number Systems CodeSystem) https://fhir.apps.health/ValueSet/canadian-phn-systems From this IG
Patient.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 From the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender From the FHIR Standard
Patient.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 From the FHIR Standard
Patient.address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1 From the FHIR Standard
Patient.maritalStatus	extensible	Marital Status Codes http://hl7.org/fhir/ValueSet/marital-status From the FHIR Standard
Patient.contact.relationship	extensible	PatientContactRelationship http://hl7.org/fhir/ValueSet/patient-contactrelationship From the FHIR Standard
Patient.contact.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 From the FHIR Standard
Patient.communication.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Patient	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Patient	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
pat-1	error	Patient.contact	SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists()
patient-has-polaris-id	error	Patient	Must have at least one identifier whose system matches the Polaris EMR pattern. : identifier.exists(system.matches('^https://fhir.apps.health/NamingSystem/[a-zA-Z0-9.-]+-patient-identifier$'))
patient-name-family-or-given	error	Patient	Patient must have at least one name with either a family or given name. : name.exists(family.exists() or given.exists())

This structure is derived from Patient

Summary

Mandatory: 6 elements(15 nested mandatory elements)
Must-Support: 24 elements
Fixed: 1 element

Structures

This structure refers to these other structures:

• Polaris PractitionerRole Core (https://fhir.apps.health/StructureDefinition/polaris-core-practitionerrole)
• Polaris Organization Core (https://fhir.apps.health/StructureDefinition/polaris-core-organization)

Slices

This structure defines the following Slices:

• The element 2 is sliced based on the values of Patient.identifier
• The element 1 is sliced based on the value of Patient.maritalStatus.coding
• The element 1 is sliced based on the value of Patient.communication.language.coding