Pan-Canadian Patient Summary v0.0.3 FHIR Implementation Guide

Patient (PS-CA)

This version of the PS-CA Implementation Guide has been superseded by a newer version. Other releases of the PS-CA Implementation Guide may be found on a table on the Home Page of this Project.

Additional information on this profile (including the JSON & XML structure and detailed element descriptions) can be found at Patient (PS-CA)

Profile

Patient	I		Patient	There are no (further) constraints on this element Element Id Patient Short description Information about an individual or animal receiving health care services Alternate names SubjectOfCare Client Resident Definition Demographics and other administrative information about an individual or animal receiving care or other health-related services. Data Type Patient Constraints dom-2:If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-4: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-3: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-6:A resource should have narrative for robust management text.`div`.exists() dom-5:If a resource is contained in another resource, it SHALL NOT have a security label `contained.meta.security.empty()` Mappings rim:Entity. Role, or Act rim:Patient[classCode=PAT] cda:ClinicalDocument.recordTarget.patientRole
identifier	S Σ	0..*	Data Type: Identifier (CA Baseline)	Element Id Patient.identifier Short description An identifier intended for computation Definition An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. Requirements Patients are almost always assigned specific numerical identifiers. Comments This element employs the constraints on identifier put forth in the CA Baseline using a profiled data type. Data Type Data Type: Identifier (CA Baseline) Sliced: Unordered, Open, by type(Pattern) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier w5:FiveWs.identifier v2:PID-3 rim:id cda:.id
(All Slices)				There are no (further) constraints on this element
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element Id Patient.identifier.use Short description usual \| official \| temp \| secondary \| old (If known) Definition The purpose of this identifier. Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Data Type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:N/A rim:Role.code or implied by context
type	Σ	0..1	CodeableConceptBinding	Element Id Patient.identifier.type Short description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Requirements Allows users to make use of identifiers when the identifier system is not known. Comments This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. Data Type CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples Pattern { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0203", "code": "MR" } ] } Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD v2:CX.5 rim:Role.code or implied by context
system	Σ	1..1	uri	There are no (further) constraints on this element Element Id Patient.identifier.system Short description The namespace for the identifier value Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique. Requirements There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Comments Identifier.system is always case sensitive. Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General http://www.acme.com/identifiers/patient Mappings rim:n/a v2:CX.4 / EI-2-4 rim:II.root or Role.id.root servd:./IdentifierType
value	Σ	1..1	string	Element Id Patient.identifier.value Short description The value that is unique within the system. Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system. Comments If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 123456 Mappings rim:n/a v2:CX.1 / EI.1 rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) servd:./Value
period	Σ I	0..1	Period	There are no (further) constraints on this element Element Id Patient.identifier.period Short description Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use. Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. Data Type Period Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` per-1:If present, start SHALL have a lower value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)` Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2:CX.7 + CX.8 rim:Role.effectiveTime or implied by context servd:./StartDate and ./EndDate
assigner	Σ I	0..1	Reference(Organization)	There are no (further) constraints on this element Element Id Patient.identifier.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier. Comments The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. Data Type Reference(Organization) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) v2:CX.4 / (CX.4,CX.9,CX.10) rim:II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper servd:./IdentifierIssuingAuthority
PPN	Σ	0..*	Identifier	Element Id Patient.identifier:PPN Short description Canada Passport Number Definition An identifier for this patient. Requirements Patients are almost always assigned specific numerical identifiers. Data Type Identifier Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier w5:FiveWs.identifier v2:PID-3 rim:id cda:.id
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element Id Patient.identifier:PPN.use Short description usual \| official \| temp \| secondary \| old (If known) Definition The purpose of this identifier. Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Data Type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:N/A rim:Role.code or implied by context
type	Σ	1..1	CodeableConceptBindingFixed Value	Element Id Patient.identifier:PPN.type Short description Passport number identifier type Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Requirements Allows users to make use of identifiers when the identifier system is not known. Comments This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. Data Type CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Fixed Value { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0203", "code": "PPN" } ] } Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD v2:CX.5 rim:Role.code or implied by context
system	Σ	1..1	uriFixed Value	Element Id Patient.identifier:PPN.system Short description A Canadian passport number Naming System from the Canadian URI Registry Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique. Requirements There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Comments Identifier.system is always case sensitive. Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Fixed Value https://fhir.infoway-inforoute.ca/NamingSystem/ca-passport-number Mappings rim:n/a v2:CX.4 / EI-2-4 rim:II.root or Role.id.root servd:./IdentifierType
value	Σ	1..1	string	Element Id Patient.identifier:PPN.value Short description A Canadian passport number Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system. Comments If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 123456 Mappings rim:n/a v2:CX.1 / EI.1 rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) servd:./Value
period	Σ I	0..1	Period	There are no (further) constraints on this element Element Id Patient.identifier:PPN.period Short description Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use. Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. Data Type Period Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` per-1:If present, start SHALL have a lower value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)` Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2:CX.7 + CX.8 rim:Role.effectiveTime or implied by context servd:./StartDate and ./EndDate
assigner	Σ I	0..1	Reference(Organization)	There are no (further) constraints on this element Element Id Patient.identifier:PPN.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier. Comments The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. Data Type Reference(Organization) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) v2:CX.4 / (CX.4,CX.9,CX.10) rim:II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper servd:./IdentifierIssuingAuthority
JPID	Σ	0..*	Identifier	Element Id Patient.identifier:JPID Short description Jurisdictional Person Identification Definition Federal patient and person identifiers used by all jurisdictions across Canada Requirements Patients are almost always assigned specific numerical identifiers. Data Type Identifier Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier w5:FiveWs.identifier v2:PID-3 rim:id cda:.id
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element Id Patient.identifier:JPID.use Short description usual \| official \| temp \| secondary \| old (If known) Definition The purpose of this identifier. Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Data Type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:N/A rim:Role.code or implied by context
type	Σ	1..1	CodeableConceptBindingFixed Value	Element Id Patient.identifier:JPID.type Short description Jurisdictional Person Identification Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Requirements Allows users to make use of identifiers when the identifier system is not known. Comments This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. Data Type CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Fixed Value { "coding": [ { "code": "JPID" } ] } Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD v2:CX.5 rim:Role.code or implied by context
system	Σ	1..1	uri	Element Id Patient.identifier:JPID.system Short description Jurisdictional Person identification Naming System from the Canadian URI Registry Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique. Requirements There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Comments Identifier.system is always case sensitive. Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General http://www.acme.com/identifiers/patient Mappings rim:n/a v2:CX.4 / EI-2-4 rim:II.root or Role.id.root servd:./IdentifierType
value	Σ	1..1	string	Element Id Patient.identifier:JPID.value Short description Jurisdictional Person identification number Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system. Comments If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 123456 Mappings rim:n/a v2:CX.1 / EI.1 rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) servd:./Value
period	Σ I	0..1	Period	There are no (further) constraints on this element Element Id Patient.identifier:JPID.period Short description Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use. Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. Data Type Period Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` per-1:If present, start SHALL have a lower value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)` Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2:CX.7 + CX.8 rim:Role.effectiveTime or implied by context servd:./StartDate and ./EndDate
assigner	Σ I	0..1	Reference(Organization)	There are no (further) constraints on this element Element Id Patient.identifier:JPID.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier. Comments The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. Data Type Reference(Organization) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) v2:CX.4 / (CX.4,CX.9,CX.10) rim:II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper servd:./IdentifierIssuingAuthority
JHN	Σ	0..*	Identifier	Element Id Patient.identifier:JHN Short description Jurisdictional Health Number Definition Federal patient and person health numbers used by all jurisdictions across Canada Requirements Patients are almost always assigned specific numerical identifiers. Data Type Identifier Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier w5:FiveWs.identifier v2:PID-3 rim:id cda:.id
extension	I	0..*	Extension	Element Id Patient.identifier:JHN.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data Type Extension Sliced: Unordered, Open, by url(Value) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim:n/a rim:N/A
versionCode	I	0..*	Extension	Element Id Patient.identifier:JHN.extension:versionCode Short description Health Number Version Code Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data Type Extension Extension URL http://hl7.org/fhir/ca/baseline/StructureDefinition/ext-identifierversion Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1:Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim:n/a rim:N/A
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element Id Patient.identifier:JHN.use Short description usual \| official \| temp \| secondary \| old (If known) Definition The purpose of this identifier. Requirements Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Comments Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Data Type code Binding Identifies the purpose for this identifier, if known . IdentifierUse (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:N/A rim:Role.code or implied by context
type	Σ	1..1	CodeableConceptBindingFixed Value	Element Id Patient.identifier:JHN.type Short description Description of identifier Definition A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Requirements Allows users to make use of identifiers when the identifier system is not known. Comments This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. Data Type CodeableConcept Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Fixed Value { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0203", "code": "JHN" } ] } Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD v2:CX.5 rim:Role.code or implied by context
system	Σ	1..1	uri	Element Id Patient.identifier:JHN.system Short description A Health Number Naming System from the Canadian URI Registry Definition Establishes the namespace for the value - that is, a URL that describes a set values that are unique. Requirements There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Comments Identifier.system is always case sensitive. Data Type uri Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General http://www.acme.com/identifiers/patient Mappings rim:n/a v2:CX.4 / EI-2-4 rim:II.root or Role.id.root servd:./IdentifierType
value	Σ	1..1	string	There are no (further) constraints on this element Element Id Patient.identifier:JHN.value Short description The value that is unique Definition The portion of the identifier typically relevant to the user and which is unique within the context of the system. Comments If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Examples General 123456 Mappings rim:n/a v2:CX.1 / EI.1 rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root) servd:./Value
period	Σ I	0..1	Period	There are no (further) constraints on this element Element Id Patient.identifier:JHN.period Short description Time period when id is/was valid for use Definition Time period during which identifier is/was valid for use. Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. Data Type Period Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` per-1:If present, start SHALL have a lower value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)` Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2:CX.7 + CX.8 rim:Role.effectiveTime or implied by context servd:./StartDate and ./EndDate
assigner	Σ I	0..1	Reference(Organization)	There are no (further) constraints on this element Element Id Patient.identifier:JHN.assigner Short description Organization that issued id (may be just text) Definition Organization that issued/manages the identifier. Comments The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. Data Type Reference(Organization) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) v2:CX.4 / (CX.4,CX.9,CX.10) rim:II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper servd:./IdentifierIssuingAuthority
active	Σ ?!	0..1	boolean	There are no (further) constraints on this element Element Id Patient.active Short description Whether this patient's record is in active use Definition Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules. It is often used to filter patient lists to exclude inactive patients Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death. Requirements Need to be able to mark a patient record as not to be used because it was created in error. Comments If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient. Meaning When Missing This resource is generally assumed to be active if no value is provided for the active element Data Type boolean Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a w5:FiveWs.status rim:statusCode cda:n/a
name	S Σ I	1..*	HumanName	Element Id Patient.name Short description A name associated with the patient Definition A name associated with the individual. Requirements Need to be able to track the patient by multiple names. Examples are your official name and a partner name. The Alphabetic representation of the name SHALL be always provided Comments A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns. Data Type HumanName Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cabaseline-pat-1:Patient.name.given or Patient.name.family or both SHALL be present `family.exists() or given.exists()` Mappings rim:n/a v2:XPN rim:EN (actually, PN) servd:ProviderName v2:PID-5, PID-9 rim:name cda:.patient.name
use	Σ ?!	0..1	codeBinding	There are no (further) constraints on this element Element Id Patient.name.use Short description usual \| official \| temp \| nickname \| anonymous \| old \| maiden Definition Identifies the purpose for this name. Requirements Allows the appropriate name for a particular context of use to be selected from among a set of names. Comments Applications can assume that a name is current unless it explicitly says that it is temporary or old. Data Type code Binding The use of a human name. NameUse (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN.7, but often indicated by which field contains the name rim:unique(./use) servd:./NamePurpose
text	S Σ	0..1	string	Element Id Patient.name.text Short description Text representation of the full name Definition Text representation of the full name. Due to the cultural variance around the world a consuming system may not know how to present the name correctly; moreover not all the parts of the name go in given or family. Creators are therefore strongly encouraged to provide through this element a presented version of the name. Future versions of this guide may require this element Requirements A renderable, unencoded form. Comments Some systems will not have a field for representing the full name as a string, these systems are still expected to be able to demonstrate they can construct name.text when developing the patient summary instance Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:implied by XPN.11 rim:./formatted
family	S Σ	0..1	string	There are no (further) constraints on this element Element Id Patient.name.family Short description Family name (often called 'Surname') Alternate names surname Definition The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father. Comments Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures). Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN.1/FN.1 rim:./part[partType = FAM] servd:./FamilyName
given	S Σ	0..*	string	There are no (further) constraints on this element Element Id Patient.name.given Short description Given names (not always 'first'). Includes middle names Alternate names first name, middle name Definition Given name. Comments If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN.2 + XPN.3 rim:./part[partType = GIV] servd:./GivenNames
prefix	Σ	0..*	string	There are no (further) constraints on this element Element Id Patient.name.prefix Short description Parts that come before the name Definition Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN.5 rim:./part[partType = PFX] servd:./TitleCode
suffix	Σ	0..*	string	There are no (further) constraints on this element Element Id Patient.name.suffix Short description Parts that come after the name Definition Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN/4 rim:./part[partType = SFX]
period	Σ I	0..1	Period	There are no (further) constraints on this element Element Id Patient.name.period Short description Time period when name was/is in use Definition Indicates the period of time when this name was valid for the named person. Requirements Allows names to be placed in historical context. Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. Data Type Period Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` per-1:If present, start SHALL have a lower value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)` Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2:XPN.13 + XPN.14 rim:./usablePeriod[type="IVL<TS>"] servd:./StartDate and ./EndDate
telecom	Σ I	0..*	ContactPoint	Element Id Patient.telecom Short description A contact detail for the individual Definition A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted. Requirements People have (primary) ways to contact them in some way such as phone, email. Comments IPS-UV flags this as a MS element. It is not currently flagged as MS in PS-CA, as stakeholders have indicated the element may not be supported by the majority of systems today. Systems that do support the element are encouraged to include it in generated Patient Summary documents, and support it when received. Vendors should expect that some jurisdictions may add a MS requirement within the context of their own jurisdictional content. Data Type ContactPoint Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpt-2:A system is required if a value is provided. `value.empty() or system.exists()` Mappings rim:n/a v2:XTN rim:TEL servd:ContactPoint v2:PID-13, PID-14, PID-40 rim:telecom cda:.telecom
gender	S Σ	1..1	codeBinding	There are no (further) constraints on this element Element Id Patient.gender Short description male \| female \| other \| unknown Definition Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes. Requirements Needed for identification of the individual, in combination with (at least) name and birth date. Comments The gender might not match the biological sex as determined by genetics or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than male and female, though the vast majority of systems and contexts only support male and female. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific sex or gender aspect of interest (anatomical, chromosomal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosomal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overridable error, not a "hard" error. See the Patient Gender and Sex section for additional information about communicating patient gender and sex. Data Type code Binding The gender of a person used for administrative purposes. AdministrativeGender (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:PID-8 rim:player[classCode=PSN\|ANM and determinerCode=INSTANCE]/administrativeGender cda:.patient.administrativeGenderCode
birthDate	S Σ	1..1	date	There are no (further) constraints on this element Element Id Patient.birthDate Short description The date of birth for the individual Definition The date of birth for the individual. Requirements Age of the individual drives many clinical processes. Comments At least an estimated year should be provided as a guess if the real DOB is unknown There is a standard extension "patient-birthTime" available that should be used where Time is required (such as in maternity/infant care systems). Data Type date Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:PID-7 rim:player[classCode=PSN\|ANM and determinerCode=INSTANCE]/birthTime cda:.patient.birthTime loinc:21112-8
deceased[x]	Σ ?!	0..1		There are no (further) constraints on this element Element Id Patient.deceased[x] Short description Indicates if the individual is deceased or not Definition Indicates if the individual is deceased or not. Requirements The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive. Comments If there's no value in the instance, it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive. Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:PID-30 (bool) and PID-29 (datetime) rim:player[classCode=PSN\|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN\|ANM and determinerCode=INSTANCE]/deceasedTime cda:n/a
deceasedBoolean			boolean	There are no (further) constraints on this element Data Type boolean
deceasedDateTime			dateTime	There are no (further) constraints on this element Data Type dateTime
address	Σ I	0..*	Address	Element Id Patient.address Short description An address for the individual Definition An address for the individual. Requirements May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification. Comments IPS-UV flags this as a MS element. It is not currently flagged as MS in PS-CA, as stakeholders have indicated the element may not be supported by the majority of systems today. Systems that do support the element are encouraged to include it in generated Patient Summary documents, and support it when received. Vendors should expect that some jurisdictions may add a MS requirement within the context of their own jurisdictional content. Data Type Address Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` pat-cnt-2or3-char:The content of the country element (if present) SHALL be selected EITHER from ValueSet ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2 OR MAY be selected from ISO Country Alpha-3 Value Set http://hl7.org/fhir/ValueSet/iso3166-1-3, IF the country is not specified in value Set ISO Country Alpha-2 http://hl7.org/fhir/ValueSet/iso3166-1-2. `country.empty() or (country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-2') or country.memberOf('http://hl7.org/fhir/ValueSet/iso3166-1-3'))` Mappings rim:n/a v2:XAD rim:AD servd:Address v2:PID-11 rim:addr cda:.addr
maritalStatus		0..1	CodeableConceptBinding	There are no (further) constraints on this element Element Id Patient.maritalStatus Short description Marital (civil) status of a patient Definition This field contains a patient's most recent marital (civil) status. Requirements Most, if not all systems capture it. Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Data Type CodeableConcept Binding The domestic partnership status of a person. Marital Status Codes (extensible) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD v2:PID-16 rim:player[classCode=PSN]/maritalStatusCode cda:.patient.maritalStatusCode
multipleBirth[x]		0..1		There are no (further) constraints on this element Element Id Patient.multipleBirth[x] Short description Whether patient is part of a multiple birth Definition Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer). Requirements For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs. Comments Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated). Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:PID-24 (bool), PID-25 (integer) rim:player[classCode=PSN\|ANM and determinerCode=INSTANCE]/multipleBirthInd, player[classCode=PSN\|ANM and determinerCode=INSTANCE]/multipleBirthOrderNumber cda:n/a
multipleBirthBoolean			boolean	There are no (further) constraints on this element Data Type boolean
multipleBirthInteger			integer	There are no (further) constraints on this element Data Type integer
photo	I	0..*	Attachment	There are no (further) constraints on this element Element Id Patient.photo Short description Image of the patient Definition Image of the patient. Requirements Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too. Comments Guidelines: Use id photos, not clinical photos. Limit dimensions to thumbnail. Keep byte count low to ease resource updates. Data Type Attachment Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` att-1:If the Attachment has data, it SHALL have a contentType `data.empty() or contentType.exists()` Mappings rim:n/a v2:ED/RP rim:ED v2:OBX-5 - needs a profile rim:player[classCode=PSN\|ANM and determinerCode=INSTANCE]/desc cda:n/a
contact	I	0..*	BackboneElement	Element Id Patient.contact Short description A contact party (e.g. guardian, partner, friend) for the patient Definition A contact party (e.g. guardian, partner, friend) for the patient. Requirements Need to track people you can contact about the patient. Comments IPS-UV flags this as a MS element. It is not currently flagged as MS in PS-CA, as stakeholders have indicated the element may not be supported by the majority of systems today. Systems that do support the element are encouraged to include it in generated Patient Summary documents, and support it when received. Vendors should expect that some jurisdictions may add a MS requirement within the context of their own jurisdictional content. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` pat-1: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()` Mappings rim:n/a rim:player[classCode=PSN\|ANM and determinerCode=INSTANCE]/scopedRole[classCode=CON] cda:n/a
relationship		0..*	CodeableConceptBinding	Element Id Patient.contact.relationship Short description The kind of relationship Definition The nature of the relationship between the patient and the contact person. Requirements Used to determine which contact person is the most relevant to approach, depending on circumstances. Comments IPS-UV flags this as a MS element. It is not currently flagged as MS in PS-CA, as stakeholders have indicated the element may not be supported by the majority of systems today. Systems that do support the element are encouraged to include it in generated Patient Summary documents, and support it when received. Vendors should expect that some jurisdictions may add a MS requirement within the context of their own jurisdictional content. Data Type CodeableConcept Binding The nature of the relationship between a patient and a contact person for that patient. PersonalRelationshipUvIps (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD v2:NK1-7, NK1-3 rim:code cda:n/a
name		0..1	HumanName	There are no (further) constraints on this element Element Id Patient.contact.name Short description A name associated with the contact person Definition A name associated with the contact person. Requirements Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person. Comments Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts might or might not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely. Data Type HumanName Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XPN rim:EN (actually, PN) servd:ProviderName v2:NK1-2 rim:name cda:n/a
telecom	I	0..*	ContactPoint	Element Id Patient.contact.telecom Short description A contact detail for the person Definition A contact detail for the person, e.g. a telephone number or an email address. Requirements People have (primary) ways to contact them in some way such as phone, email. Comments IPS-UV flags this as a MS element. It is not currently flagged as MS in PS-CA, as stakeholders have indicated the element may not be supported by the majority of systems today. Systems that do support the element are encouraged to include it in generated Patient Summary documents, and support it when received. Vendors should expect that some jurisdictions may add a MS requirement within the context of their own jurisdictional content. Data Type ContactPoint Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` cpt-2:A system is required if a value is provided. `value.empty() or system.exists()` Mappings rim:n/a v2:XTN rim:TEL servd:ContactPoint v2:NK1-5, NK1-6, NK1-40 rim:telecom cda:n/a
address		0..1	Address	Element Id Patient.contact.address Short description Address for the contact person Definition Address for the contact person. Requirements Need to keep track where the contact person can be contacted per postal mail or visited. Comments IPS-UV flags this as a MS element. It is not currently flagged as MS in PS-CA, as stakeholders have indicated the element may not be supported by the majority of systems today. Systems that do support the element are encouraged to include it in generated Patient Summary documents, and support it when received. Vendors should expect that some jurisdictions may add a MS requirement within the context of their own jurisdictional content. Data Type Address Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:XAD rim:AD servd:Address v2:NK1-4 rim:addr cda:n/a
gender		0..1	codeBinding	There are no (further) constraints on this element Element Id Patient.contact.gender Short description male \| female \| other \| unknown Definition Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes. Requirements Needed to address the person correctly. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Binding The gender of a person used for administrative purposes. AdministrativeGender (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:NK1-15 rim:player[classCode=PSN\|ANM and determinerCode=INSTANCE]/administrativeGender cda:n/a
organization	I	0..1	Reference(Organization)	Element Id Patient.contact.organization Short description Organization that is associated with the contact Definition Organization on behalf of which the contact is acting or for which the contact is working. Requirements For guardians or business related contacts, the organization is relevant. Comments IPS-UV flags this as a MS element. It is not currently flagged as MS in PS-CA, as stakeholders have indicated the element may not be supported by the majority of systems today. Systems that do support the element are encouraged to include it in generated Patient Summary documents, and support it when received. Vendors should expect that some jurisdictions may add a MS requirement within the context of their own jurisdictional content. Data Type Reference(Organization) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) v2:NK1-13, NK1-30, NK1-31, NK1-32, NK1-41 rim:scoper cda:n/a
period	I	0..1	Period	There are no (further) constraints on this element Element Id Patient.contact.period Short description The period during which this contact person or organization is valid to be contacted relating to this patient Definition The period during which this contact person or organization is valid to be contacted relating to this patient. Comments A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. Data Type Period Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` per-1:If present, start SHALL have a lower value than end `start.hasValue().not() or end.hasValue().not() or (start <= end)` Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] rim:effectiveTime cda:n/a
communication		0..*	BackboneElement	Element Id Patient.communication Short description A language which may be used to communicate with the patient about his or her health Definition A language which may be used to communicate with the patient about his or her health. Requirements If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency are important things to keep track of both for patient and other persons of interest. Comments IPS-UV flags this as a MS element. It is not currently flagged as MS in PS-CA, as stakeholders have indicated the element may not be supported by the majority of systems today. Systems that do support the element are encouraged to include it in generated Patient Summary documents, and support it when received. Vendors should expect that some jurisdictions may add a MS requirement within the context of their own jurisdictional content. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:LanguageCommunication cda:patient.languageCommunication
language		1..1	CodeableConceptBinding	Element Id Patient.communication.language Short description The language which can be used to communicate with the patient about his or her health Definition The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" for England English. Requirements Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect. Comments IPS-UV flags this as a MS element. It is not currently flagged as MS in PS-CA, as stakeholders have indicated the element may not be supported by the majority of systems today. Systems that do support the element are encouraged to include it in generated Patient Summary documents, and support it when received. Vendors should expect that some jurisdictions may add a MS requirement within the context of their own jurisdictional content. Data Type CodeableConcept Binding A human language. AllLanguages (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD v2:PID-15, LAN-2 rim:player[classCode=PSN\|ANM and determinerCode=INSTANCE]/languageCommunication/code cda:.languageCode
preferred		0..1	boolean	There are no (further) constraints on this element Element Id Patient.communication.preferred Short description Language preference indicator Definition Indicates whether or not the patient prefers this language (over other languages he masters up a certain level). Requirements People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method. Comments This language is specifically identified for communicating healthcare information. Data Type boolean Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a v2:PID-15 rim:preferenceInd cda:.preferenceInd
generalPractitioner	I	0..*	Reference(Organization \| Practitioner \| PractitionerRole)	Element Id Patient.generalPractitioner Short description Patient's nominated primary care provider Alternate names careProvider Definition Patient's nominated care provider. Comments IPS-UV flags this as a MS element. It is not currently flagged as MS in PS-CA, as stakeholders have indicated the element may not be supported by the majority of systems today. Systems that do support the element are encouraged to include it in generated Patient Summary documents, and support it when received. Vendors should expect that some jurisdictions may add a MS requirement within the context of their own jurisdictional content. Data Type Reference(Organization \| Practitioner \| PractitionerRole) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) v2:PD1-4 rim:subjectOf.CareEvent.performer.AssignedEntity cda:n/a
managingOrganization	Σ I	0..1	Reference(Organization)	There are no (further) constraints on this element Element Id Patient.managingOrganization Short description Organization that is the custodian of the patient record Definition Organization that is the custodian of the patient record. Requirements Need to know who recognizes this patient record, manages and updates it. Comments There is only one managing organization for a specific patient record. Other organizations will have their own Patient record, and may use the Link property to join the records together (or a Person resource which can include confidence ratings for the association). Data Type Reference(Organization) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) rim:scoper cda:.providerOrganization
link	Σ ?!	0..*	BackboneElement	There are no (further) constraints on this element Element Id Patient.link Short description Link to another patient resource that concerns the same actual person Definition Link to another patient resource that concerns the same actual patient. Requirements There are multiple use cases: Duplicate patient records due to the clerical errors associated with the difficulties of identifying humans consistently, and Distribution of patient information across multiple servers. Comments There is no assumption that linked patient records have mutual links. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:outboundLink cda:n/a
other	Σ I	1..1	Reference(Patient \| RelatedPerson)	There are no (further) constraints on this element Element Id Patient.link.other Short description The other patient or related person resource that the link refers to Definition The other patient resource that the link refers to. Comments Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual. Data Type Reference(Patient \| RelatedPerson) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) v2:PID-3, MRG-1 rim:id cda:n/a
type	Σ	1..1	codeBinding	There are no (further) constraints on this element Element Id Patient.link.type Short description replaced-by \| replaces \| refer \| seealso Definition The type of link between this patient resource and another patient resource. Comments Note that FHIR strings SHALL NOT exceed 1MB in size Data Type code Binding The type of link between this patient resource and another patient resource. LinkType (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim:n/a rim:typeCode cda:n/a

Extensions

This profile uses the following extensions:

Patient.identifier: identifier-version

Key Differences between the IPS-UV and PS-CA

Must Support Differences:

The following elements are considered "must support" in the IPS-UV specification that are relaxed in this version of the PS-CA profile:

Patient.telecom
Patient.address
Patient.contact (e.g., next of kin) and sub-elements
Patient.communication.language
Patient.generalPractitioner

Note: Systems that support these elements are encouraged to send them in patient summaries

Cardinality Differences:

There are no cardinality differences between this profile and IPS-UV

Vocabulary Differences:

Patient.identifier: slices added for Canadian identifier types

Other differences between the IPS and PS-CA Include:

Patient.name.text: comment added
Patient.contact.relationship: removal of IPS datatype profile