Patient_CAbaseline
The FHIR resource Patient is based on Canadian baseline.
Patient_CAbaseline (Patient) | I | Patient | |
id | Σ | 1..1 | string |
meta | Σ | 1..1 | Meta |
id | 0..1 | string | |
extension | I | 0..* | Extension |
versionId | Σ | 0..1 | id |
lastUpdated | Σ | 0..1 | instant |
source | Σ | 0..1 | uri |
profile | Σ | 1..1 | canonical(StructureDefinition) |
security | Σ | 0..1 | CodingBinding |
tag | Σ | 0..1 | Coding |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
contained | 0..1 | Resource | |
extension | I | 0..* | Extension |
genderIdentityExtension | I | 0..* | Extension(CodeableConcept) |
modifierExtension | ?! I | 0..* | Extension |
identifier | Σ | 1..* | Identifier |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 1..1 | CodeableConceptBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | Σ | 1..* | Coding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | Σ | 0..1 | uriFixed Value |
version | Σ | 0..1 | string |
code | Σ | 0..1 | code |
display | Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
system | Σ | 1..1 | uri |
value | Σ | 1..1 | string |
period | Σ | 0..1 | Period |
assigner | Σ | 0..1 | Reference(Organization) |
active | Σ ?! | 1..1 | boolean |
name | Σ | 1..* | HumanName |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
text | Σ | 0..1 | string |
family | Σ | 1..1 | string |
given | Σ | 1..* | string |
prefix | Σ | 0..1 | string |
suffix | Σ | 0..1 | string |
period | Σ | 0..1 | Period |
telecom | Σ | 0..* | ContactPoint |
id | 0..0 | string | |
extension | I | 0..* | Extension |
system | Σ I | 0..1 | codeBinding |
value | Σ | 0..1 | string |
use | Σ ?! | 0..1 | codeBinding |
rank | Σ | 0..0 | positiveInt |
period | Σ | 0..1 | Period |
id | 0..0 | string | |
extension | I | 0..* | Extension |
start | Σ I | 0..1 | dateTime |
end | Σ I | 0..1 | dateTime |
gender | Σ | 1..1 | codeBinding |
id | 0..0 | string | |
extension | I | 0..* | Extension |
value | 0..1 | System.String | |
birthDate | Σ | 1..1 | date |
deceased[x] | Σ ?! | 0..1 | |
deceasedBoolean | boolean | ||
deceasedDateTime | dateTime | ||
address | Σ | 0..1 | Address |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | codeBinding |
text | Σ | 0..1 | string |
line | Σ | 0..* | string |
id | 0..1 | string | |
extension | I | 0..* | Extension |
_line | I | 0..1 | Extension(string) |
value | 0..1 | System.String | |
city | Σ | 0..1 | string |
district | Σ | 0..1 | string |
state | Σ | 0..1 | string |
postalCode | Σ | 0..1 | string |
country | Σ | 0..1 | string |
period | Σ | 0..1 | Period |
maritalStatus | 0..1 | CodeableConceptBinding | |
multipleBirth[x] | 0..1 | ||
multipleBirthBoolean | boolean | ||
multipleBirthInteger | integer | ||
photo | 0..1 | Attachment | |
contact | I | 0..1 | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
relationship | 0..* | CodeableConceptBinding | |
name | 0..1 | HumanName | |
telecom | 0..* | ContactPoint | |
address | 0..1 | Address | |
gender | 0..1 | codeBinding | |
organization | I | 0..1 | Reference(Organization) |
period | 0..1 | Period | |
communication | 0..1 | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
language | 1..1 | CodeableConceptBinding | |
preferred | 0..1 | boolean | |
generalPractitioner | 0..1 | Reference(Organization | Practitioner | PractitionerRole) | |
managingOrganization | Σ | 0..1 | Reference(Organization) |
link | Σ ?! | 0..1 | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
other | Σ | 1..1 | Reference(Patient | RelatedPerson) |
id | 0..0 | string | |
extension | I | 0..* | Extension |
reference | Σ I | 1..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | Σ | 0..1 | Identifier |
display | Σ | 0..1 | string |
type | Σ | 1..1 | codeBinding |
Patient | |
Definition | IFHIR resource applies for PIR Client |
Cardinality | 0...* |
Alias | SubjectOfCare Client Resident |
Invariants |
|
Mappings |
|
Patient.id | |
Definition | Unique Panorama Client ID |
Cardinality | 1...1 |
Type | string |
Summary | True |
Comments | See Mappings |
Mappings |
|
Patient.meta | |
Definition | The 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. |
Cardinality | 1...1 |
Type | Meta |
Summary | True |
Invariants |
|
Patient.meta.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Patient.meta.extension | |
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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Patient.meta.versionId | |
Definition | The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. |
Cardinality | 0...1 |
Type | id |
Summary | True |
Comments | Apply '2025.01.1' (This indicates the FHIR Specs changes on 2025 - Jan) |
Invariants |
|
Patient.meta.lastUpdated | |
Definition | When the resource last changed - e.g. when the version changed. |
Cardinality | 0...1 |
Type | instant |
Summary | True |
Comments | Updated: Relax the previously crossed-out elements. |
Invariants |
|
Patient.meta.source | |
Definition | A uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](provenance.html#) information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. |
Cardinality | 0...1 |
Type | uri |
Summary | True |
Comments | In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL. |
Invariants |
|
Patient.meta.profile | |
Definition | A list of profiles (references to [StructureDefinition](structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](structuredefinition-definitions.html#StructureDefinition.url). |
Cardinality | 1...1 |
Type | canonical(StructureDefinition) |
Summary | True |
Comments | Use 'http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/Patient' |
Invariants |
|
Patient.meta.security | |
Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. |
Cardinality | 0...1 |
Type | Coding |
Binding | Security Labels from the Healthcare Privacy and Security Classification System. |
Summary | True |
Comments | The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. |
Invariants |
|
Patient.meta.tag | |
Definition | Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. |
Cardinality | 0...1 |
Type | Coding |
Binding | Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
Summary | True |
Comments | The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. |
Invariants |
|
Patient.implicitRules | |
Definition | A 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. |
Cardinality | 0...1 |
Type | uri |
Modifier | True |
Summary | True |
Comments | 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. |
Invariants |
|
Patient.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. |
Comments | 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). |
Invariants |
|
Patient.text | |
Definition | A 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. |
Cardinality | 0...1 |
Type | Narrative |
Alias | narrative, html, xhtml, display |
Comments | 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. |
Invariants |
|
Mappings |
|
Patient.contained | |
Definition | These 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. |
Cardinality | 0...1 |
Type | Resource |
Alias | inline resources, anonymous resources, contained resources |
Comments | 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. |
Mappings |
|
Patient.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Patient.extension:genderIdentityExtension | |
Definition | Optional Extension Element - found in all resources. |
Cardinality | 0...* |
Type | Extension(CodeableConcept) |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Patient.modifierExtension | |
Definition | May 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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Alias | extensions, user content |
Requirements | 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. |
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. |
Invariants |
|
Mappings |
|
Patient.identifier | |
Definition | Different types of patient identifier which includes JHN (Jurisdictional Health Number e.g. BC PHN), PI (Patient Internal Identifier e.g. PIR Client ID, HAs' Internal Client ID). |
Cardinality | 1...* |
Type | Identifier |
Summary | True |
Requirements | Patients are almost always assigned specific numerical identifiers. |
Comments | Extract from PIR <client.human_subject> |
Invariants |
|
Mappings |
|
Patient.identifier.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Patient.identifier.extension | |
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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Patient.identifier.use | |
Definition | The purpose of this identifier. |
Cardinality | 0...1 |
Type | code |
Binding | Identifies the purpose for this identifier, if known . |
Modifier | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Patient.identifier.type | |
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
Cardinality | 1...1 |
Type | CodeableConcept |
Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Patient.identifier.type.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Patient.identifier.type.extension | |
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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Patient.identifier.type.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 1...* |
Type | Coding |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Invariants |
|
Mappings |
|
Patient.identifier.type.coding.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Patient.identifier.type.coding.extension | |
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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Patient.identifier.type.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 0...1 |
Type | uri |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | http://terminology.hl7.org/CodeSystem/v2-0203 |
Invariants |
|
Fixed Value | http://terminology.hl7.org/CodeSystem/v2-0203 |
Mappings |
|
Patient.identifier.type.coding.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Invariants |
|
Mappings |
|
Patient.identifier.type.coding.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Cardinality | 0...1 |
Type | code |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | See Mappings |
Invariants |
|
Mappings |
|
Patient.identifier.type.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Invariants |
|
Mappings |
|
Patient.identifier.type.coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Invariants |
|
Mappings |
|
Patient.identifier.type.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | See Mappings |
Invariants |
|
Mappings |
|
Patient.identifier.system | |
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. |
Cardinality | 1...1 |
Type | uri |
Summary | True |
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 | See Mappings below for appropriate URLs and URNs. |
Invariants |
|
Examples | General http://www.acme.com/identifiers/patient |
Mappings |
|
Patient.identifier.value | |
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
Cardinality | 1...1 |
Type | string |
Summary | True |
Comments | PIR Client ID: Extract from PIR (client.human_subject.subject_id); BC PHN or Yukon PHN: Extract from PIR (client.human_subject.health_card_number) |
Invariants |
|
Examples | General 123456 |
Mappings |
|
Patient.identifier.period | |
Definition | Time period during which identifier is/was valid for use. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Invariants |
|
Mappings |
|
Patient.identifier.assigner | |
Definition | Organization that issued/manages the identifier. |
Cardinality | 0...1 |
Type | Reference(Organization) |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Patient.active | |
Definition | It is used to filter patient lists to exclude inactive patients Inactive patient lists include inactive reasons in (Created in Error, Retruned to Birth Parent, Adopted, Soft Deleted, Deceased). |
Cardinality | 1...1 |
Type | boolean |
Modifier | True |
Summary | True |
Requirements | Need to be able to mark a patient record as not to be used because it was created in error. |
Comments | Hardcode as 'True' for all PIR active clients. |
Invariants |
|
Mappings |
|
Patient.name | |
Definition | PIR Client Lastname, Firstname, Middlename |
Cardinality | 1...* |
Type | HumanName |
Summary | True |
Requirements | Need to be able to track the patient by multiple names. Examples are your official name and a partner name. |
Comments | Extract from PIR <client.human_subject> |
Invariants |
|
Mappings |
|
Patient.name.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Patient.name.extension | |
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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Patient.name.use | |
Definition | Identifies the purpose for this name. |
Cardinality | 0...1 |
Type | code |
Binding | The use of a human name. |
Modifier | True |
Summary | True |
Requirements | Allows the appropriate name for a particular context of use to be selected from among a set of names. |
Comments | See Mappings |
Invariants |
|
Mappings |
|
Patient.name.text | |
Definition | Specifies 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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | A renderable, unencoded form. |
Comments | 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. |
Invariants |
|
Mappings |
|
Patient.name.family | |
Definition | Patient Family Name |
Cardinality | 1...1 |
Type | string |
Summary | True |
Alias | surname |
Comments | Patient Family Name |
Invariants |
|
Mappings |
|
Patient.name.given | |
Definition | Patient Given Names |
Cardinality | 1...* |
Type | string |
Summary | True |
Alias | first name, middle name |
Comments | Patient Given Names |
Invariants |
|
Mappings |
|
Patient.name.prefix | |
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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Invariants |
|
Mappings |
|
Patient.name.suffix | |
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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Invariants |
|
Mappings |
|
Patient.name.period | |
Definition | Indicates the period of time when this name was valid for the named person. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Requirements | Allows names to be placed in historical context. |
Invariants |
|
Mappings |
|
Patient.telecom | |
Definition | A contact detail (e.g. a telephone number or an email address) by which the PIR client may be contacted. |
Cardinality | 0...* |
Type | ContactPoint |
Summary | True |
Requirements | People have (primary) ways to contact them in some way such as phone, email. |
Comments | 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). |
Invariants |
|
Mappings |
|
Patient.telecom.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...0 |
Type | string |
Mappings |
|
Patient.telecom.extension | |
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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Patient.telecom.system | |
Definition | Telecommunications form for contact point - what communications system is required to make use of the contact. |
Cardinality | 0...1 |
Type | code |
Binding | Telecommunications form for contact point. |
Summary | True |
Comments | Use 'phone | email'. Extract the current phone or email from PIR, not the ones with 'Effective Date To' populated. |
Invariants |
|
Mappings |
|
Patient.telecom.value | |
Definition | Patient Phone Number or Email |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | Need to support legacy numbers that are not in a tightly controlled format. |
Comments | Patient Phone Number | Email |
Invariants |
|
Mappings |
|
Patient.telecom.use | |
Definition | Identifies the purpose for the contact point. |
Cardinality | 0...1 |
Type | code |
Binding | Use of contact point. |
Modifier | True |
Summary | True |
Requirements | Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. |
Comments | Use "home" | "work" |"mobile" (See Mappings). If not listed in the mappings, drop the attirubte USE, do not send. |
Invariants |
|
Mappings |
|
Patient.telecom.rank | |
Definition | Specifies 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. |
Cardinality | 0...0 |
Type | positiveInt |
Summary | True |
Comments | Note that rank does not necessarily follow the order in which the contacts are represented in the instance. |
Invariants |
|
Mappings |
|
Patient.telecom.period | |
Definition | Time period when the contact point was/is in use. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Invariants |
|
Mappings |
|
Patient.telecom.period.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...0 |
Type | string |
Mappings |
|
Patient.telecom.period.extension | |
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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Patient.telecom.period.start | |
Definition | The start of the period. The boundary is inclusive. |
Cardinality | 0...1 |
Type | dateTime |
Summary | True |
Comments | If the low element is missing, the meaning is that the low boundary is not known. |
Invariants |
|
Mappings |
|
Patient.telecom.period.end | |
Definition | The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. |
Cardinality | 0...1 |
Type | dateTime |
Summary | True |
Comments | The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03. |
Invariants |
|
Mappings |
|
Patient.gender | |
Definition | Patient Administrative Gender. PIR gender "Undifferentiate" is mapped to "unknown" in FHIR. |
Cardinality | 1...1 |
Type | code |
Binding | The gender of a person used for administrative purposes. |
Summary | True |
Requirements | Needed for identification of the individual, in combination with (at least) name and birth date. |
Comments | Patient Administrative Gender |
Invariants |
|
Mappings |
|
Patient.gender.id | |
Definition | unique id for the element within a resource (for internal references) |
Cardinality | 0...0 |
Type | string |
Patient.gender.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Invariants |
|
Patient.gender.value | |
Definition | Primitive value for code |
Cardinality | 0...1 |
Type | System.String |
Patient.birthDate | |
Definition | Patient Date of Birth |
Cardinality | 1...1 |
Type | date |
Summary | True |
Requirements | Age of the individual drives many clinical processes. |
Comments | Patient Date of Birth (yyyy-mm-dd) |
Invariants |
|
Mappings |
|
Patient.deceased[x] | |
Definition | Indicates if the individual is deceased or not. |
Cardinality | 0...1 |
Type | boolean |
Modifier | True |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Patient.address | |
Definition | An address for the individual. |
Cardinality | 0...1 |
Type | Address |
Summary | True |
Requirements | May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification. |
Comments | Extract the LATEST client address from PIR |
Invariants |
|
Mappings |
|
Patient.address.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Patient.address.extension | |
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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Patient.address.use | |
Definition | The purpose of this address: home | work |
Cardinality | 0...1 |
Type | code |
Binding | The use of an address. |
Modifier | True |
Summary | True |
Requirements | Allows an appropriate address to be chosen from a list of many. |
Comments | See Mappings |
Invariants |
|
Examples | General home |
Mappings |
|
Patient.address.type | |
Definition | Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. |
Cardinality | 0...1 |
Type | code |
Binding | The type of an address (physical / postal). |
Summary | True |
Comments | See Mappings. |
Invariants |
|
Examples | General both |
Mappings |
|
Patient.address.text | |
Definition | Specifies 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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | A renderable, unencoded form. |
Comments | 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. |
Invariants |
|
Examples | General 137 Nowhere Street, Erewhon 9132 |
Mappings |
|
Patient.address.line | |
Definition | This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. |
Cardinality | 0...* |
Type | string |
Summary | True |
Comments | Use address.line for international address |
Invariants |
|
Examples | General 137 Nowhere Street |
Mappings |
|
Patient.address.line.id | |
Definition | unique id for the element within a resource (for internal references) |
Cardinality | 0...1 |
Type | string |
Patient.address.line.extension | |
Definition | May 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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Patient.address.line.extension:_line | |
Definition | Optional Extension Element - found in all resources. |
Cardinality | 0...1 |
Type | Extension(string) |
Alias | extensions, user content |
Comments | See Mappings |
Invariants |
|
Mappings |
|
Patient.address.line.value | |
Definition | The actual value |
Cardinality | 0...1 |
Type | System.String |
Patient.address.city | |
Definition | The name of the city, town, suburb, village or other community or delivery center. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Alias | Municpality |
Invariants |
|
Examples | General Erewhon |
Mappings |
|
Patient.address.district | |
Definition | The name of the administrative area (county). |
Cardinality | 0...1 |
Type | string |
Summary | True |
Alias | County |
Comments | 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. |
Invariants |
|
Examples | General Madison |
Mappings |
|
Patient.address.state | |
Definition | Sub-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). |
Cardinality | 0...1 |
Type | string |
Summary | True |
Alias | Province, Territory |
Invariants |
|
Mappings |
|
Patient.address.postalCode | |
Definition | A postal code designating a region defined by the postal service. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Alias | Zip |
Invariants |
|
Examples | General 9132 |
Mappings |
|
Patient.address.country | |
Definition | Country - a nation as commonly understood or generally accepted. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | ISO 3166 3 letter codes can be used in place of a human readable country name. |
Invariants |
|
Mappings |
|
Patient.address.period | |
Definition | Time period when address was/is in use. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Requirements | Allows addresses to be placed in historical context. |
Invariants |
|
Examples | General { "start": "2010-03-23", "end": "2010-07-01" } |
Mappings |
|
Patient.maritalStatus | |
Definition | This field contains a patient's most recent marital (civil) status. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | The domestic partnership status of a person. |
Requirements | Most, if not all systems capture it. |
Invariants |
|
Mappings |
|
Patient.multipleBirth[x] | |
Definition | Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer). |
Cardinality | 0...1 |
Type | boolean |
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). |
Invariants |
|
Mappings |
|
Patient.photo | |
Definition | Image of the patient. |
Cardinality | 0...1 |
Type | Attachment |
Requirements | Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too. |
Comments | Guidelines:
|
Invariants |
|
Mappings |
|
Patient.contact | |
Definition | A contact party (e.g. guardian, partner, friend) for the patient. |
Cardinality | 0...1 |
Type | BackboneElement |
Requirements | Need to track people you can contact about the patient. |
Comments | 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. |
Invariants |
|
Mappings |
|
Patient.contact.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Patient.contact.extension | |
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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Patient.contact.modifierExtension | |
Definition | May 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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | 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. |
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. |
Invariants |
|
Mappings |
|
Patient.contact.relationship | |
Definition | The nature of the relationship between the patient and the contact person. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | The nature of the relationship between a patient and a contact person for that patient. |
Requirements | Used to determine which contact person is the most relevant to approach, depending on circumstances. |
Invariants |
|
Mappings |
|
Patient.contact.name | |
Definition | A name associated with the contact person. |
Cardinality | 0...1 |
Type | HumanName |
Requirements | Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person. |
Invariants |
|
Mappings |
|
Patient.contact.telecom | |
Definition | A contact detail for the person, e.g. a telephone number or an email address. |
Cardinality | 0...* |
Type | ContactPoint |
Requirements | People have (primary) ways to contact them in some way such as phone, email. |
Comments | 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. |
Invariants |
|
Mappings |
|
Patient.contact.address | |
Definition | Address for the contact person. |
Cardinality | 0...1 |
Type | Address |
Requirements | Need to keep track where the contact person can be contacted per postal mail or visited. |
Invariants |
|
Mappings |
|
Patient.contact.gender | |
Definition | Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes. |
Cardinality | 0...1 |
Type | code |
Binding | The gender of a person used for administrative purposes. |
Requirements | Needed to address the person correctly. |
Invariants |
|
Mappings |
|
Patient.contact.organization | |
Definition | Organization on behalf of which the contact is acting or for which the contact is working. |
Cardinality | 0...1 |
Type | Reference(Organization) |
Requirements | For guardians or business related contacts, the organization is relevant. |
Invariants |
|
Mappings |
|
Patient.contact.period | |
Definition | The period during which this contact person or organization is valid to be contacted relating to this patient. |
Cardinality | 0...1 |
Type | Period |
Invariants |
|
Mappings |
|
Patient.communication | |
Definition | A language which may be used to communicate with the patient about his or her health. |
Cardinality | 0...1 |
Type | BackboneElement |
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 | 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. |
Invariants |
|
Mappings |
|
Patient.communication.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Patient.communication.extension | |
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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Patient.communication.modifierExtension | |
Definition | May 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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | 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. |
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. |
Invariants |
|
Mappings |
|
Patient.communication.language | |
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. |
Cardinality | 1...1 |
Type | CodeableConcept |
Binding | A human language. |
Requirements | Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect. |
Comments | 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. |
Invariants |
|
Mappings |
|
Patient.communication.preferred | |
Definition | Indicates whether or not the patient prefers this language (over other languages he masters up a certain level). |
Cardinality | 0...1 |
Type | boolean |
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. |
Invariants |
|
Mappings |
|
Patient.generalPractitioner | |
Definition | Patient's nominated care provider. |
Cardinality | 0...1 |
Type | Reference(Organization | Practitioner | PractitionerRole) |
Alias | careProvider |
Comments | 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. |
Invariants |
|
Mappings |
|
Patient.managingOrganization | |
Definition | Organization that is the custodian of the patient record. |
Cardinality | 0...1 |
Type | Reference(Organization) |
Summary | True |
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). |
Invariants |
|
Mappings |
|
Patient.link | |
Definition | Link to another patient resource that concerns the same actual patient. |
Cardinality | 0...1 |
Type | BackboneElement |
Modifier | True |
Summary | True |
Requirements | There are multiple use cases:
|
Comments | There is no assumption that linked patient records have mutual links. |
Invariants |
|
Mappings |
|
Patient.link.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Patient.link.extension | |
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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Invariants |
|
Mappings |
|
Patient.link.modifierExtension | |
Definition | May 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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | 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. |
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. |
Invariants |
|
Mappings |
|
Patient.link.other | |
Definition | The other patient resource that the link refers to. |
Cardinality | 1...1 |
Type | Reference(Patient | RelatedPerson) |
Summary | True |
Comments | Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual. |
Invariants |
|
Mappings |
|
Patient.link.other.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...0 |
Type | string |
Mappings |
|
Patient.link.other.extension | |
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. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Patient.link.other.reference | |
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Cardinality | 1...1 |
Type | string |
Summary | True |
Comments | See Mappings |
Invariants |
|
Mappings |
|
Patient.link.other.type | |
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). |
Cardinality | 0...1 |
Type | uri |
Binding | Aa resource (or, for logical models, the URI of the logical model). |
Summary | True |
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. |
Invariants |
|
Mappings |
|
Patient.link.other.identifier | |
Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. |
Cardinality | 0...1 |
Type | Identifier |
Summary | True |
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). |
Invariants |
|
Mappings |
|
Patient.link.other.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
Invariants |
|
Mappings |
|
Patient.link.type | |
Definition | Use 'replaces' for resourcePatient as the survivor patient out of a merge. |
Cardinality | 1...1 |
Type | code |
Binding | The type of link between this patient resource and another patient resource. |
Summary | True |
Comments | "replaces" non-survivor patient id with survivor patient id. |
Invariants |
|
Mappings |
|
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="f68c0e19-c1e1-4a09-bb6a-9b071049522a" /> <meta> <versionId value="10" /> <lastUpdated value="2025-01-24T23:03:47.0556736+00:00" /> </meta> <url value="http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/Patient" /> <name value="Patient_CAbaseline" /> <status value="draft" /> <date value="2022-02-18T18:22:50.968212Z" /> <description value="Resource Patient is profiled based on Canadian Baseline" /> <fhirVersion value="4.0.1" /> <kind value="resource" /> <abstract value="false" /> <type value="Patient" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Patient" /> <derivation value="constraint" /> <differential> <element id="Patient"> <path value="Patient" /> <short value="IFHIR resource applies for PIR Client" /> <definition value="IFHIR resource applies for PIR Client" /> </element> <element id="Patient.id"> <path value="Patient.id" /> <short value="PIR Client ID" /> <definition value="Unique Panorama Client ID" /> <comment value="See Mappings" /> <min value="1" /> <mapping> <identity value="source-PIR" /> <map value="PIR subject_id" /> </mapping> </element> <element id="Patient.meta"> <path value="Patient.meta" /> <min value="1" /> </element> <element id="Patient.meta.versionId"> <path value="Patient.meta.versionId" /> <comment value="Apply '2025.01.1' (This indicates the FHIR Specs changes on 2025 - Jan)" /> </element> <element id="Patient.meta.lastUpdated"> <path value="Patient.meta.lastUpdated" /> <comment value="Updated: Relax the previously crossed-out elements." /> </element> <element id="Patient.meta.profile"> <path value="Patient.meta.profile" /> <comment value="Use 'http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/Patient'" /> <min value="1" /> <max value="1" /> </element> <element id="Patient.meta.security"> <path value="Patient.meta.security" /> <max value="1" /> </element> <element id="Patient.meta.tag"> <path value="Patient.meta.tag" /> <max value="1" /> </element> <element id="Patient.contained"> <path value="Patient.contained" /> <max value="1" /> </element> <element id="Patient.extension:genderIdentityExtension"> <path value="Patient.extension" /> <sliceName value="genderIdentityExtension" /> <type> <code value="Extension" /> <profile value="http://hl7.org/fhir/StructureDefinition/patient-genderIdentity" /> </type> </element> <element id="Patient.identifier"> <path value="Patient.identifier" /> <short value="Identifier(s) for this patient" /> <definition value="Different types of patient identifier which includes JHN (Jurisdictional Health Number e.g. BC PHN), PI (Patient Internal Identifier e.g. PIR Client ID, HAs' Internal Client ID)." /> <comment value="Extract from PIR <client.human_subject>" /> <min value="1" /> </element> <element id="Patient.identifier.type"> <path value="Patient.identifier.type" /> <min value="1" /> </element> <element id="Patient.identifier.type.coding"> <path value="Patient.identifier.type.coding" /> <min value="1" /> </element> <element id="Patient.identifier.type.coding.system"> <path value="Patient.identifier.type.coding.system" /> <comment value="http://terminology.hl7.org/CodeSystem/v2-0203" /> <fixedUri value="http://terminology.hl7.org/CodeSystem/v2-0203" /> </element> <element id="Patient.identifier.type.coding.code"> <path value="Patient.identifier.type.coding.code" /> <comment value="See Mappings" /> <mapping> <identity value="JHN" /> <map value="JHN" /> <comment value="For all Canadian provincial health card number" /> </mapping> <mapping> <identity value="JPID" /> <map value="JPID" /> <comment value="Jurisdictional Person Identification" /> </mapping> <mapping> <identity value="MR" /> <map value="MR" /> <comment value="Medical Record Number" /> </mapping> <mapping> <identity value="PI" /> <map value="PI" /> <comment value="Patient Internal Identifier" /> </mapping> </element> <element id="Patient.identifier.type.text"> <path value="Patient.identifier.type.text" /> <comment value="See Mappings" /> <mapping> <identity value="source-PIR" /> <map value="Panorama Client ID" /> </mapping> <mapping> <identity value="source-FHA" /> <map value="FHA-PARIS Client ID" /> </mapping> <mapping> <identity value="source-NHA-CeDaR" /> <map value="NHA- CeDaR ID" /> </mapping> <mapping> <identity value="source-NHA-MOIS" /> <map value="NHA - MOIS ID" /> </mapping> <mapping> <identity value="source-VCH" /> <map value="VCH-PARIS Client ID" /> </mapping> <mapping> <identity value="source-ProfileEMR" /> <map value="ProfileEMR_ClientID" /> </mapping> <mapping> <identity value="source-CAN-ArmedForces" /> <map value="Canadian Armed Forces IDentification Number" /> </mapping> <mapping> <identity value="source-CAN-RCMP" /> <map value="Canadian RCMP Regiment Number" /> </mapping> <mapping> <identity value="source-CAN-VeteranAffairs" /> <map value="Veteran Affairs CAnadian Identification Number" /> </mapping> </element> <element id="Patient.identifier.system"> <path value="Patient.identifier.system" /> <comment value="See Mappings below for appropriate URLs and URNs." /> <min value="1" /> <mapping> <identity value="JHN-BC" /> <map value="https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-patient-healthcare-id" /> <comment value="British Columbia, Canada Personal Health Number" /> </mapping> <mapping> <identity value="PI-PIR" /> <map value="https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-panorama-client-id" /> </mapping> <mapping> <identity value="JHN-YT" /> <map value="https://fhir.infoway-inforoute.ca/NamingSystem/ca-yt-patient-healthcare-id" /> </mapping> <mapping> <identity value="PI-FHA" /> <map value="https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-fha-patient-id" /> </mapping> <mapping> <identity value="PI-NHA" /> <map value="https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-nha-patient-id" /> </mapping> <mapping> <identity value="PI-VCH" /> <map value="https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-vcha-patient-id" /> </mapping> <mapping> <identity value="PI-CAN-ArmedForces" /> <map value="urn: 2.16.840.1.113883.3.51.1.1.6.15" /> </mapping> <mapping> <identity value="PI-RCMP" /> <map value="urn:2.16.840.1.113883.3.51.1.1.6.16" /> </mapping> <mapping> <identity value="PI-CAN-VeteranAffairs" /> <map value="urn:2.16.840.1.113883.3.51.1.1.6.18" /> </mapping> <mapping> <identity value="PI-ProfileEMR" /> <map value="https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-profile-emr-patient-id" /> </mapping> </element> <element id="Patient.identifier.value"> <path value="Patient.identifier.value" /> <comment value="PIR Client ID: Extract from PIR (client.human_subject.subject_id); BC PHN or Yukon PHN: Extract from PIR (client.human_subject.health_card_number)" /> <min value="1" /> <mapping> <identity value="JHN-BC" /> <map value="Extract from PIR (client.human_subject.health_card_number)" /> </mapping> <mapping> <identity value="JHN-YT" /> <map value="Extract from PIR (client.human_subject.health_card_number)" /> </mapping> <mapping> <identity value="PI-PIR" /> <map value="Extract from PIR (client.human_subject.subject_id)" /> </mapping> <mapping> <identity value="PI-FHA" /> <map value="FHA-PARIS Client ID" /> </mapping> <mapping> <identity value="PI-NHA" /> <map value="NHA- CeDaR ID" /> </mapping> <mapping> <identity value="PI-VCH" /> <map value="VCH-PARIS Client ID" /> </mapping> </element> <element id="Patient.active"> <path value="Patient.active" /> <short value="Whether this patient's record is in active use in PIR." /> <definition value="It is used to filter patient lists to exclude inactive patients Inactive patient lists include inactive reasons in (Created in Error, Retruned to Birth Parent, Adopted, Soft Deleted, Deceased)." /> <comment value="Hardcode as 'True' for all PIR active clients." /> <min value="1" /> </element> <element id="Patient.name"> <path value="Patient.name" /> <definition value="PIR Client Lastname, Firstname, Middlename" /> <comment value="Extract from PIR <client.human_subject>" /> <min value="1" /> </element> <element id="Patient.name.use"> <path value="Patient.name.use" /> <comment value="See Mappings" /> <mapping> <identity value="legal" /> <map value="official" /> </mapping> <mapping> <identity value="alias" /> <map value="usual" /> </mapping> </element> <element id="Patient.name.family"> <path value="Patient.name.family" /> <short value="Patient Family Name" /> <definition value="Patient Family Name" /> <comment value="Patient Family Name" /> <min value="1" /> </element> <element id="Patient.name.given"> <path value="Patient.name.given" /> <short value="Patient Given Names" /> <definition value="Patient Given Names" /> <comment value="Patient Given Names" /> <min value="1" /> </element> <element id="Patient.name.prefix"> <path value="Patient.name.prefix" /> <max value="1" /> </element> <element id="Patient.name.suffix"> <path value="Patient.name.suffix" /> <max value="1" /> </element> <element id="Patient.telecom"> <path value="Patient.telecom" /> <short value="A contact detail for the PIR Client" /> <definition value="A contact detail (e.g. a telephone number or an email address) by which the PIR client may be contacted." /> </element> <element id="Patient.telecom.id"> <path value="Patient.telecom.id" /> <max value="0" /> </element> <element id="Patient.telecom.system"> <path value="Patient.telecom.system" /> <comment value="Use 'phone | email'. Extract the current phone or email from PIR, not the ones with 'Effective Date To' populated." /> </element> <element id="Patient.telecom.value"> <path value="Patient.telecom.value" /> <short value="Patient Phone Number or Email" /> <definition value="Patient Phone Number or Email" /> <comment value="Patient Phone Number | Email" /> </element> <element id="Patient.telecom.use"> <path value="Patient.telecom.use" /> <short value="home | work | mobile - purpose of this contact point" /> <comment value="Use "home" | "work" |"mobile" (See Mappings). If not listed in the mappings, drop the attirubte USE, do not send." /> <mapping> <identity value="pirHOME" /> <map value="home" /> </mapping> <mapping> <identity value="pirBUSINESS" /> <map value="work" /> </mapping> <mapping> <identity value="pirMOBILE" /> <map value="mobile" /> </mapping> </element> <element id="Patient.telecom.rank"> <path value="Patient.telecom.rank" /> <max value="0" /> </element> <element id="Patient.telecom.period.id"> <path value="Patient.telecom.period.id" /> <max value="0" /> </element> <element id="Patient.gender"> <path value="Patient.gender" /> <definition value="Patient Administrative Gender. PIR gender "Undifferentiate" is mapped to "unknown" in FHIR." /> <comment value="Patient Administrative Gender" /> <min value="1" /> </element> <element id="Patient.gender.id"> <path value="Patient.gender.id" /> <max value="0" /> </element> <element id="Patient.birthDate"> <path value="Patient.birthDate" /> <short value="Patient Date of Birth" /> <definition value="Patient Date of Birth" /> <comment value="Patient Date of Birth (yyyy-mm-dd)" /> <min value="1" /> </element> <element id="Patient.address"> <path value="Patient.address" /> <comment value="Extract the LATEST client address from PIR" /> <max value="1" /> </element> <element id="Patient.address.use"> <path value="Patient.address.use" /> <definition value="The purpose of this address: home | work" /> <comment value="See Mappings" /> <mapping> <identity value="pir-PrimaryHome" /> <map value="home" /> </mapping> </element> <element id="Patient.address.type"> <path value="Patient.address.type" /> <comment value="See Mappings." /> <mapping> <identity value="pir-PostalAddress" /> <map value="postal" /> </mapping> </element> <element id="Patient.address.line"> <path value="Patient.address.line" /> <comment value="Use address.line for international address" /> </element> <element id="Patient.address.line.extension:_line"> <path value="Patient.address.line.extension" /> <sliceName value="_line" /> <type> <code value="Extension" /> <profile value="http://hl7.org/fhir/StructureDefinition/iso21090-ADXP" /> </type> </element> <element id="Patient.photo"> <path value="Patient.photo" /> <max value="1" /> </element> <element id="Patient.contact"> <path value="Patient.contact" /> <max value="1" /> </element> <element id="Patient.communication"> <path value="Patient.communication" /> <max value="1" /> </element> <element id="Patient.generalPractitioner"> <path value="Patient.generalPractitioner" /> <max value="1" /> </element> <element id="Patient.link"> <path value="Patient.link" /> <max value="1" /> </element> <element id="Patient.link.other.id"> <path value="Patient.link.other.id" /> <max value="0" /> </element> <element id="Patient.link.other.reference"> <path value="Patient.link.other.reference" /> <comment value="See Mappings" /> <min value="1" /> <mapping> <identity value="resrouceType-PIRID" /> <map value="fullURL of Panorama + 'Patient' + <PIR Client ID>" /> </mapping> </element> <element id="Patient.link.type"> <path value="Patient.link.type" /> <definition value="Use 'replaces' for resourcePatient as the survivor patient out of a merge." /> <comment value=""replaces" non-survivor patient id with survivor patient id." /> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "id": "f68c0e19-c1e1-4a09-bb6a-9b071049522a", "meta": { "versionId": "10", "lastUpdated": "01/24/2025 23:03:47" }, "url": "http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/Patient", "name": "Patient_CAbaseline", "status": "draft", "date": "02/18/2022 18:22:50", "description": "Resource Patient is profiled based on Canadian Baseline", "fhirVersion": "4.0.1", "kind": "resource", "abstract": false, "type": "Patient", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Patient", "derivation": "constraint", "differential": { "element": [ { "id": "Patient", "path": "Patient", "short": "IFHIR resource applies for PIR Client", "definition": "IFHIR resource applies for PIR Client" }, { "id": "Patient.id", "path": "Patient.id", "short": "PIR Client ID", "definition": "Unique Panorama Client ID", "comment": "See Mappings", "min": 1, "mapping": [ { "identity": "source-PIR", "map": "PIR subject_id" } ] }, { "id": "Patient.meta", "path": "Patient.meta", "min": 1 }, { "id": "Patient.meta.versionId", "path": "Patient.meta.versionId", "comment": "Apply '2025.01.1' (This indicates the FHIR Specs changes on 2025 - Jan)" }, { "id": "Patient.meta.lastUpdated", "path": "Patient.meta.lastUpdated", "comment": "Updated: Relax the previously crossed-out elements." }, { "id": "Patient.meta.profile", "path": "Patient.meta.profile", "comment": "Use 'http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/Patient'", "min": 1, "max": "1" }, { "id": "Patient.meta.security", "path": "Patient.meta.security", "max": "1" }, { "id": "Patient.meta.tag", "path": "Patient.meta.tag", "max": "1" }, { "id": "Patient.contained", "path": "Patient.contained", "max": "1" }, { "id": "Patient.extension:genderIdentityExtension", "path": "Patient.extension", "sliceName": "genderIdentityExtension", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/patient-genderIdentity" ] } ] }, { "id": "Patient.identifier", "path": "Patient.identifier", "short": "Identifier(s) for this patient", "definition": "Different types of patient identifier which includes JHN (Jurisdictional Health Number e.g. BC PHN), PI (Patient Internal Identifier e.g. PIR Client ID, HAs' Internal Client ID).", "comment": "Extract from PIR <client.human_subject>", "min": 1 }, { "id": "Patient.identifier.type", "path": "Patient.identifier.type", "min": 1 }, { "id": "Patient.identifier.type.coding", "path": "Patient.identifier.type.coding", "min": 1 }, { "id": "Patient.identifier.type.coding.system", "path": "Patient.identifier.type.coding.system", "comment": "http://terminology.hl7.org/CodeSystem/v2-0203", "fixedUri": "http://terminology.hl7.org/CodeSystem/v2-0203" }, { "id": "Patient.identifier.type.coding.code", "path": "Patient.identifier.type.coding.code", "comment": "See Mappings", "mapping": [ { "identity": "JHN", "map": "JHN", "comment": "For all Canadian provincial health card number" }, { "identity": "JPID", "map": "JPID", "comment": "Jurisdictional Person Identification" }, { "identity": "MR", "map": "MR", "comment": "Medical Record Number" }, { "identity": "PI", "map": "PI", "comment": "Patient Internal Identifier" } ] }, { "id": "Patient.identifier.type.text", "path": "Patient.identifier.type.text", "comment": "See Mappings", "mapping": [ { "identity": "source-PIR", "map": "Panorama Client ID" }, { "identity": "source-FHA", "map": "FHA-PARIS Client ID" }, { "identity": "source-NHA-CeDaR", "map": "NHA- CeDaR ID" }, { "identity": "source-NHA-MOIS", "map": "NHA - MOIS ID" }, { "identity": "source-VCH", "map": "VCH-PARIS Client ID" }, { "identity": "source-ProfileEMR", "map": "ProfileEMR_ClientID" }, { "identity": "source-CAN-ArmedForces", "map": "Canadian Armed Forces IDentification Number" }, { "identity": "source-CAN-RCMP", "map": "Canadian RCMP Regiment Number" }, { "identity": "source-CAN-VeteranAffairs", "map": "Veteran Affairs CAnadian Identification Number" } ] }, { "id": "Patient.identifier.system", "path": "Patient.identifier.system", "comment": "See Mappings below for appropriate URLs and URNs.", "min": 1, "mapping": [ { "identity": "JHN-BC", "map": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-patient-healthcare-id", "comment": "British Columbia, Canada Personal Health Number" }, { "identity": "PI-PIR", "map": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-panorama-client-id" }, { "identity": "JHN-YT", "map": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-yt-patient-healthcare-id" }, { "identity": "PI-FHA", "map": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-fha-patient-id" }, { "identity": "PI-NHA", "map": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-nha-patient-id" }, { "identity": "PI-VCH", "map": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-vcha-patient-id" }, { "identity": "PI-CAN-ArmedForces", "map": "urn: 2.16.840.1.113883.3.51.1.1.6.15" }, { "identity": "PI-RCMP", "map": "urn:2.16.840.1.113883.3.51.1.1.6.16" }, { "identity": "PI-CAN-VeteranAffairs", "map": "urn:2.16.840.1.113883.3.51.1.1.6.18" }, { "identity": "PI-ProfileEMR", "map": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-profile-emr-patient-id" } ] }, { "id": "Patient.identifier.value", "path": "Patient.identifier.value", "comment": "PIR Client ID: Extract from PIR (client.human_subject.subject_id); BC PHN or Yukon PHN: Extract from PIR (client.human_subject.health_card_number)", "min": 1, "mapping": [ { "identity": "JHN-BC", "map": "Extract from PIR (client.human_subject.health_card_number)" }, { "identity": "JHN-YT", "map": "Extract from PIR (client.human_subject.health_card_number)" }, { "identity": "PI-PIR", "map": "Extract from PIR (client.human_subject.subject_id)" }, { "identity": "PI-FHA", "map": "FHA-PARIS Client ID" }, { "identity": "PI-NHA", "map": "NHA- CeDaR ID" }, { "identity": "PI-VCH", "map": "VCH-PARIS Client ID" } ] }, { "id": "Patient.active", "path": "Patient.active", "short": "Whether this patient's record is in active use in PIR.", "definition": "It is used to filter patient lists to exclude inactive patients Inactive patient lists include inactive reasons in (Created in Error, Retruned to Birth Parent, Adopted, Soft Deleted, Deceased).", "comment": "Hardcode as 'True' for all PIR active clients.", "min": 1 }, { "id": "Patient.name", "path": "Patient.name", "definition": "PIR Client Lastname, Firstname, Middlename", "comment": "Extract from PIR <client.human_subject>", "min": 1 }, { "id": "Patient.name.use", "path": "Patient.name.use", "comment": "See Mappings", "mapping": [ { "identity": "legal", "map": "official" }, { "identity": "alias", "map": "usual" } ] }, { "id": "Patient.name.family", "path": "Patient.name.family", "short": "Patient Family Name", "definition": "Patient Family Name", "comment": "Patient Family Name", "min": 1 }, { "id": "Patient.name.given", "path": "Patient.name.given", "short": "Patient Given Names", "definition": "Patient Given Names", "comment": "Patient Given Names", "min": 1 }, { "id": "Patient.name.prefix", "path": "Patient.name.prefix", "max": "1" }, { "id": "Patient.name.suffix", "path": "Patient.name.suffix", "max": "1" }, { "id": "Patient.telecom", "path": "Patient.telecom", "short": "A contact detail for the PIR Client", "definition": "A contact detail (e.g. a telephone number or an email address) by which the PIR client may be contacted." }, { "id": "Patient.telecom.id", "path": "Patient.telecom.id", "max": "0" }, { "id": "Patient.telecom.system", "path": "Patient.telecom.system", "comment": "Use 'phone | email'. Extract the current phone or email from PIR, not the ones with 'Effective Date To' populated." }, { "id": "Patient.telecom.value", "path": "Patient.telecom.value", "short": "Patient Phone Number or Email", "definition": "Patient Phone Number or Email", "comment": "Patient Phone Number | Email" }, { "id": "Patient.telecom.use", "path": "Patient.telecom.use", "short": "home | work | mobile - purpose of this contact point", "comment": "Use \"home\" | \"work\" |\"mobile\" (See Mappings). If not listed in the mappings, drop the attirubte USE, do not send.", "mapping": [ { "identity": "pirHOME", "map": "home" }, { "identity": "pirBUSINESS", "map": "work" }, { "identity": "pirMOBILE", "map": "mobile" } ] }, { "id": "Patient.telecom.rank", "path": "Patient.telecom.rank", "max": "0" }, { "id": "Patient.telecom.period.id", "path": "Patient.telecom.period.id", "max": "0" }, { "id": "Patient.gender", "path": "Patient.gender", "definition": "Patient Administrative Gender. PIR gender \"Undifferentiate\" is mapped to \"unknown\" in FHIR.", "comment": "Patient Administrative Gender", "min": 1 }, { "id": "Patient.gender.id", "path": "Patient.gender.id", "max": "0" }, { "id": "Patient.birthDate", "path": "Patient.birthDate", "short": "Patient Date of Birth", "definition": "Patient Date of Birth", "comment": "Patient Date of Birth (yyyy-mm-dd)", "min": 1 }, { "id": "Patient.address", "path": "Patient.address", "comment": "Extract the LATEST client address from PIR", "max": "1" }, { "id": "Patient.address.use", "path": "Patient.address.use", "definition": "The purpose of this address: home | work", "comment": "See Mappings", "mapping": [ { "identity": "pir-PrimaryHome", "map": "home" } ] }, { "id": "Patient.address.type", "path": "Patient.address.type", "comment": "See Mappings.", "mapping": [ { "identity": "pir-PostalAddress", "map": "postal" } ] }, { "id": "Patient.address.line", "path": "Patient.address.line", "comment": "Use address.line for international address" }, { "id": "Patient.address.line.extension:_line", "path": "Patient.address.line.extension", "sliceName": "_line", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP" ] } ] }, { "id": "Patient.photo", "path": "Patient.photo", "max": "1" }, { "id": "Patient.contact", "path": "Patient.contact", "max": "1" }, { "id": "Patient.communication", "path": "Patient.communication", "max": "1" }, { "id": "Patient.generalPractitioner", "path": "Patient.generalPractitioner", "max": "1" }, { "id": "Patient.link", "path": "Patient.link", "max": "1" }, { "id": "Patient.link.other.id", "path": "Patient.link.other.id", "max": "0" }, { "id": "Patient.link.other.reference", "path": "Patient.link.other.reference", "comment": "See Mappings", "min": 1, "mapping": [ { "identity": "resrouceType-PIRID", "map": "fullURL of Panorama + 'Patient' + <PIR Client ID>" } ] }, { "id": "Patient.link.type", "path": "Patient.link.type", "definition": "Use 'replaces' for resourcePatient as the survivor patient out of a merge.", "comment": "\"replaces\" non-survivor patient id with survivor patient id." } ] } }