RelatedPerson
| Property | Value |
|---|---|
| Publisher | |
| Name | RelatedPerson |
| URL | http://hl7.org/fhir/StructureDefinition/RelatedPerson |
| Status | draft |
| Description | |
| Abstract | false |
Structure
| Path | Cardinality | Type | Description |
|---|---|---|---|
| RelatedPerson | 0..* | 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. |
| RelatedPerson.id | 0..1 | http://hl7.org/fhirpath/System.String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
| RelatedPerson.meta | 0..1 | Meta | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
| RelatedPerson.implicitRules | 0..1 | uri | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
| RelatedPerson.language | 0..1 | code | The base language in which the resource is written. |
| RelatedPerson.text | 0..1 | Narrative | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
| RelatedPerson.contained | 0..* | Resource | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
| RelatedPerson.extension | 0..* | Extension | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| RelatedPerson.modifierExtension | 0..* | Extension | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| RelatedPerson.identifier | 0..* | Identifier | Identifier for a person within a particular scope. |
| RelatedPerson.active | 0..1 | boolean | Whether this related person record is in active use. |
| RelatedPerson.patient | 1..1 | Reference | The patient this person is related to. |
| RelatedPerson.relationship | 0..* | CodeableConcept | The nature of the relationship between a patient and the related person. |
| RelatedPerson.name | 0..* | HumanName | A name associated with the person. |
| RelatedPerson.telecom | 0..* | ContactPoint | A contact detail for the person, e.g. a telephone number or an email address. |
| RelatedPerson.gender | 0..1 | code | Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes. |
| RelatedPerson.birthDate | 0..1 | date | The date on which the related person was born. |
| RelatedPerson.address | 0..* | Address | Address where the related person can be contacted or visited. |
| RelatedPerson.photo | 0..* | Attachment | Image of the person. |
| RelatedPerson.period | 0..1 | Period | The period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknown. |
| RelatedPerson.communication | 0..* | BackboneElement | A language which may be used to communicate with about the patient's health. |
| RelatedPerson.communication.id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| RelatedPerson.communication.extension | 0..* | Extension | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| RelatedPerson.communication.modifierExtension | 0..* | Extension | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| RelatedPerson.communication.language | 1..1 | CodeableConcept | The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" for England English. |
| RelatedPerson.communication.preferred | 0..1 | boolean | Indicates whether or not the patient prefers this language (over other languages he masters up a certain level). |
Search Parameters
| Name | Type | Description | Expression |
|---|---|---|---|
| _text | string | Search on the narrative of the resource | |
| _content | string | Search on the entire content of the resource | |
| _filter | token | Filter search parameter which supports a more sophisticated grammar for searching. See documentation for further details | |
| _has | string | Provides limited support for reverse chaining - that is, selecting resources based on the properties of resources that refer to them (instead of chaining where resources can be selected based on the properties of resources that they refer to). See the FHIR search page for further documentation | |
| _id | token | Logical id of this artifact | Resource.id |
| _lastUpdated | date | When the resource version last changed | Resource.meta.lastUpdated |
| _list | string | All resources in nominated list (by id, Type/id, url or one of the magic List types) | |
| _profile | uri | Profiles this resource claims to conform to | Resource.meta.profile |
| _query | token | A custom search profile that describes a specific defined query operation | |
| _security | token | Security Labels applied to this resource | Resource.meta.security |
| _source | uri | Identifies where the resource comes from | Resource.meta.source |
| _tag | token | Tags applied to this resource | Resource.meta.tag |
| _text | string | Search on the narrative text (html) of the resource | |
| _type | token | Used when a search is performed in a context which doesn't limit the search to indicate which types are being searched. See the FHIR search page for further discussion | |
| address | string | Multiple Resources: * Patient: 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* Person: 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* Practitioner: 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: 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 | Patient.address / Person.address / Practitioner.address / RelatedPerson.address |
| address-city | string | Multiple Resources: * Patient: A city specified in an address* Person: A city specified in an address* Practitioner: A city specified in an address* RelatedPerson: A city specified in an address | Patient.address.city / Person.address.city / Practitioner.address.city / RelatedPerson.address.city |
| address-country | string | Multiple Resources: * Patient: A country specified in an address* Person: A country specified in an address* Practitioner: A country specified in an address* RelatedPerson: A country specified in an address | Patient.address.country / Person.address.country / Practitioner.address.country / RelatedPerson.address.country |
| address-postalcode | string | Multiple Resources: * Patient: A postalCode specified in an address* Person: A postal code specified in an address* Practitioner: A postalCode specified in an address* RelatedPerson: A postal code specified in an address | Patient.address.postalCode / Person.address.postalCode / Practitioner.address.postalCode / RelatedPerson.address.postalCode |
| address-state | string | Multiple Resources: * Patient: A state specified in an address* Person: A state specified in an address* Practitioner: A state specified in an address* RelatedPerson: A state specified in an address | Patient.address.state / Person.address.state / Practitioner.address.state / RelatedPerson.address.state |
| address-use | token | Multiple Resources: * Patient: A use code specified in an address* Person: A use code specified in an address* Practitioner: A use code specified in an address* RelatedPerson: A use code specified in an address | Patient.address.use / Person.address.use / Practitioner.address.use / RelatedPerson.address.use |
| birthdate | date | Multiple Resources: * Patient: The patient's date of birth* Person: The person's date of birth* RelatedPerson: The Related Person's date of birth | Patient.birthDate / Person.birthDate / RelatedPerson.birthDate |
| token | Multiple Resources: * Patient: A value in an email contact* Person: A value in an email contact* Practitioner: A value in an email contact* PractitionerRole: A value in an email contact* RelatedPerson: A value in an email contact | Patient.telecom.where(system='email') / Person.telecom.where(system='email') / Practitioner.telecom.where(system='email') / PractitionerRole.telecom.where(system='email') / RelatedPerson.telecom.where(system='email') | |
| gender | token | Multiple Resources: * Patient: Gender of the patient* Person: The gender of the person* Practitioner: Gender of the practitioner* RelatedPerson: Gender of the related person | Patient.gender / Person.gender / Practitioner.gender / RelatedPerson.gender |
| phone | token | Multiple Resources: * Patient: A value in a phone contact* Person: A value in a phone contact* Practitioner: A value in a phone contact* PractitionerRole: A value in a phone contact* RelatedPerson: A value in a phone contact | Patient.telecom.where(system='phone') / Person.telecom.where(system='phone') / Practitioner.telecom.where(system='phone') / PractitionerRole.telecom.where(system='phone') / RelatedPerson.telecom.where(system='phone') |
| phonetic | string | Multiple Resources: * Patient: A portion of either family or given name using some kind of phonetic matching algorithm* Person: A portion of name using some kind of phonetic matching algorithm* Practitioner: A portion of either family or given name using some kind of phonetic matching algorithm* RelatedPerson: A portion of name using some kind of phonetic matching algorithm | Patient.name / Person.name / Practitioner.name / RelatedPerson.name |
| telecom | token | Multiple Resources: * Patient: The value in any kind of telecom details of the patient* Person: The value in any kind of contact* Practitioner: The value in any kind of contact* PractitionerRole: The value in any kind of contact* RelatedPerson: The value in any kind of contact | Patient.telecom / Person.telecom / Practitioner.telecom / PractitionerRole.telecom / 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 |