RelatedPerson
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.
Properties
Name | Required | Type | Description |
---|---|---|---|
identifier | Identifier[] | A human identifier for this person DetailsIdentifier for a person within a particular scope. | |
active | boolean | Whether this related person's record is in active use DetailsWhether this related person record is in active use. This element is labeled as a modifier because it may be used to mark that the resource was created in error. | |
patient | ✓ | Reference<Patient> | The patient this person is related to DetailsThe patient this person is related to. |
relationship | CodeableConcept[] | The nature of the relationship DetailsThe nature of the relationship between a patient and the related person. | |
name | HumanName[] | A name associated with the person DetailsA name associated with the person. | |
telecom | ContactPoint[] | A contact detail for the person DetailsA contact detail for the person, e.g. a telephone number or an email address. 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 | code | male | female | other | unknown DetailsAdministrative Gender - the gender that the person is considered to have for administration and record keeping purposes. | |
birthDate | date | The date on which the related person was born DetailsThe date on which the related person was born. | |
address | Address[] | Address where the related person can be contacted or visited DetailsAddress where the related person can be contacted or visited. | |
photo | Attachment[] | Image of the person DetailsImage of the person. | |
period | Period | Period of time that this relationship is considered valid DetailsThe period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknown. | |
communication | RelatedPersonCommunication[] | A language which may be used to communicate with about the patient's health DetailsA language which may be used to communicate with about the patient's health. 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 | string | Unique id for inter-element referencing DetailsUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
extension | Extension[] | Additional content defined by implementations DetailsMay 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. | |
modifierExtension | Extension[] | Extensions that cannot be ignored even if unrecognized DetailsMay 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). 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 | ✓ | CodeableConcept | The language which can be used to communicate with the patient about his or her health DetailsThe 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. 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. |
preferred | boolean | Language preference indicator DetailsIndicates whether or not the patient prefers this language (over other languages he masters up a certain level). This language is specifically identified for communicating healthcare information. |
Search Parameters
Name | Type | Description | Expression |
---|---|---|---|
address | string | A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text | RelatedPerson.address |
address-city | string | A city specified in an address | RelatedPerson.address.city |
address-country | string | A country specified in an address | RelatedPerson.address.country |
address-postalcode | string | A postal code specified in an address | RelatedPerson.address.postalCode |
address-state | string | A state specified in an address | RelatedPerson.address.state |
address-use | token | A use code specified in an address | RelatedPerson.address.use |
birthdate | date | The Related Person's date of birth | RelatedPerson.birthDate |
token | A value in an email contact | RelatedPerson.telecom | |
gender | token | Gender of the related person | RelatedPerson.gender |
phone | token | A value in a phone contact | RelatedPerson.telecom |
phonetic | string | A portion of name using some kind of phonetic matching algorithm | RelatedPerson.name |
telecom | token | The value in any kind of contact | RelatedPerson.telecom |
active | token | Indicates if the related person record is active | RelatedPerson.active |
identifier | token | An Identifier of the RelatedPerson | RelatedPerson.identifier |
name | string | A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text | RelatedPerson.name |
patient | reference | The patient this related person is related to | RelatedPerson.patient |
relationship | token | The relationship between the patient and the relatedperson | RelatedPerson.relationship |
Inherited Properties
Name | Required | Type | Description |
---|---|---|---|
id | string | Logical id of this artifact DetailsThe 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 | Meta | Metadata about the resource DetailsThe 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 | uri | A set of rules under which this content was created DetailsA 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 | code | Language of the resource content DetailsThe 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). | |
text | Narrative | Text summary of the resource, for human interpretation DetailsA 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 | Resource[] | Contained, inline Resources DetailsThese 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 | Extension[] | Additional content defined by implementations DetailsMay 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. | |
modifierExtension | Extension[] | Extensions that cannot be ignored DetailsMay 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). 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. |