Work in progress.
This section of the Implementation Guide is subject to change.
Profile EEBaseRelatedPerson
Profile Purpose
This profile builds on RelatedPerson resource. The profile allows information exchange 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.
Example usage scenarios
- Query for relationship between patient and related person using the query parameter
RelatedPerson.relationship - Query for communication language of the RelatedPerson with query parameter
RelatedPerson.communication.language - Exchange RelatedPerson information within a FHIR document or message
Snapshot View
| EEBaseRelatedPerson (RelatedPerson) | I | RelatedPerson | There are no (further) constraints on this element Element idRelatedPerson A person that is related to a patient, but who is not a direct target of care DefinitionInformation 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.
| |
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idRelatedPerson.meta Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
|
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idRelatedPerson.implicitRules A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
|
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idRelatedPerson.language Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
| |
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idRelatedPerson.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
| |
| contained | 0..* | Resource | There are no (further) constraints on this element Element idRelatedPerson.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| identifier | Σ | 0..* | Identifier | Element idRelatedPerson.identifier A human identifier for this person DefinitionIdentifier for a person within a particular scope. 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. Unordered, Open, by system(Value) Constraints
|
| est-id | S Σ | 0..1 | EEBase Estonian Personal Identification Number | Element idRelatedPerson.identifier:est-id Estonian personal identification DefinitionEesti isikukoodi identifikaator 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. EEBase Estonian Personal Identification Number Constraints
|
| tis-id | Σ | 0..1 | EEBase TIS ID | Element idRelatedPerson.identifier:tis-id Person's unique code generated by National Health System DefinitionIsiku unikaalne tunnus, mille alusel saab teda eristada teistest isikutest TIS-is. Saab kasutada nii välimaalaste kui ka tundmatu isiku jaoks (juhtudel, kui puudub Eesti isikukood). Mõeldud andmevahetuseks Tervise infosüsteemiga. 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.
|
| active | Σ ?! | 0..1 | boolean | There are no (further) constraints on this element Element idRelatedPerson.active Whether this related person's record is in active use DefinitionWhether this related person record is in active use. Need to be able to mark a related person record as not to be used, such as if it was created in error. This element is labeled as a modifier because it may be used to mark that the resource was created in error. This resource is generally assumed to be active if no value is provided for the active element
|
| patient | S Σ I | 1..1 | Reference(EEBase Patient) | Element idRelatedPerson.patient The patient this person is related to DefinitionThe patient this person is related to. We need to know which patient this RelatedPerson is related to. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
| relationship | S Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idRelatedPerson.relationship The nature of the relationship DefinitionThe nature of the relationship between a patient and the related person. We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The nature of the relationship between a patient and the related person.
|
| name | Σ | 0..* | HumanName | There are no (further) constraints on this element Element idRelatedPerson.name A name associated with the person DefinitionA name associated with the person. Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person. Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts might or might not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely.
|
| telecom | S Σ I | 0..* | ContactPoint | There are no (further) constraints on this element Element idRelatedPerson.telecom A contact detail for the person DefinitionA contact detail for the person, e.g. a telephone number or an email address. People have (primary) ways to contact them in some way such as phone, email. 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.
|
| gender | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idRelatedPerson.gender male | female | other | unknown DefinitionAdministrative Gender - the gender that the person is considered to have for administration and record keeping purposes. Needed for identification of the person, in combination with (at least) name and birth date. Note that FHIR strings SHALL NOT exceed 1MB in size The gender of a person used for administrative purposes.
|
| birthDate | Σ | 0..1 | date | There are no (further) constraints on this element Element idRelatedPerson.birthDate The date on which the related person was born DefinitionThe date on which the related person was born.
|
| address | Σ | 0..* | EEBase Address | Element idRelatedPerson.address An address expressed using postal conventions (as opposed to GPS or other location definition formats) DefinitionAn address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world. Need to keep track where the related person can be contacted per postal mail or visited. Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).
|
| photo | I | 0..* | Attachment | There are no (further) constraints on this element Element idRelatedPerson.photo Image of the person DefinitionImage of the person. Many EHR systems have the capability to capture an image of persons. Fits with newer social media usage too. When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent".
|
| period | I | 0..1 | Period | There are no (further) constraints on this element Element idRelatedPerson.period Period of time that this relationship is considered valid DefinitionThe period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknown. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
| communication | 0..* | BackboneElement | There are no (further) constraints on this element Element idRelatedPerson.communication A language which may be used to communicate with about the patient's health DefinitionA language which may be used to communicate with about the patient's health. 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. 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.
| |
| id | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.communication.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.communication.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.communication.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
| language | 1..1 | CodeableConceptBinding | Element idRelatedPerson.communication.language The language which can be used to communicate with the patient about his or her health DefinitionThe ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" for England English. Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect. The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type. A human language.
| |
| preferred | 0..1 | boolean | There are no (further) constraints on this element Element idRelatedPerson.communication.preferred Language preference indicator DefinitionIndicates whether or not the patient prefers this language (over other languages he masters up a certain level). People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method. This language is specifically identified for communicating healthcare information.
|
Differential View
| EEBaseRelatedPerson (RelatedPerson) | I | RelatedPerson | There are no (further) constraints on this element Element idRelatedPerson A person that is related to a patient, but who is not a direct target of care DefinitionInformation 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.
| |
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idRelatedPerson.meta Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
|
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idRelatedPerson.implicitRules A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
|
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idRelatedPerson.language Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
| |
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idRelatedPerson.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
| |
| contained | 0..* | Resource | There are no (further) constraints on this element Element idRelatedPerson.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| identifier | Σ | 0..* | Identifier | Element idRelatedPerson.identifier A human identifier for this person DefinitionIdentifier for a person within a particular scope. 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. Unordered, Open, by system(Value) Constraints
|
| est-id | S Σ | 0..1 | EEBase Estonian Personal Identification Number | Element idRelatedPerson.identifier:est-id Estonian personal identification DefinitionEesti isikukoodi identifikaator 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. EEBase Estonian Personal Identification Number Constraints
|
| tis-id | Σ | 0..1 | EEBase TIS ID | Element idRelatedPerson.identifier:tis-id Person's unique code generated by National Health System DefinitionIsiku unikaalne tunnus, mille alusel saab teda eristada teistest isikutest TIS-is. Saab kasutada nii välimaalaste kui ka tundmatu isiku jaoks (juhtudel, kui puudub Eesti isikukood). Mõeldud andmevahetuseks Tervise infosüsteemiga. 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.
|
| active | Σ ?! | 0..1 | boolean | There are no (further) constraints on this element Element idRelatedPerson.active Whether this related person's record is in active use DefinitionWhether this related person record is in active use. Need to be able to mark a related person record as not to be used, such as if it was created in error. This element is labeled as a modifier because it may be used to mark that the resource was created in error. This resource is generally assumed to be active if no value is provided for the active element
|
| patient | S Σ I | 1..1 | Reference(EEBase Patient) | Element idRelatedPerson.patient The patient this person is related to DefinitionThe patient this person is related to. We need to know which patient this RelatedPerson is related to. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
| relationship | S Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idRelatedPerson.relationship The nature of the relationship DefinitionThe nature of the relationship between a patient and the related person. We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The nature of the relationship between a patient and the related person.
|
| name | Σ | 0..* | HumanName | There are no (further) constraints on this element Element idRelatedPerson.name A name associated with the person DefinitionA name associated with the person. Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person. Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts might or might not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely.
|
| telecom | S Σ I | 0..* | ContactPoint | There are no (further) constraints on this element Element idRelatedPerson.telecom A contact detail for the person DefinitionA contact detail for the person, e.g. a telephone number or an email address. People have (primary) ways to contact them in some way such as phone, email. 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.
|
| gender | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idRelatedPerson.gender male | female | other | unknown DefinitionAdministrative Gender - the gender that the person is considered to have for administration and record keeping purposes. Needed for identification of the person, in combination with (at least) name and birth date. Note that FHIR strings SHALL NOT exceed 1MB in size The gender of a person used for administrative purposes.
|
| birthDate | Σ | 0..1 | date | There are no (further) constraints on this element Element idRelatedPerson.birthDate The date on which the related person was born DefinitionThe date on which the related person was born.
|
| address | Σ | 0..* | EEBase Address | Element idRelatedPerson.address An address expressed using postal conventions (as opposed to GPS or other location definition formats) DefinitionAn address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world. Need to keep track where the related person can be contacted per postal mail or visited. Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).
|
| photo | I | 0..* | Attachment | There are no (further) constraints on this element Element idRelatedPerson.photo Image of the person DefinitionImage of the person. Many EHR systems have the capability to capture an image of persons. Fits with newer social media usage too. When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent".
|
| period | I | 0..1 | Period | There are no (further) constraints on this element Element idRelatedPerson.period Period of time that this relationship is considered valid DefinitionThe period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknown. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
| communication | 0..* | BackboneElement | There are no (further) constraints on this element Element idRelatedPerson.communication A language which may be used to communicate with about the patient's health DefinitionA language which may be used to communicate with about the patient's health. 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. 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.
| |
| id | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.communication.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.communication.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.communication.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
| language | 1..1 | CodeableConceptBinding | Element idRelatedPerson.communication.language The language which can be used to communicate with the patient about his or her health DefinitionThe ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" for England English. Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect. The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type. A human language.
| |
| preferred | 0..1 | boolean | There are no (further) constraints on this element Element idRelatedPerson.communication.preferred Language preference indicator DefinitionIndicates whether or not the patient prefers this language (over other languages he masters up a certain level). People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method. This language is specifically identified for communicating healthcare information.
|
Hybrid View
| EEBaseRelatedPerson (RelatedPerson) | I | RelatedPerson | There are no (further) constraints on this element Element idRelatedPerson A person that is related to a patient, but who is not a direct target of care DefinitionInformation 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.
| |
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.id Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idRelatedPerson.meta Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
|
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idRelatedPerson.implicitRules A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
|
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idRelatedPerson.language Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
| |
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idRelatedPerson.text Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
| |
| contained | 0..* | Resource | There are no (further) constraints on this element Element idRelatedPerson.contained Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| modifierExtension | ?! I | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.modifierExtension Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| identifier | Σ | 0..* | Identifier | Element idRelatedPerson.identifier A human identifier for this person DefinitionIdentifier for a person within a particular scope. 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. Unordered, Open, by system(Value) Constraints
|
| est-id | S Σ | 0..1 | EEBase Estonian Personal Identification Number | Element idRelatedPerson.identifier:est-id Estonian personal identification DefinitionEesti isikukoodi identifikaator 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. EEBase Estonian Personal Identification Number Constraints
|
| tis-id | Σ | 0..1 | EEBase TIS ID | Element idRelatedPerson.identifier:tis-id Person's unique code generated by National Health System DefinitionIsiku unikaalne tunnus, mille alusel saab teda eristada teistest isikutest TIS-is. Saab kasutada nii välimaalaste kui ka tundmatu isiku jaoks (juhtudel, kui puudub Eesti isikukood). Mõeldud andmevahetuseks Tervise infosüsteemiga. 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.
|
| active | Σ ?! | 0..1 | boolean | There are no (further) constraints on this element Element idRelatedPerson.active Whether this related person's record is in active use DefinitionWhether this related person record is in active use. Need to be able to mark a related person record as not to be used, such as if it was created in error. This element is labeled as a modifier because it may be used to mark that the resource was created in error. This resource is generally assumed to be active if no value is provided for the active element
|
| patient | S Σ I | 1..1 | Reference(EEBase Patient) | Element idRelatedPerson.patient The patient this person is related to DefinitionThe patient this person is related to. We need to know which patient this RelatedPerson is related to. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.
|
| relationship | S Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idRelatedPerson.relationship The nature of the relationship DefinitionThe nature of the relationship between a patient and the related person. We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The nature of the relationship between a patient and the related person.
|
| name | Σ | 0..* | HumanName | There are no (further) constraints on this element Element idRelatedPerson.name A name associated with the person DefinitionA name associated with the person. Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person. Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts might or might not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely.
|
| telecom | S Σ I | 0..* | ContactPoint | There are no (further) constraints on this element Element idRelatedPerson.telecom A contact detail for the person DefinitionA contact detail for the person, e.g. a telephone number or an email address. People have (primary) ways to contact them in some way such as phone, email. 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.
|
| gender | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idRelatedPerson.gender male | female | other | unknown DefinitionAdministrative Gender - the gender that the person is considered to have for administration and record keeping purposes. Needed for identification of the person, in combination with (at least) name and birth date. Note that FHIR strings SHALL NOT exceed 1MB in size The gender of a person used for administrative purposes.
|
| birthDate | Σ | 0..1 | date | There are no (further) constraints on this element Element idRelatedPerson.birthDate The date on which the related person was born DefinitionThe date on which the related person was born.
|
| address | Σ | 0..* | EEBase Address | Element idRelatedPerson.address An address expressed using postal conventions (as opposed to GPS or other location definition formats) DefinitionAn address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world. Need to keep track where the related person can be contacted per postal mail or visited. Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).
|
| photo | I | 0..* | Attachment | There are no (further) constraints on this element Element idRelatedPerson.photo Image of the person DefinitionImage of the person. Many EHR systems have the capability to capture an image of persons. Fits with newer social media usage too. When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Signed Procedure Consent".
|
| period | I | 0..1 | Period | There are no (further) constraints on this element Element idRelatedPerson.period Period of time that this relationship is considered valid DefinitionThe period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknown. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.
|
| communication | 0..* | BackboneElement | There are no (further) constraints on this element Element idRelatedPerson.communication A language which may be used to communicate with about the patient's health DefinitionA language which may be used to communicate with about the patient's health. 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. 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.
| |
| id | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.communication.id Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | I | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.communication.extension Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| modifierExtension | Σ ?! I | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.communication.modifierExtension Extensions that cannot be ignored even if unrecognized Alternate namesextensions, user content, modifiers DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
|
| language | 1..1 | CodeableConceptBinding | Element idRelatedPerson.communication.language The language which can be used to communicate with the patient about his or her health DefinitionThe ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" for England English. Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect. The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type. A human language.
| |
| preferred | 0..1 | boolean | There are no (further) constraints on this element Element idRelatedPerson.communication.preferred Language preference indicator DefinitionIndicates whether or not the patient prefers this language (over other languages he masters up a certain level). People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method. This language is specifically identified for communicating healthcare information.
|
Table View
| RelatedPerson | .. | |
| RelatedPerson.identifier | .. | |
| RelatedPerson.identifier | EEBase Estonian Personal Identification Number | ..1 |
| RelatedPerson.identifier | EEBase TIS ID | ..1 |
| RelatedPerson.patient | Reference(EEBase Patient) | .. |
| RelatedPerson.relationship | .. | |
| RelatedPerson.telecom | .. | |
| RelatedPerson.address | EEBase Address | .. |
| RelatedPerson.communication | .. | |
| RelatedPerson.communication.language | .. |
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="EEBase-RelatedPerson" /> <url value="https://hl7.ee/fhir/StructureDefinition/EEBase-RelatedPerson" /> <version value="1.0.0" /> <name value="EEBaseRelatedPerson" /> <title value="EEBase RelatedPerson" /> <status value="draft" /> <date value="2022-11-21T13:22:24.2179018+00:00" /> <publisher value="HL7 EE" /> <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.identifier"> <path value="RelatedPerson.identifier" /> <slicing> <discriminator> <type value="value" /> <path value="system" /> </discriminator> <rules value="open" /> </slicing> </element> <element id="RelatedPerson.identifier:est-id"> <path value="RelatedPerson.identifier" /> <sliceName value="est-id" /> <short value="Estonian personal identification" /> <definition value="Eesti isikukoodi identifikaator" /> <max value="1" /> <type> <code value="Identifier" /> <profile value="https://hl7.ee/fhir/StructureDefinition/EEBase-ESTID" /> </type> </element> <element id="RelatedPerson.identifier:tis-id"> <path value="RelatedPerson.identifier" /> <sliceName value="tis-id" /> <short value="Person's unique code generated by National Health System" /> <definition value="Isiku unikaalne tunnus, mille alusel saab teda eristada teistest isikutest TIS-is. Saab kasutada nii välimaalaste kui ka tundmatu isiku jaoks (juhtudel, kui puudub Eesti isikukood). Mõeldud andmevahetuseks Tervise infosüsteemiga." /> <max value="1" /> <type> <code value="Identifier" /> <profile value="https://hl7.ee/fhir/StructureDefinition/EEBase-TISID" /> </type> </element> <element id="RelatedPerson.patient"> <path value="RelatedPerson.patient" /> <type> <code value="Reference" /> <targetProfile value="https://hl7.ee/fhir/StructureDefinition/EEBase-Patient" /> </type> <mustSupport value="true" /> </element> <element id="RelatedPerson.relationship"> <path value="RelatedPerson.relationship" /> <mustSupport value="true" /> </element> <element id="RelatedPerson.telecom"> <path value="RelatedPerson.telecom" /> <mustSupport value="true" /> </element> <element id="RelatedPerson.address"> <path value="RelatedPerson.address" /> <type> <code value="Address" /> <profile value="https://hl7.ee/fhir/StructureDefinition/EEBase-Address" /> </type> </element> <element id="RelatedPerson.communication.language"> <path value="RelatedPerson.communication.language" /> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet"> <valueCanonical value="http://hl7.org/fhir/ValueSet/all-languages" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="Language" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding"> <valueBoolean value="true" /> </extension> <strength value="preferred" /> <valueSet value="http://hl7.org/fhir/ValueSet/all-languages" /> </binding> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "EEBase-RelatedPerson", "url": "https://hl7.ee/fhir/StructureDefinition/EEBase-RelatedPerson", "version": "1.0.0", "name": "EEBaseRelatedPerson", "title": "EEBase RelatedPerson", "status": "draft", "date": "2022-11-21T13:22:24.2179018+00:00", "publisher": "HL7 EE", "fhirVersion": "4.0.1", "kind": "resource", "abstract": false, "type": "RelatedPerson", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "derivation": "constraint", "differential": { "element": [ { "id": "RelatedPerson.identifier", "path": "RelatedPerson.identifier", "slicing": { "discriminator": [ { "type": "value", "path": "system" } ], "rules": "open" } }, { "id": "RelatedPerson.identifier:est-id", "path": "RelatedPerson.identifier", "sliceName": "est-id", "short": "Estonian personal identification", "definition": "Eesti isikukoodi identifikaator", "max": "1", "type": [ { "code": "Identifier", "profile": [ "https://hl7.ee/fhir/StructureDefinition/EEBase-ESTID" ] } ] }, { "id": "RelatedPerson.identifier:tis-id", "path": "RelatedPerson.identifier", "sliceName": "tis-id", "short": "Person's unique code generated by National Health System", "definition": "Isiku unikaalne tunnus, mille alusel saab teda eristada teistest isikutest TIS-is. Saab kasutada nii välimaalaste kui ka tundmatu isiku jaoks (juhtudel, kui puudub Eesti isikukood). Mõeldud andmevahetuseks Tervise infosüsteemiga.", "max": "1", "type": [ { "code": "Identifier", "profile": [ "https://hl7.ee/fhir/StructureDefinition/EEBase-TISID" ] } ] }, { "id": "RelatedPerson.patient", "path": "RelatedPerson.patient", "type": [ { "code": "Reference", "targetProfile": [ "https://hl7.ee/fhir/StructureDefinition/EEBase-Patient" ] } ], "mustSupport": true }, { "id": "RelatedPerson.relationship", "path": "RelatedPerson.relationship", "mustSupport": true }, { "id": "RelatedPerson.telecom", "path": "RelatedPerson.telecom", "mustSupport": true }, { "id": "RelatedPerson.address", "path": "RelatedPerson.address", "type": [ { "code": "Address", "profile": [ "https://hl7.ee/fhir/StructureDefinition/EEBase-Address" ] } ] }, { "id": "RelatedPerson.communication.language", "path": "RelatedPerson.communication.language", "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet", "valueCanonical": "http://hl7.org/fhir/ValueSet/all-languages" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Language" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "preferred", "valueSet": "http://hl7.org/fhir/ValueSet/all-languages" } } ] } }
identifier
Identifier for a person who is related to the patient. It is recommended that the identifier value is Estonian Personal Identification Number. In case related person does not have Estonian Personal Identification Number then TIS Personal Identification Number is used.
active
Whether this practitioner role record is in active use.
patient (Must support)
The patient this person is related to as a reference to EEBase Patient.
relationship (Must support)
Coded value of the nature of the relationship between the patient and related person. The required ValueSet used in this case is EEBaseRelatedpersonRelationship, meaning these values MUST be exchanged. Local value sets SHOULD be mapped to the required ValueSet.
name
A name associated with the related person.
telecom (Must support)
A contact detail(s) (e.g. phone number and/or an email address) by which the related person may be contacted.
gender
The gender that the person is considered to have for administration and record keeping purposes. The required ValueSet used in this case is administrative-gender, meaning these values MUST be exchanged. Local value sets SHOULD be mapped to the required ValueSet.
HTML View
Table View
| CodeSystem.id[0] | administrative-gender |
| CodeSystem.meta[0].lastUpdated[0] | 2019-11-01T09:29:23.356+11:00 |
| CodeSystem.extension[0].url[0] | http://hl7.org/fhir/StructureDefinition/structuredefinition-wg |
| CodeSystem.extension[0].value[0] | pa |
| CodeSystem.extension[1].url[0] | http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status |
| CodeSystem.extension[1].value[0] | normative |
| CodeSystem.extension[2].url[0] | http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm |
| CodeSystem.extension[2].value[0] | 5 |
| CodeSystem.extension[3].url[0] | http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version |
| CodeSystem.extension[3].value[0] | 4.0.0 |
| CodeSystem.url[0] | http://hl7.org/fhir/administrative-gender |
| CodeSystem.identifier[0].system[0] | urn:ietf:rfc:3986 |
| CodeSystem.identifier[0].value[0] | urn:oid:2.16.840.1.113883.4.642.4.2 |
| CodeSystem.version[0] | 4.0.1 |
| CodeSystem.name[0] | AdministrativeGender |
| CodeSystem.title[0] | AdministrativeGender |
| CodeSystem.status[0] | active |
| CodeSystem.experimental[0] | False |
| CodeSystem.date[0] | 2019-11-01T09:29:23+11:00 |
| CodeSystem.description[0] | The gender of a person used for administrative purposes. |
| CodeSystem.caseSensitive[0] | True |
| CodeSystem.valueSet[0] | http://hl7.org/fhir/ValueSet/administrative-gender |
| CodeSystem.content[0] | complete |
| CodeSystem.concept[0].extension[0].url[0] | http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments |
| CodeSystem.concept[0].extension[0].value[0] | Male |
| CodeSystem.concept[0].code[0] | male |
| CodeSystem.concept[0].display[0] | Male |
| CodeSystem.concept[0].definition[0] | Male. |
| CodeSystem.concept[1].extension[0].url[0] | http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments |
| CodeSystem.concept[1].extension[0].value[0] | Female |
| CodeSystem.concept[1].code[0] | female |
| CodeSystem.concept[1].display[0] | Female |
| CodeSystem.concept[1].definition[0] | Female. |
| CodeSystem.concept[2].extension[0].url[0] | http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments |
| CodeSystem.concept[2].extension[0].value[0] | The administrative gender is a value other than male/female/unknown. Where this value is selected, systems may often choose to include an extension with the localized more specific value. |
| CodeSystem.concept[2].code[0] | other |
| CodeSystem.concept[2].display[0] | Other |
| CodeSystem.concept[2].definition[0] | Other. |
| CodeSystem.concept[3].extension[0].url[0] | http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments |
| CodeSystem.concept[3].extension[0].value[0] | A proper value is applicable, but not known. Usage Notes: This means the actual value is not known. If the only thing that is unknown is how to properly express the value in the necessary constraints (value set, datatype, etc.), then the OTH or UNC flavor should be used. No properties should be included for a datatype with this property unless: Those properties themselves directly translate to a semantic of "unknown". (E.g. a local code sent as a translation that conveys 'unknown') Those properties further qualify the nature of what is unknown. (E.g. specifying a use code of "H" and a URL prefix of "tel:" to convey that it is the home phone number that is unknown.) |
| CodeSystem.concept[3].code[0] | unknown |
| CodeSystem.concept[3].display[0] | Unknown |
| CodeSystem.concept[3].definition[0] | Unknown. |
XML View
<CodeSystem xmlns="http://hl7.org/fhir"> <id value="administrative-gender" /> <meta> <lastUpdated value="2019-11-01T09:29:23.356+11:00" /> </meta> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg"> <valueCode value="pa" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> <valueCode value="normative" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm"> <valueInteger value="5" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version"> <valueCode value="4.0.0" /> </extension> <url value="http://hl7.org/fhir/administrative-gender" /> <identifier> <system value="urn:ietf:rfc:3986" /> <value value="urn:oid:2.16.840.1.113883.4.642.4.2" /> </identifier> <version value="4.0.1" /> <name value="AdministrativeGender" /> <title value="AdministrativeGender" /> <status value="active" /> <experimental value="false" /> <date value="2019-11-01T09:29:23+11:00" /> <description value="The gender of a person used for administrative purposes." /> <caseSensitive value="true" /> <valueSet value="http://hl7.org/fhir/ValueSet/administrative-gender" /> <content value="complete" /> <concept> <extension url="http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments"> <valueString value="Male" /> </extension> <code value="male" /> <display value="Male" /> <definition value="Male." /> </concept> <concept> <extension url="http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments"> <valueString value="Female" /> </extension> <code value="female" /> <display value="Female" /> <definition value="Female." /> </concept> <concept> <extension url="http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments"> <valueString value="The administrative gender is a value other than male/female/unknown. Where this value is selected, systems may often choose to include an extension with the localized more specific value." /> </extension> <code value="other" /> <display value="Other" /> <definition value="Other." /> </concept> <concept> <extension url="http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments"> <valueString value="A proper value is applicable, but not known. Usage Notes: This means the actual value is not known. If the only thing that is unknown is how to properly express the value in the necessary constraints (value set, datatype, etc.), then the OTH or UNC flavor should be used. No properties should be included for a datatype with this property unless: Those properties themselves directly translate to a semantic of "unknown". (E.g. a local code sent as a translation that conveys 'unknown') Those properties further qualify the nature of what is unknown. (E.g. specifying a use code of "H" and a URL prefix of "tel:" to convey that it is the home phone number that is unknown.)" /> </extension> <code value="unknown" /> <display value="Unknown" /> <definition value="Unknown." /> </concept> </CodeSystem>
JSON View
{ "resourceType": "CodeSystem", "id": "administrative-gender", "meta": { "lastUpdated": "2019-11-01T09:29:23.356+11:00" }, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", "valueCode": "pa" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "normative" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger": 5 }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version", "valueCode": "4.0.0" } ], "url": "http://hl7.org/fhir/administrative-gender", "identifier": [ { "system": "urn:ietf:rfc:3986", "value": "urn:oid:2.16.840.1.113883.4.642.4.2" } ], "version": "4.0.1", "name": "AdministrativeGender", "title": "AdministrativeGender", "status": "active", "experimental": false, "date": "2019-11-01T09:29:23+11:00", "description": "The gender of a person used for administrative purposes.", "caseSensitive": true, "valueSet": "http://hl7.org/fhir/ValueSet/administrative-gender", "content": "complete", "concept": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments", "valueString": "Male" } ], "code": "male", "display": "Male", "definition": "Male." }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments", "valueString": "Female" } ], "code": "female", "display": "Female", "definition": "Female." }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments", "valueString": "The administrative gender is a value other than male/female/unknown. Where this value is selected, systems may often choose to include an extension with the localized more specific value." } ], "code": "other", "display": "Other", "definition": "Other." }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/codesystem-concept-comments", "valueString": "A proper value is applicable, but not known. Usage Notes: This means the actual value is not known. If the only thing that is unknown is how to properly express the value in the necessary constraints (value set, datatype, etc.), then the OTH or UNC flavor should be used. No properties should be included for a datatype with this property unless: Those properties themselves directly translate to a semantic of \"unknown\". (E.g. a local code sent as a translation that conveys 'unknown') Those properties further qualify the nature of what is unknown. (E.g. specifying a use code of \"H\" and a URL prefix of \"tel:\" to convey that it is the home phone number that is unknown.)" } ], "code": "unknown", "display": "Unknown", "definition": "Unknown." } ] }
birthDate
The date on which the related person was born on.
address
photo
Image of the related person.
period
The period of time during which this relationship between patient and related person is or was active.
communication
A language which may be used to communicate with related person about the patient's health.
The preferred ValueSet used in this case is languages, meaning these values SHOULD be exchanged, however other ValueSets (either local or developed and published by the community) may be used if required. In that case mapping other ValueSets to observation-category by using the ConceptMap resource is encouraged.