The FHIR resource RelatedPerson is for Immunization Consent purposes. This FHIR resource is contained inside resource Consent.
RelatedPerson | I | RelatedPerson | |
id | Σ | 1..1 | string |
meta | Σ | 0..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..* | Resource | |
extension | I | 0..* | Extension |
modifierExtension | ?! I | 0..* | Extension |
identifier | Σ | 0..1 | Identifier |
id | 0..0 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..0 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 0..1 | uri |
value | Σ | 0..1 | string |
period | Σ | 0..1 | Period |
assigner | Σ | 0..1 | Reference(Organization) |
active | Σ ?! | 0..1 | boolean |
patient | Σ | 1..1 | Reference(Patient) |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | Σ I | 1..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | Σ | 0..1 | Identifier |
display | Σ | 0..1 | string |
relationship | Σ | 0..1 | CodeableConceptBinding |
id | 0..0 | string | |
extension | I | 0..* | Extension |
coding | Σ | 0..1 | Coding |
id | 0..0 | string | |
extension | I | 0..* | Extension |
system | Σ | 1..1 | uri |
version | Σ | 0..0 | string |
code | Σ | 1..1 | code |
display | Σ | 1..1 | string |
userSelected | Σ | 0..0 | boolean |
text | Σ | 0..1 | string |
name | Σ | 1..1 | HumanName |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
text | Σ | 0..1 | string |
family | Σ | 1..1 | string |
given | Σ | 1..1 | string |
prefix | Σ | 0..1 | string |
suffix | Σ | 0..1 | string |
period | Σ | 0..1 | Period |
telecom | Σ | 0..1 | ContactPoint |
gender | Σ | 0..1 | codeBinding |
birthDate | Σ | 0..1 | date |
address | Σ | 0..1 | Address |
photo | 0..1 | Attachment | |
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 |
RelatedPerson | |
Definition | Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process. |
Cardinality | 0...* |
Invariants |
|
Mappings |
|
RelatedPerson.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 1...1 |
Type | string |
Summary | True |
Comments | See Mappings |
Mappings |
|
RelatedPerson.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 | 0...1 |
Type | Meta |
Summary | True |
Invariants |
|
RelatedPerson.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 |
|
RelatedPerson.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 |
|
RelatedPerson.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 as of year Jan 2025. |
Invariants |
|
RelatedPerson.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 |
|
RelatedPerson.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 |
|
RelatedPerson.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 | Apply "http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/RelatedPerson" |
Invariants |
|
RelatedPerson.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 |
|
RelatedPerson.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 |
|
RelatedPerson.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 |
|
RelatedPerson.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 |
|
RelatedPerson.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 |
|
RelatedPerson.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...* |
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 |
|
RelatedPerson.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 |
|
Mappings |
|
RelatedPerson.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 |
|
RelatedPerson.identifier | |
Definition | Identifier for a person within a particular scope. |
Cardinality | 0...1 |
Type | Identifier |
Summary | True |
Requirements | People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier. |
Invariants |
|
Mappings |
|
RelatedPerson.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...0 |
Type | string |
Mappings |
|
RelatedPerson.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 |
|
RelatedPerson.identifier.use | |
Definition | The purpose of this identifier. |
Cardinality | 0...0 |
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 |
|
RelatedPerson.identifier.type | |
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
Cardinality | 0...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 |
|
RelatedPerson.identifier.system | |
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. |
Cardinality | 0...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 | Identifier.system is always case sensitive. |
Invariants |
|
Examples | General http://www.acme.com/identifiers/patient |
Mappings |
|
RelatedPerson.identifier.value | |
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. |
Invariants |
|
Examples | General 123456 |
Mappings |
|
RelatedPerson.identifier.period | |
Definition | Time period during which identifier is/was valid for use. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Invariants |
|
Mappings |
|
RelatedPerson.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 |
|
RelatedPerson.active | |
Definition | Whether this related person record is in active use. |
Cardinality | 0...1 |
Type | boolean |
Modifier | True |
Summary | True |
Requirements | Need to be able to mark a related person record as not to be used, such as if it was created in error. |
Comments | This element is labeled as a modifier because it may be used to mark that the resource was created in error. |
Invariants |
|
Mappings |
|
RelatedPerson.patient | |
Definition | The patient this person is related to. |
Cardinality | 1...1 |
Type | Reference(Patient) |
Summary | True |
Requirements | We need to know which patient this RelatedPerson is related to. |
Invariants |
|
Mappings |
|
RelatedPerson.patient.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 |
|
RelatedPerson.patient.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 |
|
RelatedPerson.patient.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 |
|
RelatedPerson.patient.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 |
|
RelatedPerson.patient.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 |
|
RelatedPerson.patient.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 |
|
RelatedPerson.relationship | |
Definition | The nature of the relationship between a patient and the related person. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | The nature of the relationship between a patient and the related person. |
Summary | True |
Requirements | We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person. |
Invariants |
|
Mappings |
|
RelatedPerson.relationship.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 |
|
RelatedPerson.relationship.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 |
|
RelatedPerson.relationship.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...1 |
Type | Coding |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | See Mappings |
Invariants |
|
Mappings |
|
RelatedPerson.relationship.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...0 |
Type | string |
Mappings |
|
RelatedPerson.relationship.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 |
|
RelatedPerson.relationship.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. |
Invariants |
|
Mappings |
|
RelatedPerson.relationship.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...0 |
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 |
|
RelatedPerson.relationship.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 | 1...1 |
Type | code |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Comments | Refer to IMMS Codeset spreadsheet: Consent - ConsentGivenByRelationship. See Mappings. |
Invariants |
|
Mappings |
|
RelatedPerson.relationship.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 1...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. |
Comments | Refer to IMMS Codeset spreadsheet: Consent - ConsentGivenByRelationship |
Invariants |
|
Mappings |
|
RelatedPerson.relationship.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...0 |
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 |
|
RelatedPerson.relationship.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: To be applied if PIR Consent Given By = Related Client. WHO_GAVE_RLTNSHP_CODE_CNCPT_ID = null and WHO_GAVE_RELATIONSHIP_ID has a value. |
Invariants |
|
Mappings |
|
RelatedPerson.name | |
Definition | A name associated with the person. |
Cardinality | 1...1 |
Type | HumanName |
Summary | True |
Requirements | Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person. |
Comments | See Mappings. NOT SPECIFIED is applied when both WHO_GAVE_RLTNSHP_CODE_CNCPT_ID = null and WHO_GAVE_RELATIONSHIP_ID = null. |
Invariants |
|
Mappings |
|
RelatedPerson.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 |
|
RelatedPerson.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 |
|
RelatedPerson.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 | Applications can assume that a name is current unless it explicitly says that it is temporary or old. |
Invariants |
|
Mappings |
|
RelatedPerson.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 |
|
RelatedPerson.name.family | |
Definition | The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father. |
Cardinality | 1...1 |
Type | string |
Summary | True |
Alias | surname |
Comments | Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures). |
Invariants |
|
Mappings |
|
RelatedPerson.name.given | |
Definition | Given name. |
Cardinality | 1...1 |
Type | string |
Summary | True |
Alias | first name, middle name |
Comments | FIRST Name sends in first place of Given Name, MIDDLE Name sneds in second place of Given Name |
Invariants |
|
Mappings |
|
RelatedPerson.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 |
|
RelatedPerson.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 |
|
RelatedPerson.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 |
|
RelatedPerson.telecom | |
Definition | A contact detail for the person, e.g. a telephone number or an email address. |
Cardinality | 0...1 |
Type | ContactPoint |
Summary | True |
Requirements | People have (primary) ways to contact them in some way such as phone, email. |
Comments | Person 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 |
|
RelatedPerson.gender | |
Definition | Administrative Gender - the gender that the 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. |
Summary | True |
Requirements | Needed for identification of the person, in combination with (at least) name and birth date. |
Invariants |
|
Mappings |
|
RelatedPerson.birthDate | |
Definition | The date on which the related person was born. |
Cardinality | 0...1 |
Type | date |
Summary | True |
Invariants |
|
Mappings |
|
RelatedPerson.address | |
Definition | Address where the related person can be contacted or visited. |
Cardinality | 0...1 |
Type | Address |
Summary | True |
Requirements | Need to keep track where the related person can be contacted per postal mail or visited. |
Invariants |
|
Mappings |
|
RelatedPerson.photo | |
Definition | Image of the person. |
Cardinality | 0...1 |
Type | Attachment |
Requirements | Many EHR systems have the capability to capture an image of persons. Fits with newer social media usage too. |
Invariants |
|
Mappings |
|
RelatedPerson.period | |
Definition | The period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknown. |
Cardinality | 0...1 |
Type | Period |
Invariants |
|
Mappings |
|
RelatedPerson.communication | |
Definition | A language which may be used to communicate with about the patient's health. |
Cardinality | 0...1 |
Type | BackboneElement |
Requirements | If a related person does not speak the local language, interpreters may be required, so languages spoken and proficiency is an 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 RelatedPerson.Communication associations. If the RelatedPerson 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 |
|
RelatedPerson.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 |
|
RelatedPerson.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 |
|
RelatedPerson.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 |
|
RelatedPerson.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 |
|
RelatedPerson.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 |
|
<StructureDefinition xmlns="http://hl7.org/fhir"> <url value="http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/RelatedPerson" /> <name value="RelatedPerson" /> <status value="draft" /> <fhirVersion value="4.0.1" /> <kind value="resource" /> <abstract value="false" /> <type value="RelatedPerson" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/RelatedPerson" /> <derivation value="constraint" /> <differential> <element id="RelatedPerson.id"> <path value="RelatedPerson.id" /> <comment value="See Mappings" /> <min value="1" /> <mapping> <identity value="source-PIR" /> <map value="CONSENT.CONSENT_DIRECTIVE_ID" /> </mapping> </element> <element id="RelatedPerson.meta"> <path value="RelatedPerson.meta" /> </element> <element id="RelatedPerson.meta.versionId"> <path value="RelatedPerson.meta.versionId" /> <comment value="Apply "2025.01.1". This indicates the FHIR specs as of year Jan 2025." /> </element> <element id="RelatedPerson.meta.lastUpdated"> <path value="RelatedPerson.meta.lastUpdated" /> <comment value="Updated: Relax the previously crossed-out elements." /> </element> <element id="RelatedPerson.meta.profile"> <path value="RelatedPerson.meta.profile" /> <comment value="Apply "http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/RelatedPerson"" /> <min value="1" /> <max value="1" /> </element> <element id="RelatedPerson.meta.security"> <path value="RelatedPerson.meta.security" /> <max value="1" /> </element> <element id="RelatedPerson.meta.tag"> <path value="RelatedPerson.meta.tag" /> <max value="1" /> </element> <element id="RelatedPerson.identifier"> <path value="RelatedPerson.identifier" /> <max value="1" /> </element> <element id="RelatedPerson.identifier.id"> <path value="RelatedPerson.identifier.id" /> <max value="0" /> </element> <element id="RelatedPerson.identifier.use"> <path value="RelatedPerson.identifier.use" /> <max value="0" /> </element> <element id="RelatedPerson.patient.reference"> <path value="RelatedPerson.patient.reference" /> <comment value="See Mappings" /> <min value="1" /> <mapping> <identity value="source-PIR" /> <map value="fullURL + "Patient/" + (Patient ID)" /> <comment value="e.g. http://ehealth.bc.ca/panorama/fhir/Patient/59900999"" /> </mapping> </element> <element id="RelatedPerson.relationship"> <path value="RelatedPerson.relationship" /> <max value="1" /> </element> <element id="RelatedPerson.relationship.id"> <path value="RelatedPerson.relationship.id" /> <max value="0" /> </element> <element id="RelatedPerson.relationship.coding"> <path value="RelatedPerson.relationship.coding" /> <comment value="See Mappings" /> <max value="1" /> <mapping> <identity value="source-PIR-Other" /> <map value="Code: CONSENT.CONSENT_DIRECTIVE.WHO_GAVE_RLTNSHP_CODE_CNCPT_ID" /> </mapping> <mapping> <identity value="source-PIR-RelatedClient" /> <map value="Text: CONSENT.CONSENT_DIRECTIVE.WHO_GAVE_RELATIONSHIP_ID" /> </mapping> </element> <element id="RelatedPerson.relationship.coding.id"> <path value="RelatedPerson.relationship.coding.id" /> <max value="0" /> </element> <element id="RelatedPerson.relationship.coding.system"> <path value="RelatedPerson.relationship.coding.system" /> <code> <system value="https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-panorama-code" /> </code> <min value="1" /> </element> <element id="RelatedPerson.relationship.coding.version"> <path value="RelatedPerson.relationship.coding.version" /> <max value="0" /> </element> <element id="RelatedPerson.relationship.coding.code"> <path value="RelatedPerson.relationship.coding.code" /> <comment value="Refer to IMMS Codeset spreadsheet: Consent - ConsentGivenByRelationship. See Mappings." /> <min value="1" /> <mapping> <identity value="source-PIR" /> <map value="CONSENT.CONSENT_DIRECTIVE.WHO_GAVE_RLTNSHP_CODE_CNCPT_ID" /> </mapping> </element> <element id="RelatedPerson.relationship.coding.display"> <path value="RelatedPerson.relationship.coding.display" /> <comment value="Refer to IMMS Codeset spreadsheet: Consent - ConsentGivenByRelationship" /> <min value="1" /> </element> <element id="RelatedPerson.relationship.coding.userSelected"> <path value="RelatedPerson.relationship.coding.userSelected" /> <max value="0" /> </element> <element id="RelatedPerson.relationship.text"> <path value="RelatedPerson.relationship.text" /> <comment value="See Mappings: To be applied if PIR Consent Given By = Related Client. WHO_GAVE_RLTNSHP_CODE_CNCPT_ID = null and WHO_GAVE_RELATIONSHIP_ID has a value." /> <mapping> <identity value="source-PIR-RelatedClient" /> <map value="CONSENT.CONSENT_DIRECTIVE.WHO_GAVE_RELATIONSHIP_ID" /> </mapping> </element> <element id="RelatedPerson.name"> <path value="RelatedPerson.name" /> <comment value="See Mappings. NOT SPECIFIED is applied when both WHO_GAVE_RLTNSHP_CODE_CNCPT_ID = null and WHO_GAVE_RELATIONSHIP_ID = null." /> <min value="1" /> <max value="1" /> <mapping> <identity value="source-PIR-Other" /> <map value="CONSENT.CONSENT_DIRECTIVE.WHO_GAVE_CONSENT" /> </mapping> <mapping> <identity value="source-PIR-NotSpecified" /> <map value="Not Specified" /> </mapping> <mapping> <identity value="source-PIR-relatedClient" /> <map value="CLIENT.SUBJECT_RELATIONSHIP.LEFT_SUBJECT_ID" /> </mapping> </element> <element id="RelatedPerson.name.family"> <path value="RelatedPerson.name.family" /> <min value="1" /> </element> <element id="RelatedPerson.name.given"> <path value="RelatedPerson.name.given" /> <comment value="FIRST Name sends in first place of Given Name, MIDDLE Name sneds in second place of Given Name" /> <min value="1" /> <max value="1" /> </element> <element id="RelatedPerson.name.prefix"> <path value="RelatedPerson.name.prefix" /> <max value="1" /> </element> <element id="RelatedPerson.name.suffix"> <path value="RelatedPerson.name.suffix" /> <max value="1" /> </element> <element id="RelatedPerson.telecom"> <path value="RelatedPerson.telecom" /> <max value="1" /> </element> <element id="RelatedPerson.address"> <path value="RelatedPerson.address" /> <max value="1" /> </element> <element id="RelatedPerson.photo"> <path value="RelatedPerson.photo" /> <max value="1" /> </element> <element id="RelatedPerson.communication"> <path value="RelatedPerson.communication" /> <max value="1" /> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "url": "http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/RelatedPerson", "name": "RelatedPerson", "status": "draft", "fhirVersion": "4.0.1", "kind": "resource", "abstract": false, "type": "RelatedPerson", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "derivation": "constraint", "differential": { "element": [ { "id": "RelatedPerson.id", "path": "RelatedPerson.id", "comment": "See Mappings", "min": 1, "mapping": [ { "identity": "source-PIR", "map": "CONSENT.CONSENT_DIRECTIVE_ID" } ] }, { "id": "RelatedPerson.meta", "path": "RelatedPerson.meta" }, { "id": "RelatedPerson.meta.versionId", "path": "RelatedPerson.meta.versionId", "comment": "Apply \"2025.01.1\". This indicates the FHIR specs as of year Jan 2025." }, { "id": "RelatedPerson.meta.lastUpdated", "path": "RelatedPerson.meta.lastUpdated", "comment": "Updated: Relax the previously crossed-out elements." }, { "id": "RelatedPerson.meta.profile", "path": "RelatedPerson.meta.profile", "comment": "Apply \"http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/RelatedPerson\"", "min": 1, "max": "1" }, { "id": "RelatedPerson.meta.security", "path": "RelatedPerson.meta.security", "max": "1" }, { "id": "RelatedPerson.meta.tag", "path": "RelatedPerson.meta.tag", "max": "1" }, { "id": "RelatedPerson.identifier", "path": "RelatedPerson.identifier", "max": "1" }, { "id": "RelatedPerson.identifier.id", "path": "RelatedPerson.identifier.id", "max": "0" }, { "id": "RelatedPerson.identifier.use", "path": "RelatedPerson.identifier.use", "max": "0" }, { "id": "RelatedPerson.patient.reference", "path": "RelatedPerson.patient.reference", "comment": "See Mappings", "min": 1, "mapping": [ { "identity": "source-PIR", "map": "fullURL + \"Patient/\" + (Patient ID)", "comment": "e.g. http://ehealth.bc.ca/panorama/fhir/Patient/59900999\"" } ] }, { "id": "RelatedPerson.relationship", "path": "RelatedPerson.relationship", "max": "1" }, { "id": "RelatedPerson.relationship.id", "path": "RelatedPerson.relationship.id", "max": "0" }, { "id": "RelatedPerson.relationship.coding", "path": "RelatedPerson.relationship.coding", "comment": "See Mappings", "max": "1", "mapping": [ { "identity": "source-PIR-Other", "map": "Code: CONSENT.CONSENT_DIRECTIVE.WHO_GAVE_RLTNSHP_CODE_CNCPT_ID" }, { "identity": "source-PIR-RelatedClient", "map": "Text: CONSENT.CONSENT_DIRECTIVE.WHO_GAVE_RELATIONSHIP_ID" } ] }, { "id": "RelatedPerson.relationship.coding.id", "path": "RelatedPerson.relationship.coding.id", "max": "0" }, { "id": "RelatedPerson.relationship.coding.system", "path": "RelatedPerson.relationship.coding.system", "code": [ { "system": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-panorama-code" } ], "min": 1 }, { "id": "RelatedPerson.relationship.coding.version", "path": "RelatedPerson.relationship.coding.version", "max": "0" }, { "id": "RelatedPerson.relationship.coding.code", "path": "RelatedPerson.relationship.coding.code", "comment": "Refer to IMMS Codeset spreadsheet: Consent - ConsentGivenByRelationship. See Mappings.", "min": 1, "mapping": [ { "identity": "source-PIR", "map": "CONSENT.CONSENT_DIRECTIVE.WHO_GAVE_RLTNSHP_CODE_CNCPT_ID" } ] }, { "id": "RelatedPerson.relationship.coding.display", "path": "RelatedPerson.relationship.coding.display", "comment": "Refer to IMMS Codeset spreadsheet: Consent - ConsentGivenByRelationship", "min": 1 }, { "id": "RelatedPerson.relationship.coding.userSelected", "path": "RelatedPerson.relationship.coding.userSelected", "max": "0" }, { "id": "RelatedPerson.relationship.text", "path": "RelatedPerson.relationship.text", "comment": "See Mappings: To be applied if PIR Consent Given By = Related Client. WHO_GAVE_RLTNSHP_CODE_CNCPT_ID = null and WHO_GAVE_RELATIONSHIP_ID has a value.", "mapping": [ { "identity": "source-PIR-RelatedClient", "map": "CONSENT.CONSENT_DIRECTIVE.WHO_GAVE_RELATIONSHIP_ID" } ] }, { "id": "RelatedPerson.name", "path": "RelatedPerson.name", "comment": "See Mappings. NOT SPECIFIED is applied when both WHO_GAVE_RLTNSHP_CODE_CNCPT_ID = null and WHO_GAVE_RELATIONSHIP_ID = null.", "min": 1, "max": "1", "mapping": [ { "identity": "source-PIR-Other", "map": "CONSENT.CONSENT_DIRECTIVE.WHO_GAVE_CONSENT" }, { "identity": "source-PIR-NotSpecified", "map": "Not Specified" }, { "identity": "source-PIR-relatedClient", "map": "CLIENT.SUBJECT_RELATIONSHIP.LEFT_SUBJECT_ID" } ] }, { "id": "RelatedPerson.name.family", "path": "RelatedPerson.name.family", "min": 1 }, { "id": "RelatedPerson.name.given", "path": "RelatedPerson.name.given", "comment": "FIRST Name sends in first place of Given Name, MIDDLE Name sneds in second place of Given Name", "min": 1, "max": "1" }, { "id": "RelatedPerson.name.prefix", "path": "RelatedPerson.name.prefix", "max": "1" }, { "id": "RelatedPerson.name.suffix", "path": "RelatedPerson.name.suffix", "max": "1" }, { "id": "RelatedPerson.telecom", "path": "RelatedPerson.telecom", "max": "1" }, { "id": "RelatedPerson.address", "path": "RelatedPerson.address", "max": "1" }, { "id": "RelatedPerson.photo", "path": "RelatedPerson.photo", "max": "1" }, { "id": "RelatedPerson.communication", "path": "RelatedPerson.communication", "max": "1" } ] } }