US Core Implementation Guide
10.0.0-ballot - STU 10 Ballot United States of America flag

US Core Implementation Guide, published by HL7 International / Cross-Group Projects. This guide is not an authorized publication; it is the continuous build for version 10.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/US-Core/ and changes regularly. See the Directory of published versions

Resource Profile: US Core RelatedPerson Profile

Official URL: http://hl7.org/fhir/us/core/StructureDefinition/us-core-relatedperson Version: 10.0.0-ballot
Standards status: Trial-use Maturity Level: 5 Computable Name: USCoreRelatedPersonProfile
Other Identifiers: OID:2.16.840.1.113883.4.642.40.2.42.58

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.

US Core Maturity: 4

Example Usage Scenarios:

The following are example usage scenarios for this profile:

  • Query for a related person that supports the patient.
  • Query for a person related to the patient by name.

Mandatory and Must Support Data Elements

The following data elements must always be present (Mandatory definition) or must be supported if the data is present in the sending system (Must Support definition). They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Views below provides the formal summary, definitions, and terminology requirements.

Each RelatedPerson Must Have:

  1. an active flag
  2. a patient

Each RelatedPerson Must Support:

  1. the relationship to the patient
  2. the name of the related person
  3. the telecom of the related person
  4. the address of the related person1

1 see guidance below

Profile Specific Implementation Guidance

This section provides detailed implementation guidance for the US Core Profile to support implementation and certification.

  • 1 For RelatedPerson.address.state, this profile uses USPS Two Letter Alphabetic Codes for US states. When encoding addresses outside the US, systems SHOULD use the ISO 3166 subdivision codes.§

  • For the USCDI Healthcare Agent Data Element, systems SHOULD use the durable power of attorney code DPOWATT or the healthcare power of attorney code HPOWATT in RelatedPerson.relationship.§ For a more detailed model that builds on the US Core RelatedPerson Profile to represent a healthcare agent, including consent-based delegation and role and priority coding, see the PACIO ADI PACP Guidance and the ADI Healthcare Agent Participant profile.

Usages:

You can also check for usages in the FHIR IG Statistics

