Skip to main content

RelatedPerson

PropertyValue
Publisher
NameRelatedPerson
URLhttp://hl7.org/fhir/StructureDefinition/RelatedPerson
Statusdraft
Description
Abstractfalse

Structure

PathCardinalityTypeDescription
RelatedPerson0..*RelatedPersonInformation 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.id0..1http://hl7.org/fhirpath/System.StringThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
RelatedPerson.meta0..1MetaThe 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.implicitRules0..1uriA 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.language0..1codeThe base language in which the resource is written.
RelatedPerson.text0..1NarrativeA 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.contained0..*ResourceThese 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.extension0..*ExtensionMay 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.modifierExtension0..*ExtensionMay 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.identifier0..*IdentifierIdentifier for a person within a particular scope.
RelatedPerson.active0..1booleanWhether this related person record is in active use.
RelatedPerson.patient1..1ReferenceThe patient this person is related to.
RelatedPerson.relationship0..*CodeableConceptThe nature of the relationship between a patient and the related person.
RelatedPerson.name0..*HumanNameA name associated with the person.
RelatedPerson.telecom0..*ContactPointA contact detail for the person, e.g. a telephone number or an email address.
RelatedPerson.gender0..1codeAdministrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
RelatedPerson.birthDate0..1dateThe date on which the related person was born.
RelatedPerson.address0..*AddressAddress where the related person can be contacted or visited.
RelatedPerson.photo0..*AttachmentImage of the person.
RelatedPerson.period0..1PeriodThe period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknown.
RelatedPerson.communication0..*BackboneElementA language which may be used to communicate with about the patient's health.
RelatedPerson.communication.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
RelatedPerson.communication.extension0..*ExtensionMay 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.modifierExtension0..*ExtensionMay 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.language1..1CodeableConceptThe 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.preferred0..1booleanIndicates whether or not the patient prefers this language (over other languages he masters up a certain level).

Search Parameters

NameTypeDescriptionExpression
_textstringSearch on the narrative of the resource
_contentstringSearch on the entire content of the resource
_idtokenLogical id of this artifactResource.id
_lastUpdateddateWhen the resource version last changedResource.meta.lastUpdated
_profileuriProfiles this resource claims to conform toResource.meta.profile
_querytokenA custom search profile that describes a specific defined query operation
_securitytokenSecurity Labels applied to this resourceResource.meta.security
_sourceuriIdentifies where the resource comes fromResource.meta.source
_tagtokenTags applied to this resourceResource.meta.tag
addressstringMultiple 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 textPatient.address / Person.address / Practitioner.address / RelatedPerson.address
address-citystringMultiple 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 addressPatient.address.city / Person.address.city / Practitioner.address.city / RelatedPerson.address.city
address-countrystringMultiple 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 addressPatient.address.country / Person.address.country / Practitioner.address.country / RelatedPerson.address.country
address-postalcodestringMultiple 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 addressPatient.address.postalCode / Person.address.postalCode / Practitioner.address.postalCode / RelatedPerson.address.postalCode
address-statestringMultiple 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 addressPatient.address.state / Person.address.state / Practitioner.address.state / RelatedPerson.address.state
address-usetokenMultiple 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 addressPatient.address.use / Person.address.use / Practitioner.address.use / RelatedPerson.address.use
birthdatedateMultiple Resources: * Patient: The patient's date of birth* Person: The person's date of birth* RelatedPerson: The Related Person's date of birthPatient.birthDate / Person.birthDate / RelatedPerson.birthDate
emailtokenMultiple 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 contactPatient.telecom.where(system='email') / Person.telecom.where(system='email') / Practitioner.telecom.where(system='email') / PractitionerRole.telecom.where(system='email') / RelatedPerson.telecom.where(system='email')
gendertokenMultiple Resources: * Patient: Gender of the patient* Person: The gender of the person* Practitioner: Gender of the practitioner* RelatedPerson: Gender of the related personPatient.gender / Person.gender / Practitioner.gender / RelatedPerson.gender
phonetokenMultiple 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 contactPatient.telecom.where(system='phone') / Person.telecom.where(system='phone') / Practitioner.telecom.where(system='phone') / PractitionerRole.telecom.where(system='phone') / RelatedPerson.telecom.where(system='phone')
phoneticstringMultiple 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 algorithmPatient.name / Person.name / Practitioner.name / RelatedPerson.name
telecomtokenMultiple 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 contactPatient.telecom / Person.telecom / Practitioner.telecom / PractitionerRole.telecom / RelatedPerson.telecom
activetokenIndicates if the related person record is activeRelatedPerson.active
identifiertokenAn Identifier of the RelatedPersonRelatedPerson.identifier
namestringA server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or textRelatedPerson.name
patientreferenceThe patient this related person is related toRelatedPerson.patient
relationshiptokenThe relationship between the patient and the relatedpersonRelatedPerson.relationship
_iguhealth-version-seqnumberThe version sequence of the resourceResource.meta.extension.where(url='https://iguhealth.app/version-sequence').value
_iguhealth-authorreferenceThe author of the resourceResource.meta.extension.where(url='https://iguhealth.app/author').value