Patient (CA-Core)
Additional information on this profile (including the JSON & XML structure and detailed element descriptions) can be found at package/structuredefinition-patient-ca-core.json
This profile imposes the CA Baseline (v1.1.7) Patient Profile.
Profile
Patient | I | Patient | There are no (further) constraints on this element Element idPatient Information about an individual or animal receiving health care services Alternate namesSubjectOfCare Client Resident DefinitionDemographics and other administrative information about an individual or animal receiving care or other health-related services.
| |
id | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idPatient.meta Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
|
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idPatient.implicitRules A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
|
language | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.language Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
| |
text | 0..1 | Narrative | There are no (further) constraints on this element Element idPatient.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
| |
contained | 0..* | Resource | There are no (further) constraints on this element Element idPatient.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
individual-recordedSexOrGender | I | 0..* | Extension(Complex) | Element idPatient.extension:individual-recordedSexOrGender Extension for representing Recorded sex or gender (RSG) information. Alternate namesextensions, user content DefinitionRecorded sex or gender (RSG) information includes the various sex and gender concepts that are often used in existing systems but are known NOT to represent a gender identity, sex parameter for clinical use, or attributes related to sexuality, such as sexual orientation, sexual activity, or sexual attraction. Examples of recorded sex or gender concepts include administrative gender, administrative sex, and sex assigned at birth. When exchanging this concept, refer to the guidance in the Gender Harmony Implementation Guide. This extension has been re-profiled by the CA Core+ project for use in Canada. It currently provides the mapping details to the pan-Canadian Health Data Content Framework (pCHDCF) concept 'Recorded Sex or Gender'. This pCHDCF concept is still under development and as such does not have further constraints or terminology recommendations at the time of this release Extension(Complex) Extension URLhttp://fhir.infoway-inforoute.ca/ca-core/StructureDefinition/individual-recordedSexOrGender-ca-core Constraints
|
individual-pronouns | I | 0..* | Extension(Complex) | Element idPatient.extension:individual-pronouns Extension for representing the pronouns to use when referring to an individual in verbal or written communication. Alternate namesextensions, user content DefinitionThe pronouns to use when referring to an individual in verbal or written communication. This extension has been re-profiled by the CA Core+ project for use in Canada. It currently provides the mapping details to the pan-Canadian Health Data Content Framework (pCHDCF) concept 'Pronouns'. This pCHDCF concept is still under development and as such does not have further constraints or terminology recommendations at the time of this release Extension(Complex) Extension URLhttp://fhir.infoway-inforoute.ca/ca-core/StructureDefinition/individual-pronouns-ca-core Constraints
|
modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
identifier | Σ | 0..* | Identifier | There are no (further) constraints on this element Element idPatient.identifier An identifier for this patient DefinitionAn identifier for this patient. Patients are almost always assigned specific numerical identifiers.
|
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.identifier.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.identifier.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.identifier.use usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known .
|
type | Σ | 0..1 | CodeableConceptBinding | Element idPatient.identifier.type Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. 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. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Jurisdictional Health Number { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0203", "code": "JHN" } ] } Medical Record Number { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0203", "code": "MR" } ] } Passport Number { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0203", "code": "PPN" } ] } National Unique Identifier (Placeholder Concept) { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0203", "code": "NH" } ] } Mappings
|
system | Σ | 0..1 | uri | Element idPatient.identifier.system The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. 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. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patient Mappings
|
value | Σ | 0..1 | string | Element idPatient.identifier.value The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. 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.
General 123456 Mappings
|
period | Σ I | 0..1 | Period | Element idPatient.identifier.period Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. 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.
|
assigner | Σ I | 0..1 | Reference(Organization) | Element idPatient.identifier.assigner Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. 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.
|
active | Σ ?! | 0..1 | boolean | Element idPatient.active Whether this patient's record is in active use DefinitionWhether 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. Need to be able to mark a patient record as not to be used because it was created in error. If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient. This resource is generally assumed to be active if no value is provided for the active element
|
name | Σ I | 0..* | HumanName | Element idPatient.name A name associated with the patient DefinitionA name associated with the individual. Need to be able to track the patient by multiple names. Examples are your official name and a partner name. 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. Unordered, Open, by use(Pattern) Constraints
|
(All Slices) | There are no (further) constraints on this element | |||
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.name.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.name.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
use | Σ ?! | 0..1 | codeBinding | Element idPatient.name.use usual | official | temp | nickname | anonymous | old | maiden DefinitionIdentifies the purpose for this name. Allows the appropriate name for a particular context of use to be selected from among a set of names. Applications can assume that a name is current unless it explicitly says that it is temporary or old. The use of a human name.
|
text | Σ | 0..1 | string | Element idPatient.name.text Text representation of the full name DefinitionText 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 A renderable, unencoded form. Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.
|
family | Σ | 0..1 | string | Element idPatient.name.family Family name (often called 'Surname') Alternate namessurname DefinitionThe 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. Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).
|
given | Σ | 0..* | string | Element idPatient.name.given Given names (not always 'first'). Includes middle names Alternate namesfirst name, middle name DefinitionGiven name. 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.
|
prefix | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.name.prefix Parts that come before the name DefinitionPart 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. Note that FHIR strings SHALL NOT exceed 1MB in size
|
suffix | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.name.suffix Parts that come after the name DefinitionPart 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. Note that FHIR strings SHALL NOT exceed 1MB in size
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idPatient.name.period Time period when name was/is in use DefinitionIndicates the period of time when this name was valid for the named person. Allows names to be placed in historical context. 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.
|
used | Σ | 0..* | HumanName | Element idPatient.name:used A name associated with the patient DefinitionA name associated with the individual. Need to be able to track the patient by multiple names. Examples are your official name and a partner name. 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.
|
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.name:used.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.name:used.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
use | Σ ?! | 0..1 | codeBindingFixed Value | Element idPatient.name:used.use usual | official | temp | nickname | anonymous | old | maiden DefinitionIdentifies the purpose for this name. Allows the appropriate name for a particular context of use to be selected from among a set of names. Applications can assume that a name is current unless it explicitly says that it is temporary or old. The use of a human name.
usual
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.name:used.text Text representation of the full name DefinitionSpecifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts. A renderable, unencoded form. Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.
|
family | Σ | 0..1 | string | Element idPatient.name:used.family Family name (often called 'Surname') Alternate namessurname DefinitionThe 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. Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).
|
given | Σ | 0..* | string | Element idPatient.name:used.given Given names (not always 'first'). Includes middle names Alternate namesfirst name, middle name DefinitionGiven name. 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.
|
prefix | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.name:used.prefix Parts that come before the name DefinitionPart 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. Note that FHIR strings SHALL NOT exceed 1MB in size
|
suffix | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.name:used.suffix Parts that come after the name DefinitionPart 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. Note that FHIR strings SHALL NOT exceed 1MB in size
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idPatient.name:used.period Time period when name was/is in use DefinitionIndicates the period of time when this name was valid for the named person. Allows names to be placed in historical context. 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.
|
previous | Σ | 0..* | HumanName | Element idPatient.name:previous A name associated with the patient DefinitionA name associated with the individual. Need to be able to track the patient by multiple names. Examples are your official name and a partner name. 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.
|
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.name:previous.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.name:previous.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
use | Σ ?! | 0..1 | codeBindingFixed Value | Element idPatient.name:previous.use usual | official | temp | nickname | anonymous | old | maiden DefinitionIdentifies the purpose for this name. Allows the appropriate name for a particular context of use to be selected from among a set of names. Applications can assume that a name is current unless it explicitly says that it is temporary or old. The use of a human name.
old
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.name:previous.text Text representation of the full name DefinitionSpecifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts. A renderable, unencoded form. Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.
|
family | Σ | 0..1 | string | Element idPatient.name:previous.family Family name (often called 'Surname') Alternate namessurname DefinitionThe 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. Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).
|
given | Σ | 0..* | string | Element idPatient.name:previous.given Given names (not always 'first'). Includes middle names Alternate namesfirst name, middle name DefinitionGiven name. 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.
|
prefix | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.name:previous.prefix Parts that come before the name DefinitionPart 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. Note that FHIR strings SHALL NOT exceed 1MB in size
|
suffix | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.name:previous.suffix Parts that come after the name DefinitionPart 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. Note that FHIR strings SHALL NOT exceed 1MB in size
|
period | Σ I | 0..1 | Period | Element idPatient.name:previous.period Time period when name was/is in use DefinitionIndicates the period of time when this name was valid for the named person. Allows names to be placed in historical context. 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.
|
telecom | Σ I | 0..* | ContactPoint | There are no (further) constraints on this element Element idPatient.telecom A contact detail for the individual DefinitionA contact detail (e.g. a telephone number or an email address) by which the individual may be contacted. People have (primary) ways to contact them in some way such as phone, email. A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address might not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).
|
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.telecom.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.telecom.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
system | Σ I | 0..1 | codeBinding | Element idPatient.telecom.system phone | fax | email | pager | url | sms | other DefinitionTelecommunications form for contact point - what communications system is required to make use of the contact. Note that FHIR strings SHALL NOT exceed 1MB in size Telecommunications form for contact point.
|
value | Σ | 0..1 | string | Element idPatient.telecom.value The actual contact point details DefinitionThe actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). Need to support legacy numbers that are not in a tightly controlled format. Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
|
use | Σ ?! | 0..1 | codeBinding | Element idPatient.telecom.use home | work | temp | old | mobile - purpose of this contact point DefinitionIdentifies the purpose for the contact point. Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. Applications can assume that a contact is current unless it explicitly says that it is temporary or old. Use of contact point.
|
rank | Σ | 0..1 | positiveInt | Element idPatient.telecom.rank Specify preferred order of use (1 = highest) DefinitionSpecifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values. Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
|
period | Σ I | 0..1 | Period | Element idPatient.telecom.period Time period when the contact point was/is in use DefinitionTime period when the contact point was/is in use. 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.
|
gender | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.gender male | female | other | unknown DefinitionAdministrative Gender - the gender that the patient is considered to have for administration and record keeping purposes. Needed for identification of the individual, in combination with (at least) name and birth date. 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. The gender of a person used for administrative purposes.
|
birthDate | Σ | 0..1 | date | Element idPatient.birthDate The date of birth for the individual DefinitionThe date of birth for the individual. Age of the individual drives many clinical processes. 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).
|
deceased[x] | Σ ?! | 0..1 | Element idPatient.deceased[x] Indicates if the individual is deceased or not DefinitionIndicates if the individual is deceased or not. 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. 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. Unordered, Open, by $this(Type) Constraints
| |
deceasedBoolean | boolean | There are no (further) constraints on this element Data type | ||
deceasedDateTime | Σ ?! | 0..1 | dateTime | Element idPatient.deceased[x]:deceasedDateTime Indicates if the individual is deceased or not DefinitionIndicates if the individual is deceased or not. 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. 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.
|
address | Σ | 0..* | Address | There are no (further) constraints on this element Element idPatient.address An address for the individual DefinitionAn address for the individual. May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification. Patient may have multiple addresses with different uses or applicable periods.
|
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | Element idPatient.address.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
no-fixed-address | I | 0..1 | Extension(Complex) | Element idPatient.address.extension:no-fixed-address No fixed address indicator Alternate namesextensions, user content DefinitionThis extension applies to the Address data type and is used to indicate that a location address is not a fixed address for an individual. This extension has been re-profiled by the CA Core+ project for use in Canada. It currently provides the mapping details to the pan-Canadian Health Data Content Framework (pCHDCF) concept 'Person No Fixed Address Flag'. This pCHDCF concept is still under development and as such does not have further constraints at the time of this release Extension(Complex) Extension URLhttp://fhir.infoway-inforoute.ca/ca-core/StructureDefinition/no-fixed-address-ca-core Constraints
|
use | Σ ?! | 0..1 | codeBinding | Element idPatient.address.use home | work | temp | old | billing - purpose of this address DefinitionThe purpose of this address. Allows an appropriate address to be chosen from a list of many. Applications can assume that an address is current unless it explicitly says that it is temporary or old. The use of an address.
General home Mappings
|
type | Σ | 0..1 | codeBinding | Element idPatient.address.type postal | physical | both DefinitionDistinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource). The type of an address (physical / postal).
General both Mappings
|
text | Σ | 0..1 | string | Element idPatient.address.text Text representation of the address DefinitionSpecifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts. A renderable, unencoded form. Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.
General 137 Nowhere Street, Erewhon 9132 Mappings
|
line | Σ | 0..* | string | Element idPatient.address.line Street name, number, direction & P.O. Box etc. DefinitionThis component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. Note that FHIR strings SHALL NOT exceed 1MB in size
General 137 Nowhere Street Mappings
|
city | Σ | 0..1 | string | Element idPatient.address.city Name of city, town etc. Alternate namesMunicpality DefinitionThe name of the city, town, suburb, village or other community or delivery center. Note that FHIR strings SHALL NOT exceed 1MB in size
General Erewhon Mappings
|
district | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.address.district District name (aka county) Alternate namesCounty DefinitionThe name of the administrative area (county). District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.
General Madison Mappings
|
state | Σ | 0..1 | string | Element idPatient.address.state Sub-unit of country (abbreviations ok) Alternate namesProvince, Territory DefinitionSub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes). Note that FHIR strings SHALL NOT exceed 1MB in size
|
postalCode | Σ | 0..1 | string | Element idPatient.address.postalCode Postal code for area Alternate namesZip DefinitionA postal code designating a region defined by the postal service. Note that FHIR strings SHALL NOT exceed 1MB in size
General 9132 Mappings
|
country | Σ | 0..1 | string | Element idPatient.address.country Country (e.g. can be ISO 3166 2 or 3 letter code) DefinitionCountry - a nation as commonly understood or generally accepted. ISO 3166 3 letter codes can be used in place of a human readable country name.
|
period | Σ I | 0..1 | Period | Element idPatient.address.period Time period when address was/is in use DefinitionTime period when address was/is in use. Allows addresses to be placed in historical context. 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.
General { "start": "2010-03-23", "end": "2010-07-01" } Mappings
|
maritalStatus | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.maritalStatus Marital (civil) status of a patient DefinitionThis field contains a patient's most recent marital (civil) status. Most, if not all systems capture it. 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. The domestic partnership status of a person.
| |
multipleBirth[x] | 0..1 | There are no (further) constraints on this element Element idPatient.multipleBirth[x] Whether patient is part of a multiple birth DefinitionIndicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer). For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs. 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).
| ||
multipleBirthBoolean | boolean | There are no (further) constraints on this element Data type | ||
multipleBirthInteger | integer | There are no (further) constraints on this element Data type | ||
photo | I | 0..* | Attachment | There are no (further) constraints on this element Element idPatient.photo Image of the patient DefinitionImage of the patient. Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too. Guidelines:
|
contact | I | 0..* | BackboneElement | There are no (further) constraints on this element Element idPatient.contact A contact party (e.g. guardian, partner, friend) for the patient DefinitionA contact party (e.g. guardian, partner, friend) for the patient. Need to track people you can contact about the patient. Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact.
|
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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.
|
relationship | 0..* | CodeableConceptBinding | Element idPatient.contact.relationship The kind of relationship DefinitionThe nature of the relationship between the patient and the contact person. Used to determine which contact person is the most relevant to approach, depending on circumstances. Reviewers should be aware that the modelling and terminology for contact.relationship is changing in R6 and that this profile may seek to pre-adopt the changes in order to accommodate better implementation against the pCHDCF concepts for relationship type and role. In the meantime, implementers may continue to provide both role (e.g., emergency contact) and type (e.g., mother) as repetitions on the relationship element which is a CodeableConcept element with 0..* cardinality The nature of the relationship between a patient and a contact person for that patient.
| |
name | 0..1 | HumanName | There are no (further) constraints on this element Element idPatient.contact.name A name associated with the contact person DefinitionA name associated with the contact person. Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person. 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.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.name.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.name.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
use | Σ ?! | 0..1 | codeBinding | Element idPatient.contact.name.use usual | official | temp | nickname | anonymous | old | maiden DefinitionIdentifies the purpose for this name. Allows the appropriate name for a particular context of use to be selected from among a set of names. Applications can assume that a name is current unless it explicitly says that it is temporary or old. The use of a human name.
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.name.text Text representation of the full name DefinitionSpecifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts. A renderable, unencoded form. Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.
|
family | Σ | 0..1 | string | Element idPatient.contact.name.family Family name (often called 'Surname') Alternate namessurname DefinitionThe 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. Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).
|
given | Σ | 0..* | string | Element idPatient.contact.name.given Given names (not always 'first'). Includes middle names Alternate namesfirst name, middle name DefinitionGiven name. 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.
|
prefix | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.contact.name.prefix Parts that come before the name DefinitionPart 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. Note that FHIR strings SHALL NOT exceed 1MB in size
|
suffix | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient.contact.name.suffix Parts that come after the name DefinitionPart 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. Note that FHIR strings SHALL NOT exceed 1MB in size
|
period | Σ I | 0..1 | Period | There are no (further) constraints on this element Element idPatient.contact.name.period Time period when name was/is in use DefinitionIndicates the period of time when this name was valid for the named person. Allows names to be placed in historical context. 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.
|
telecom | I | 0..* | ContactPoint | There are no (further) constraints on this element Element idPatient.contact.telecom A contact detail for the person DefinitionA contact detail for the person, e.g. a telephone number or an email address. People have (primary) ways to contact them in some way such as phone, email. Contact may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification.
|
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.telecom.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.telecom.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
system | Σ I | 0..1 | codeBinding | Element idPatient.contact.telecom.system phone | fax | email | pager | url | sms | other DefinitionTelecommunications form for contact point - what communications system is required to make use of the contact. Note that FHIR strings SHALL NOT exceed 1MB in size Telecommunications form for contact point.
|
value | Σ | 0..1 | string | Element idPatient.contact.telecom.value The actual contact point details DefinitionThe actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). Need to support legacy numbers that are not in a tightly controlled format. Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.
|
use | Σ ?! | 0..1 | codeBinding | Element idPatient.contact.telecom.use home | work | temp | old | mobile - purpose of this contact point DefinitionIdentifies the purpose for the contact point. Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. Applications can assume that a contact is current unless it explicitly says that it is temporary or old. Use of contact point.
|
rank | Σ | 0..1 | positiveInt | Element idPatient.contact.telecom.rank Specify preferred order of use (1 = highest) DefinitionSpecifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values. Note that rank does not necessarily follow the order in which the contacts are represented in the instance.
|
period | Σ I | 0..1 | Period | Element idPatient.contact.telecom.period Time period when the contact point was/is in use DefinitionTime period when the contact point was/is in use. 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.
|
address | 0..1 | Address | There are no (further) constraints on this element Element idPatient.contact.address Address for the contact person DefinitionAddress for the contact person. Need to keep track where the contact person can be contacted per postal mail or visited. Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).
| |
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.address.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.contact.address.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
use | Σ ?! | 0..1 | codeBinding | Element idPatient.contact.address.use home | work | temp | old | billing - purpose of this address DefinitionThe purpose of this address. Allows an appropriate address to be chosen from a list of many. Applications can assume that an address is current unless it explicitly says that it is temporary or old. The use of an address.
General home Mappings
|
type | Σ | 0..1 | codeBinding | Element idPatient.contact.address.type postal | physical | both DefinitionDistinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource). The type of an address (physical / postal).
General both Mappings
|
text | Σ | 0..1 | string | Element idPatient.contact.address.text Text representation of the address DefinitionSpecifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts. A renderable, unencoded form. Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.
General 137 Nowhere Street, Erewhon 9132 Mappings
|
line | Σ | 0..* | string | Element idPatient.contact.address.line Street name, number, direction & P.O. Box etc. DefinitionThis component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. Note that FHIR strings SHALL NOT exceed 1MB in size
General 137 Nowhere Street Mappings
|
city | Σ | 0..1 | string | Element idPatient.contact.address.city Name of city, town etc. Alternate namesMunicpality DefinitionThe name of the city, town, suburb, village or other community or delivery center. Note that FHIR strings SHALL NOT exceed 1MB in size
General Erewhon Mappings
|
district | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient.contact.address.district District name (aka county) Alternate namesCounty DefinitionThe name of the administrative area (county). District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.
General Madison Mappings
|
state | Σ | 0..1 | string | Element idPatient.contact.address.state Sub-unit of country (abbreviations ok) Alternate namesProvince, Territory DefinitionSub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes). Note that FHIR strings SHALL NOT exceed 1MB in size
|
postalCode | Σ | 0..1 | string | Element idPatient.contact.address.postalCode Postal code for area Alternate namesZip DefinitionA postal code designating a region defined by the postal service. Note that FHIR strings SHALL NOT exceed 1MB in size
General 9132 Mappings
|
country | Σ | 0..1 | string | Element idPatient.contact.address.country Country (e.g. can be ISO 3166 2 or 3 letter code) DefinitionCountry - a nation as commonly understood or generally accepted. ISO 3166 3 letter codes can be used in place of a human readable country name.
|
period | Σ I | 0..1 | Period | Element idPatient.contact.address.period Time period when address was/is in use DefinitionTime period when address was/is in use. Allows addresses to be placed in historical context. 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.
General { "start": "2010-03-23", "end": "2010-07-01" } Mappings
|
gender | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient.contact.gender male | female | other | unknown DefinitionAdministrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes. Needed to address the person correctly. Note that FHIR strings SHALL NOT exceed 1MB in size The gender of a person used for administrative purposes.
| |
organization | I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idPatient.contact.organization Organization that is associated with the contact DefinitionOrganization on behalf of which the contact is acting or for which the contact is working. For guardians or business related contacts, the organization is relevant. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
period | I | 0..1 | Period | Element idPatient.contact.period The period during which this contact person or organization is valid to be contacted relating to this patient DefinitionThe period during which this contact person or organization is valid to be contacted relating to this patient. 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.
|
communication | 0..* | BackboneElement | There are no (further) constraints on this element Element idPatient.communication A language which may be used to communicate with the patient about his or her health DefinitionA language which may be used to communicate with the patient about his or her health. 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. If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.
| |
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.communication.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.communication.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.communication.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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.
|
language | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient.communication.language The language which can be used to communicate with the patient about his or her health DefinitionThe 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. Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect. The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type. A human language.
| |
preferred | 0..1 | boolean | There are no (further) constraints on this element Element idPatient.communication.preferred Language preference indicator DefinitionIndicates whether or not the patient prefers this language (over other languages he masters up a certain level). 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. This language is specifically identified for communicating healthcare information.
| |
generalPractitioner | I | 0..* | Reference(package/structuredefinition-practitioner-ca-core.json | package/structuredefinition-practitionerrole-ca-core.json | Practitioner | PractitionerRole | Organization) | Element idPatient.generalPractitioner Patient's nominated primary care provider Alternate namescareProvider DefinitionPatient's nominated care provider. This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disability setting, or even organization that will provide people to perform the care provider roles. It is not to be used to record Care Teams, these should be in a CareTeam resource that may be linked to the CarePlan or EpisodeOfCare resources. Multiple GPs may be recorded against the patient for various reasons, such as a student that has his home GP listed along with the GP at university during the school semesters, or a "fly-in/fly-out" worker that has the onsite GP also included with his home GP to remain aware of medical issues. Jurisdictions may decide that they can profile this down to 1 if desired, or 1 per type. Reference(package/structuredefinition-practitioner-ca-core.json | package/structuredefinition-practitionerrole-ca-core.json | Practitioner | PractitionerRole | Organization) Constraints
|
managingOrganization | Σ I | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idPatient.managingOrganization Organization that is the custodian of the patient record DefinitionOrganization that is the custodian of the patient record. Need to know who recognizes this patient record, manages and updates it. 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).
|
link | Σ ?! | 0..* | BackboneElement | There are no (further) constraints on this element Element idPatient.link Link to another patient resource that concerns the same actual person DefinitionLink to another patient resource that concerns the same actual patient. There are multiple use cases:
There is no assumption that linked patient records have mutual links.
|
id | 0..1 | string | There are no (further) constraints on this element Element idPatient.link.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
extension | I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.link.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idPatient.link.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. 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.
|
other | Σ I | 1..1 | Reference(Patient | RelatedPerson) | There are no (further) constraints on this element Element idPatient.link.other The other patient or related person resource that the link refers to DefinitionThe other patient resource that the link refers to. Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual. Reference(Patient | RelatedPerson) Constraints
|
type | Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element idPatient.link.type replaced-by | replaces | refer | seealso DefinitionThe type of link between this patient resource and another patient resource. Note that FHIR strings SHALL NOT exceed 1MB in size The type of link between this patient resource and another patient resource.
|
Obligations
Obligations are a new (and evolving) mechanism in FHIR to provide a consistent and machine processable way for profiles to define their expectations for system behaviors.
Earlier versions of the profiles exposed an initial set of obligations to garner feedback from the community on their use in Core+ profiles.
Obligations have been temporarily removed in this version to allow for further refinement of the approach against the Core Data for Interoperability (CACDI), which is now in development.
Terminology
This version of the guide is based on the early content development of the pan-Canadian Health Data Content Framework (pCHDCF). The pCHDCF is beginning to introduce recommended terminology for select concepts.
Terminology for CA Core+ Patient Profile has not been implemented in this release.
Mappings to pCHDCF
Draft Data Content Standard Element (As of 2024-06-18) | Draft Data Content Standard Element Definition (As of 2024-06-18) | FHIR Profile Element | Additional Notes |
---|---|---|---|
Person Identifier Type | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. | Patient.identifier.type | This mapping was updated from identifier.use in prior releases after example values were provided. |
Person Identifier Value | The alphanumeric value and/or number of the health identifier (e.g., medical record number, jurisdictional health number). | Patient.identifier.value | |
Person Identifier System | The namespace for the identifier value – a URI that describes a set value that are unique. | Patient.identifier.system | |
Patient Identifier Assigner | Represents the legal entity/ organization responsible for assigning the Person Identifier. | Patient.identifier.assigner | |
Person Identifier Period | The start and end date (e.g., expiry date) for the unique identifier. | Patient.identifier.period | |
Person Active Status | Indicates whether the person’s record is in active use. | Patient.active | |
Name Type | Indicates the use of the person’s name, for example, whether it is their official name or nickname. | Patient.name.use | |
Surname | The person’s surname as indicated on their government issued identification (e.g., health card, driver’s license, passport). | Patient.name.family | |
Given Name | The person’s first name as indicated on their government issued identification (e.g., health card, driver’s license, passport). | Patient.name.given | |
Middle Name | The person’s middle name as indicated on their government issued identification (e.g., health card, driver’s license, passport). | Patient.name.given | |
Name Period | Indicates the period of time when this name was valid for the named person. | Patient.name.period | |
Name Used | The name specified by the person that should be used in context of healthcare, including nicknames, middle names, language specific alternatives (e.g., Bill, William, Guillaume, Guillermo), or names that affirm gender identity. **Note: Name used is an important element to cpature. When implemented Name used will be a name with name type=usual | Patient.name:used.given + Patient.name:used.family | The Patient.name:used slice pattern is proposed to express Given and Surname in the context of the Name Used concept. |
Previous Given Name | The first name by which the person formerly went by. | Patient.name:previous.given | The Patient.name:previous slice pattern is proposed to express Given and Surname in the context of the name that was previously used. |
Previous Surname | The last name by which the person formerly went by. | Patient.name:previous.family | The Patient.name:previous slice pattern is proposed to express Given and Surname in the context of the name that was previously used. |
Pronouns | Pronouns are linguistic tools used to refer to people instead of using their name, a noun or noun phrase, and gender pronouns are third-person pronouns that reference a person’s gender identity (e.g., he, she, they), and are a part of their gender expression. | Patient.extension:individual-pronouns | This concept is socialized to demonstrate mapping, terminology that aligns with international and pan-Canadian standards has been socialized in this release. Pronouns, while part of the GSSO standard, are captured under Person Information. |
Recorded Sex or Gender | Refers to gender related datum recorded shortly after birth, usually by a clinician, and usually indicated in a legal system and/or document, like a birth certificate or provincial registry. | Patient.extension:individual-recordedSexOrGender | This concept is socialized to demonstrate mapping, no further terminology or constraints have been identified in the release of the pCHDCF this profile is modelled from. |
Birth Date | The year, month and day on which the person was born. | Patient.birthDate | |
Date of Death | The date that the person passed away. | Patient.deceased[x]:deceasedDateTime | |
Person Address Street | The person's street address. | Patient.address.line | |
Person Address City | The person's city. | Patient.address.city | |
Person Address Province | The person's province/territory. | Patient.address.state | |
Person Address Postal Code | The person's postal code. | Patient.address.postalCode | |
Person Address Country | The person's country. | Patient.address.country | |
Person Address Use | The use for a given address, for example, home, work, temporary, old/incorrect. | Patient.address.use | |
Person Address Type | The type for a given address, for example, physical or postal, or both. | Patient.address.type | |
Person Address Period | The period of time in which the person’s address is in use. | Patient.address.period | |
Person No Fixed Address Flag | Indicates whether the person has no fixed address (i.e., experiencing houselessness, living in a shelter). | Patient.address.extension:no-fixed-address | |
Person Telecom Value | The actual value of the telecom (e.g., phone number or email address). | Patient.telecom.value | |
Person Telecom System | The type of telecom system (e.g., email, phone, etc.) | Patient.telecom.system | |
Person Telecom Use | Indicates whether the telecom value is a home number, work number, etc. | Patient.telecom.use | |
Person Telecom Rank | The order of priority for the telecom list (e.g., use home number first). | Patient.telecom.rank | |
Person Telecom Period | The period of time in which the person’s communication method is in use. | Patient.telecom.period | |
Contact Relationship Type | The contact’s relationship to the person, for example, emergency contact, mother, spouse, step-sibling. | Patient.contact.relationship | |
Contact Relationship Role | The contact's role within the circle of care, for example, next of kin, caregiver, emergency contact. | Patient.contact.relationship* | *Mapping to current available element, reviewers should be aware that the modelling and terminology for contact.relationship is changing and this mapping target may evolve with those changes (see https://jira.hl7.org/browse/FHIR-15841). |
Contact Given Name | The contact’s first name as indicated on their government issued identification (e.g., health card, driver’s license, passport). | Patient.contact.name.given | |
Contact Surname | The contact’s surname as indicated on their government issued identification (e.g., health card, driver’s license, passport). | Patient.contact.name.family | |
Contact Name Type | Indicates the use of the contact’s name, for example, whether it is their official name or nickname. | Patient.contact.name.use | |
Contact Telecom Value | The actual value of the telecom (e.g., phone number or email address). | Patient.contact.telecom.value | |
Contact Telecom System | The type of telecom system (e.g., email, phone, etc.) | Patient.contact.telecom.system | |
Contact Telecom Use | Indicates whether the telecom value is a home number, work number, etc. | Patient.contact.telecom.use | |
Contact Telecom Rank | The order of priority for the telecom list (e.g., use home number first). | Patient.contact.telecom.rank | |
Contact Telecom Period | The period of time in which the contact’s communication method is in use. | Patient.contact.telecom.period | |
Contact Address Street | The contact's street address. | Patient.contact.address.line | |
Contact Address City | The contact's city. | Patient.contact.address.city | |
Contact Address Province | The contact's province/territory. | Patient.contact.address.state | |
Contact Address Postal Code | The contact’s postal code. | Patient.contact.address.postalCode | |
Contact Address Country | The contact’s country. | Patient.contact.address.country | |
Contact Address Use | The use for the contact’s address for example, home, work, temporary, old/incorrect. | Patient.contact.address.use | |
Contact Address Type | The type for a given address, for example, physical or postal, or both. | Patient.contact.address.type | |
Contact Address Period | The period of time in which the contact’s address is in use. | Patient.contact.address.period | |
Contact Period | The period of time in which the contact is active. | Patient.contact.period | |
Most Responsible Provider Given Name | The most responsible provider’s first name. | Patient.generalPractitioner.name.given | Patient.generalPractitioner is used to link to these details housed in the practitioner resource. |
Most Responsible Provider Surname | The most responsible provider’s surname. | Patient.generalPractitioner.name.family | Patient.generalPractitioner is used to link to these details housed in the practitioner resource. |
Most Responsible Provider Status | Indicates the person's status to a regular primary health care provider where they receive ongoing care. | N/A | Expected to be housed outside of Patient Resource (e.g., CareTeam) |
Most Responsible Provider Period | The approximate date that the person started receiving ongoing care from their most responsible provider. | N/A | Expected to be housed outside of Patient Resource (e.g., CareTeam) |