related_person

The US Core RelatedPerson Profile inherits from the FHIR [RelatedPerson](https://hl7.org/fhir/R4/relatedperson.html) resource; refer to it for scope and usage definitions.

The US Core RelatedPerson Profile inherits from the FHIR RelatedPerson resource; refer to it for scope and usage definitions. This profile sets minimum expectations for the RelatedPerson resource to record, search, and fetch basic administrative information about persons with a legal or familial relationship to a patient. It specifies which core elements, extensions, vocabularies, and value sets SHALL be present and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption.

Source

ModelLegRole
us-core-relatedpersonFHIRdefines this table
openEHR-EHR-CLUSTER.address.v1openEHRmerged in — Address
openEHR-EHR-CLUSTER.electronic_communication.v1openEHRmerged in — Electronic communication
This table is the union of 3 source models. Columns carrying a From value came from a model that merged into it, so the same row satisfies both specifications.

Columns

ColumnTypeNullDescriptionFromSource
iduuid primary keynoRelatedPerson.id
created_attimestamptznoRow creation timestamp.
updated_attimestamptznoRow update timestamp; maintained by the application.
created_bytextnoActor who created the row.
updated_bytextnoActor who last updated the row.
activebooleanyesWhether this related person's record is in active useRelatedPerson.active
patient_iduuidyesThe patient this person is related toRelatedPerson.patient
name_text
name_prefix
name_family
name_given
name_suffix
text, text, text, text, text
text, text, text, text, text
yesA name associated with the personRelatedPerson.name
phone_number
phone_use_code
email
email_use_code
text, text, text, text
text, text, text, text
yesA contact detail for the personRelatedPerson.telecom
address_line
address_city
address_district
address_state
address_postal_code
address_country
address_use_code
address_type_code
text, text, text, text, text, text, text, text
text, text, text, text, text, text, text, text
yesAddress where the related person can be contacted or visitedRelatedPerson.address
address_latitude_magnitude
address_latitude_units
quantity
numeric, text
yesLatitudeopenEHR-EHR-CLUSTER.address.v1/items[at0007]
address_longitude_magnitude
address_longitude_units
quantity
numeric, text
yesLongitudeopenEHR-EHR-CLUSTER.address.v1/items[at0008]
address_altitude_magnitude
address_altitude_units
quantity
numeric, text
yesAltitudeopenEHR-EHR-CLUSTER.address.v1/items[at0009]
address_commenttextyesCommentopenEHR-EHR-CLUSTER.address.v1/items[at0018]
address_map_urltextyesMap URLopenEHR-EHR-CLUSTER.address.v1/items[at0019]
address_geolocation_codetextyesGeolocation codeopenEHR-EHR-CLUSTER.address.v1/items[at0021]
phone_comment
email_comment
text, text
text, text
yesCommentopenEHR-EHR-CLUSTER.electronic_communication.v1/items[at0004]

Constraints

check ((address_latitude_magnitude is null and address_latitude_units is null) or (address_latitude_magnitude is not null and address_latitude_units is not null))
check (address_latitude_magnitude is null or (address_latitude_units = 'deg' and address_latitude_magnitude between -90 and 90))
check ((address_longitude_magnitude is null and address_longitude_units is null) or (address_longitude_magnitude is not null and address_longitude_units is not null))
check (address_longitude_magnitude is null or (address_longitude_units = 'deg' and address_longitude_magnitude between -180 and 180))
check ((address_altitude_magnitude is null and address_altitude_units is null) or (address_altitude_magnitude is not null and address_altitude_units is not null))

References

ColumnsTargetOn delete
patient_idpatientno action

Referenced by

Indexes

Child tables

4 tables hang off related_person, one row per repetition.

Child table — one row per repetition, deleted with its parent.

ColumnTypeNullDescriptionFromSource
iduuid primary keynoPrimary key.
related_person_iduuidrelated_personno
relationship
relationship_code
relationship_system
text, text, text
text, text, text
yesThe nature of the relationshipRelatedPerson.relationship

Constraints

check ((relationship_code is null and relationship_system is null) or (relationship_code is not null and relationship_system is not null))

References

ColumnsTargetOn delete
related_person_idrelated_personcascade

Indexes

Child table — one row per repetition, deleted with its parent.

ColumnTypeNullDescriptionFromSource
iduuid primary keynoPrimary key.
related_person_iduuidrelated_personno
use_codetextyes
name_texttextyes
name_prefixtextyes
name_familytextyes
name_giventextyes
name_suffixtextyes
valid_fromtimestamptzyes
valid_untiltimestamptzyes

References

ColumnsTargetOn delete
related_person_idrelated_personcascade

Indexes

Child table — one row per repetition, deleted with its parent.

ColumnTypeNullDescriptionFromSource
iduuid primary keynoPrimary key.
related_person_iduuidrelated_personno
systemtextno
valuetextno
use_codetextyes
rankintegeryes
valid_fromtimestamptzyes
valid_untiltimestamptzyes
commenttextyesCommentopenEHR-EHR-CLUSTER.electronic_communication.v1/items[at0004]

References

ColumnsTargetOn delete
related_person_idrelated_personcascade

Indexes

Child table — one row per repetition, deleted with its parent.

ColumnTypeNullDescriptionFromSource
iduuid primary keynoPrimary key.
related_person_iduuidrelated_personno
address_linetextyesnewline-delimited for multiple lines
address_citytextyes
address_districttextyes
address_statetextyes
address_postal_codetextyes
address_countrytextyes
use_codetextyes
type_codetextyes
valid_fromtimestamptzyes
valid_untiltimestamptzyes
address_latitude_magnitude
address_latitude_units
quantity
numeric, text
yesLatitudeopenEHR-EHR-CLUSTER.address.v1/items[at0007]
address_longitude_magnitude
address_longitude_units
quantity
numeric, text
yesLongitudeopenEHR-EHR-CLUSTER.address.v1/items[at0008]
address_altitude_magnitude
address_altitude_units
quantity
numeric, text
yesAltitudeopenEHR-EHR-CLUSTER.address.v1/items[at0009]
address_commenttextyesCommentopenEHR-EHR-CLUSTER.address.v1/items[at0018]
address_map_urltextyesMap URLopenEHR-EHR-CLUSTER.address.v1/items[at0019]
address_geolocation_codetextyesGeolocation codeopenEHR-EHR-CLUSTER.address.v1/items[at0021]

Constraints

check ((address_latitude_magnitude is null and address_latitude_units is null) or (address_latitude_magnitude is not null and address_latitude_units is not null))
check (address_latitude_magnitude is null or (address_latitude_units = 'deg' and address_latitude_magnitude between -90 and 90))
check ((address_longitude_magnitude is null and address_longitude_units is null) or (address_longitude_magnitude is not null and address_longitude_units is not null))
check (address_longitude_magnitude is null or (address_longitude_units = 'deg' and address_longitude_magnitude between -180 and 180))
check ((address_altitude_magnitude is null and address_altitude_units is null) or (address_altitude_magnitude is not null and address_altitude_units is not null))

References

ColumnsTargetOn delete
related_person_idrelated_personcascade

Indexes