Changes since version 9.0.0:

  • The data elements list has changed

    • Formal Views of Profile Content

    Description of Profiles, Differentials, Snapshots and how the different presentations work.

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    RelatedPerson C 0..* RelatedPerson A person that is related to a patient, but who is not a direct target of care
    Constraints: us-core-14
    RelatedPerson.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    RelatedPerson.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    RelatedPerson.active This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 boolean Whether this related person's record is in active use
    RelatedPerson.patient This element must be supported. This element is included in summaries. 1..1 Reference(US Core Patient Profile) The patient this person is related to
    RelatedPerson.relationship This element must be supported. This element is included in summaries. C 0..* CodeableConcept The nature of the relationship
    Binding: Personal And Legal Relationship Role Type (extensible): Personal And Legal Relationship Role Type
    RelatedPerson.name This element must be supported. This element is included in summaries. C 0..* HumanName A name associated with the person
    RelatedPerson.telecom This element must be supported. This element is included in summaries. 0..* ContactPoint A contact detail for the person
    RelatedPerson.address This element must be supported. This element is included in summaries. 0..* Address Address where the related person can be contacted or visited

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    RelatedPerson.relationship Base extensible Personal And Legal Relationship Role Type ⏿20251204 tx.fhir.org

    Constraints

    Id Grade Path(s) Description Expression
    us-core-14 error RelatedPerson Either a name or a relationship SHALL be provided (or both) name.exists() or relationship.exists()

    This structure is derived from RelatedPerson

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    RelatedPerson C 0..* RelatedPerson A person that is related to a patient, but who is not a direct target of care
    Constraints: us-core-14
    RelatedPerson.active This element must be supported. 1..1 boolean Whether this related person's record is in active use
    RelatedPerson.patient This element must be supported. 1..1 Reference(US Core Patient Profile) The patient this person is related to
    RelatedPerson.relationship This element must be supported. C 0..* CodeableConcept The nature of the relationship
    Binding: Personal And Legal Relationship Role Type (extensible): Personal And Legal Relationship Role Type
    RelatedPerson.name This element must be supported. C 0..* HumanName A name associated with the person
    RelatedPerson.telecom This element must be supported. 0..* ContactPoint A contact detail for the person
    RelatedPerson.address This element must be supported. 0..* Address Address where the related person can be contacted or visited

    doco Documentation for this format

    Terminology Bindings (Differential)

    Path Status Usage ValueSet Version Source
    RelatedPerson.relationship Base extensible Personal And Legal Relationship Role Type ⏿20251204 tx.fhir.org

    Constraints

    Id Grade Path(s) Description Expression
    us-core-14 error RelatedPerson Either a name or a relationship SHALL be provided (or both) name.exists() or relationship.exists()
    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    RelatedPerson C 0..* RelatedPerson A person that is related to a patient, but who is not a direct target of care
    Constraints: us-core-14
    RelatedPerson.id This element is included in summaries. 0..1 id Logical id of this artifact
    RelatedPerson.meta This element is included in summaries. 0..1 Meta Metadata about the resource
    RelatedPerson.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    RelatedPerson.language 0..1 code Language of the resource content
    Binding: CommonLanguages (preferred): A human language.
    Additional BindingsPurpose
    AllLanguages Max Binding
    RelatedPerson.text 0..1 Narrative Text summary of the resource, for human interpretation
    This profile does not constrain the narrative in regard to content, language, or traceability to data elements
    RelatedPerson.contained 0..* Resource Contained, inline Resources
    RelatedPerson.extension 0..* Extension Additional content defined by implementations
    RelatedPerson.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    RelatedPerson.identifier This element is included in summaries. 0..* Identifier A human identifier for this person
    RelatedPerson.active This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 boolean Whether this related person's record is in active use
    RelatedPerson.patient This element must be supported. This element is included in summaries. 1..1 Reference(US Core Patient Profile) The patient this person is related to
    RelatedPerson.relationship This element must be supported. This element is included in summaries. C 0..* CodeableConcept The nature of the relationship
    Binding: Personal And Legal Relationship Role Type (extensible): Personal And Legal Relationship Role Type
    RelatedPerson.name This element must be supported. This element is included in summaries. C 0..* HumanName A name associated with the person
    RelatedPerson.telecom This element must be supported. This element is included in summaries. 0..* ContactPoint A contact detail for the person
    RelatedPerson.gender This element is included in summaries. 0..1 code male | female | other | unknown
    Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
    RelatedPerson.birthDate This element is included in summaries. 0..1 date The date on which the related person was born
    RelatedPerson.address This element must be supported. This element is included in summaries. 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 Period of time that this relationship is considered valid
    RelatedPerson.communication 0..* BackboneElement A language which may be used to communicate with about the patient's health
    RelatedPerson.communication.id 0..1 string Unique id for inter-element referencing
    RelatedPerson.communication.extension 0..* Extension Additional content defined by implementations
    RelatedPerson.communication.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    RelatedPerson.communication.language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
    Binding: CommonLanguages (preferred): A human language.
    Additional BindingsPurpose
    AllLanguages Max Binding
    RelatedPerson.communication.preferred 0..1 boolean Language preference indicator

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    RelatedPerson.language Base preferred Common Languages 📍4.0.1 FHIR Std.
    RelatedPerson.relationship Base extensible Personal And Legal Relationship Role Type ⏿20251204 tx.fhir.org
    RelatedPerson.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
    RelatedPerson.communication.​language Base preferred Common Languages 📍4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression
    us-core-14 error RelatedPerson Either a name or a relationship SHALL be provided (or both) name.exists() or relationship.exists()

    This structure is derived from RelatedPerson

    Summary

    Mandatory: 1 element
    Must-Support: 6 elements

    Structures

    This structure refers to these other structures:

    Maturity: 5

    Key Elements View

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    RelatedPerson C 0..* RelatedPerson A person that is related to a patient, but who is not a direct target of care
    Constraints: us-core-14
    RelatedPerson.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    RelatedPerson.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    RelatedPerson.active This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 boolean Whether this related person's record is in active use
    RelatedPerson.patient This element must be supported. This element is included in summaries. 1..1 Reference(US Core Patient Profile) The patient this person is related to
    RelatedPerson.relationship This element must be supported. This element is included in summaries. C 0..* CodeableConcept The nature of the relationship
    Binding: Personal And Legal Relationship Role Type (extensible): Personal And Legal Relationship Role Type
    RelatedPerson.name This element must be supported. This element is included in summaries. C 0..* HumanName A name associated with the person
    RelatedPerson.telecom This element must be supported. This element is included in summaries. 0..* ContactPoint A contact detail for the person
    RelatedPerson.address This element must be supported. This element is included in summaries. 0..* Address Address where the related person can be contacted or visited

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    RelatedPerson.relationship Base extensible Personal And Legal Relationship Role Type ⏿20251204 tx.fhir.org

    Constraints

    Id Grade Path(s) Description Expression
    us-core-14 error RelatedPerson Either a name or a relationship SHALL be provided (or both) name.exists() or relationship.exists()

    Differential View

    This structure is derived from RelatedPerson

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    RelatedPerson C 0..* RelatedPerson A person that is related to a patient, but who is not a direct target of care
    Constraints: us-core-14
    RelatedPerson.active This element must be supported. 1..1 boolean Whether this related person's record is in active use
    RelatedPerson.patient This element must be supported. 1..1 Reference(US Core Patient Profile) The patient this person is related to
    RelatedPerson.relationship This element must be supported. C 0..* CodeableConcept The nature of the relationship
    Binding: Personal And Legal Relationship Role Type (extensible): Personal And Legal Relationship Role Type
    RelatedPerson.name This element must be supported. C 0..* HumanName A name associated with the person
    RelatedPerson.telecom This element must be supported. 0..* ContactPoint A contact detail for the person
    RelatedPerson.address This element must be supported. 0..* Address Address where the related person can be contacted or visited

    doco Documentation for this format

    Terminology Bindings (Differential)

    Path Status Usage ValueSet Version Source
    RelatedPerson.relationship Base extensible Personal And Legal Relationship Role Type ⏿20251204 tx.fhir.org

    Constraints

    Id Grade Path(s) Description Expression
    us-core-14 error RelatedPerson Either a name or a relationship SHALL be provided (or both) name.exists() or relationship.exists()

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    RelatedPerson C 0..* RelatedPerson A person that is related to a patient, but who is not a direct target of care
    Constraints: us-core-14
    RelatedPerson.id This element is included in summaries. 0..1 id Logical id of this artifact
    RelatedPerson.meta This element is included in summaries. 0..1 Meta Metadata about the resource
    RelatedPerson.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
    RelatedPerson.language 0..1 code Language of the resource content
    Binding: CommonLanguages (preferred): A human language.
    Additional BindingsPurpose
    AllLanguages Max Binding
    RelatedPerson.text 0..1 Narrative Text summary of the resource, for human interpretation
    This profile does not constrain the narrative in regard to content, language, or traceability to data elements
    RelatedPerson.contained 0..* Resource Contained, inline Resources
    RelatedPerson.extension 0..* Extension Additional content defined by implementations
    RelatedPerson.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
    RelatedPerson.identifier This element is included in summaries. 0..* Identifier A human identifier for this person
    RelatedPerson.active This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 boolean Whether this related person's record is in active use
    RelatedPerson.patient This element must be supported. This element is included in summaries. 1..1 Reference(US Core Patient Profile) The patient this person is related to
    RelatedPerson.relationship This element must be supported. This element is included in summaries. C 0..* CodeableConcept The nature of the relationship
    Binding: Personal And Legal Relationship Role Type (extensible): Personal And Legal Relationship Role Type
    RelatedPerson.name This element must be supported. This element is included in summaries. C 0..* HumanName A name associated with the person
    RelatedPerson.telecom This element must be supported. This element is included in summaries. 0..* ContactPoint A contact detail for the person
    RelatedPerson.gender This element is included in summaries. 0..1 code male | female | other | unknown
    Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
    RelatedPerson.birthDate This element is included in summaries. 0..1 date The date on which the related person was born
    RelatedPerson.address This element must be supported. This element is included in summaries. 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 Period of time that this relationship is considered valid
    RelatedPerson.communication 0..* BackboneElement A language which may be used to communicate with about the patient's health
    RelatedPerson.communication.id 0..1 string Unique id for inter-element referencing
    RelatedPerson.communication.extension 0..* Extension Additional content defined by implementations
    RelatedPerson.communication.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
    RelatedPerson.communication.language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
    Binding: CommonLanguages (preferred): A human language.
    Additional BindingsPurpose
    AllLanguages Max Binding
    RelatedPerson.communication.preferred 0..1 boolean Language preference indicator

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    RelatedPerson.language Base preferred Common Languages 📍4.0.1 FHIR Std.
    RelatedPerson.relationship Base extensible Personal And Legal Relationship Role Type ⏿20251204 tx.fhir.org
    RelatedPerson.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
    RelatedPerson.communication.​language Base preferred Common Languages 📍4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression
    us-core-14 error RelatedPerson Either a name or a relationship SHALL be provided (or both) name.exists() or relationship.exists()

    This structure is derived from RelatedPerson

    Summary

    Mandatory: 1 element
    Must-Support: 6 elements

    Structures

    This structure refers to these other structures:

    Maturity: 5

     

    Other representations of profile: CSV, Excel, Schematron

    Notes:

    Quick Start

    Below is an overview of the required Server RESTful FHIR interactions for this profile - for example, search and read operations - when supporting the US Core interactions to access this profile's information (Profile Support + Interaction Support). Note that systems that support only US Core Profiles (Profile Only Support) are not required to support these interactions. See the US Core Server CapabilityStatement for a complete list of supported RESTful interactions for this IG.

    • See the Scopes Format section for a description of the SMART scopes syntax.
    • See the Search Syntax section for a description of the US Core search syntax.
    • See the General Requirements section for additional rules and expectations when a Server requires status parameters.
    • See the General Guidance section for additional guidance on searching for multiple patients.

    US Core Scopes

    Servers providing access to related person data SHALL support these US Core SMART Scopes:

    Mandatory Search Parameters:

    The following search parameters and search parameter combinations SHALL be supported:

    1. SHALL support both read RelatedPerson by id AND RelatedPerson search using the _id search parameter

      GET [base]/RelatedPerson?_id=[id]' or 'GET [base]/RelatedPerson/[id]

      Examples:

      1. GET [base]/RelatedPerson/shaw-niece

      2. GET [base]/RelatedPerson?_id=shaw-niece

      Implementation Notes: Fetches a US Core RelatedPerson Profile resource or a search Bundle containing a US Core RelatedPerson Profile resource matching the id (see Parameters for all resources).

    Optional Search Parameters:

    The following search parameters and search parameter combinations SHOULD be supported

    1. SHOULD support searching for a patient by a server defined search that matches any of the string fields in the HumanName, including family, given, prefix, suffix, and/or text using the name search parameter

      GET [base]/RelatedPerson?name=[name]

      Example:

      1. GET [base]/RelatedPerson?name=Mary Shaw

      Implementation Notes: Fetches a bundle of all US Core RelatedPerson Profile resources matching the name ( see how to search by string).

    2. SHOULD support searching for all relatedpersons for a patient using the patient search parameter

      GET [base]/RelatedPerson?patient={Patient/}[id]

      Example:

      1. GET [base]/RelatedPerson?patient=Patient/1137192

      Implementation Notes: Fetches a bundle of all US Core RelatedPerson Profile resources for the specified patient ( see how to search by reference).

    3. SHOULD support searching using the combination of the patient and name search parameters

      GET [base]/RelatedPerson?patient={Patient/}[id]&name=[name]

      Example:

      1. GET [base]/RelatedPerson?patient=Patient/1137192&name=van%20Putten

      Implementation Notes: Fetches a bundle of all US Core RelatedPerson Profile resources for the specified patient that may match any of the string fields in the name element (including family, give, prefix, suffix, suffix, and/or text) ( see how to search by reference and how to search by string).