US Quality Core Implementation Guide
1.0.0-ballot - STU 1 - ballot United States of America flag

US Quality Core Implementation Guide, published by HL7 International / Clinical Quality Information. This guide is not an authorized publication; it is the continuous build for version 1.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/fhir-us-quality-core/ and changes regularly. See the Directory of published versions

Resource Profile: US Quality Core RelatedPerson

Official URL: http://hl7.org/fhir/us/quality-core/StructureDefinition/us-quality-core-relatedperson Version: 1.0.0-ballot
Standards status: Trial-use Maturity Level: 4 Computable Name: USQualityCoreRelatedPerson
Other Identifiers: OID:2.16.840.1.113883.4.642.40.78.42.46

Profile of RelatedPerson for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.

USCDI+ Quality Element Support Expectations

Systems are expected to support this profile as part of implementing USCDI+ Quality V2 in FHIR and meeting the conformance requirements of this guide.

The following elements are specifically relevant to USCDI+ Quality V2 data classes and elements. Systems are expected to support these elements as applicable to their role in US Quality Core data exchange. See the Must Support section of this guide for more information. These elements are flagged as (USCDI+ Quality) in the formal profile views.

USCDI+ Quality Elements:

Profile element Description USCDI+ Quality Data Element(s)
address Address where the related person can be contacted or visited Care Team Members: Care Team Member Location
name A name associated with the person Care Team Members: Care Team Member Name, Patient Demographics/Information: Related Person's Name
relationship The nature of the relationship Care Team Members: Care Team Member Role, Patient Demographics/Information: Relationship Type
telecom A contact detail for the person Care Team Members: Care Team Member Telecom

Because this profile is derived directly or indirectly from US Core, systems are also expected to support the Must Support and Additional USCDI requirements specified by the US Core profile this profile inherits from. For more information about those requirements, refer to the US Core RelatedPerson Profile. The Formal Views section also provides the formal summary, definitions, terminology requirements, and mandatory element requirements.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson C 0..* USCoreRelatedPersonProfile(9.0.0) A person that is related to a patient, but who is not a direct target of care
Constraints: us-core-14
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... active ?!SΣ 1..1 boolean Whether this related person's record is in active use
... relationship SΣC 0..* CodeableConcept (USCDI+ Quality) The nature of the relationship
Binding: Personal And Legal Relationship Role Type . (preferred): Personal And Legal Relationship Role Type
... name SΣC 0..* HumanName (USCDI+ Quality) A name associated with the person
... telecom SΣ 0..* ContactPoint (USCDI+ Quality) A contact detail for the person
... address SΣ 0..* Address (USCDI+ Quality) 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 preferred Personal And Legal Relationship Role Type . ⏿20251204 tx.fhir.org

Constraints

Id Grade Path(s) Description Expression
dom-2 error RelatedPerson If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error RelatedPerson If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error RelatedPerson If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error RelatedPerson If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice RelatedPerson A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
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: Filtersdoco
.. RelatedPerson 0..* USCoreRelatedPersonProfile(9.0.0) A person that is related to a patient, but who is not a direct target of care
... patient 1..1 Reference(US Quality Core Patient) The patient this person is related to
... relationship 0..* CodeableConcept (USCDI+ Quality) The nature of the relationship
... name 0..* HumanName (USCDI+ Quality) A name associated with the person
... address 0..* Address (USCDI+ Quality) Address where the related person can be contacted or visited

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson C 0..* USCoreRelatedPersonProfile(9.0.0) A person that is related to a patient, but who is not a direct target of care
Constraints: us-core-14
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... 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
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier A human identifier for this person
... active ?!SΣ 1..1 boolean Whether this related person's record is in active use
... patient SΣ 1..1 Reference(US Quality Core Patient) The patient this person is related to
... relationship SΣC 0..* CodeableConcept (USCDI+ Quality) The nature of the relationship
Binding: Personal And Legal Relationship Role Type . (preferred): Personal And Legal Relationship Role Type
... name SΣC 0..* HumanName (USCDI+ Quality) A name associated with the person
... telecom SΣ 0..* ContactPoint (USCDI+ Quality) A contact detail for the person
... gender Σ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate Σ 0..1 date The date on which the related person was born
... address SΣ 0..* Address (USCDI+ Quality) Address where the related person can be contacted or visited
... photo 0..* Attachment Image of the person
... period 0..1 Period Period of time that this relationship is considered valid
... communication 0..* BackboneElement A language which may be used to communicate with about the patient's health
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... 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
.... 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 preferred 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
dom-2 error RelatedPerson If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error RelatedPerson If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error RelatedPerson If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error RelatedPerson If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice RelatedPerson A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
us-core-14 error RelatedPerson Either a name or a relationship SHALL be provided (or both) name.exists() or relationship.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson C 0..* USCoreRelatedPersonProfile(9.0.0) A person that is related to a patient, but who is not a direct target of care
Constraints: us-core-14
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... active ?!SΣ 1..1 boolean Whether this related person's record is in active use
... relationship SΣC 0..* CodeableConcept (USCDI+ Quality) The nature of the relationship
Binding: Personal And Legal Relationship Role Type . (preferred): Personal And Legal Relationship Role Type
... name SΣC 0..* HumanName (USCDI+ Quality) A name associated with the person
... telecom SΣ 0..* ContactPoint (USCDI+ Quality) A contact detail for the person
... address SΣ 0..* Address (USCDI+ Quality) 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 preferred Personal And Legal Relationship Role Type . ⏿20251204 tx.fhir.org

Constraints

Id Grade Path(s) Description Expression
dom-2 error RelatedPerson If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error RelatedPerson If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error RelatedPerson If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error RelatedPerson If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice RelatedPerson A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
us-core-14 error RelatedPerson Either a name or a relationship SHALL be provided (or both) name.exists() or relationship.exists()

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson 0..* USCoreRelatedPersonProfile(9.0.0) A person that is related to a patient, but who is not a direct target of care
... patient 1..1 Reference(US Quality Core Patient) The patient this person is related to
... relationship 0..* CodeableConcept (USCDI+ Quality) The nature of the relationship
... name 0..* HumanName (USCDI+ Quality) A name associated with the person
... address 0..* Address (USCDI+ Quality) Address where the related person can be contacted or visited

doco Documentation for this format

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedPerson C 0..* USCoreRelatedPersonProfile(9.0.0) A person that is related to a patient, but who is not a direct target of care
Constraints: us-core-14
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... 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
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier A human identifier for this person
... active ?!SΣ 1..1 boolean Whether this related person's record is in active use
... patient SΣ 1..1 Reference(US Quality Core Patient) The patient this person is related to
... relationship SΣC 0..* CodeableConcept (USCDI+ Quality) The nature of the relationship
Binding: Personal And Legal Relationship Role Type . (preferred): Personal And Legal Relationship Role Type
... name SΣC 0..* HumanName (USCDI+ Quality) A name associated with the person
... telecom SΣ 0..* ContactPoint (USCDI+ Quality) A contact detail for the person
... gender Σ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate Σ 0..1 date The date on which the related person was born
... address SΣ 0..* Address (USCDI+ Quality) Address where the related person can be contacted or visited
... photo 0..* Attachment Image of the person
... period 0..1 Period Period of time that this relationship is considered valid
... communication 0..* BackboneElement A language which may be used to communicate with about the patient's health
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... 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
.... 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 preferred 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
dom-2 error RelatedPerson If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error RelatedPerson If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error RelatedPerson If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error RelatedPerson If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice RelatedPerson A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
us-core-14 error RelatedPerson Either a name or a relationship SHALL be provided (or both) name.exists() or relationship.exists()

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Element Conformance Indicators by Profile Layer

Badges identify the profile layer where each conformance indicator is first introduced. Indicators introduced in an earlier layer remain applicable in later derived profiles.

Element conformance indicators organized by the profile layer where they are first introduced
Profile element FHIR US Core US Quality Core
active Mandatory Must Support
patient Mandatory Must Support
relationship Must Support USCDI+ Quality
name Must Support USCDI+ Quality
telecom Must Support USCDI+ Quality
address Must Support Additional USCDI USCDI+ Quality
communication.language Mandatory

Cardinality note: “Mandatory” means the element has a minimum cardinality greater than zero. For nested elements, the cardinality indicator applies when the containing element is present.

Mandatory US Quality Core Server Search Parameters

The searches below are the focused set identified by US Quality Core as needed to retrieve USCDI+ Quality data for quality measurement and reporting. See the US Core FHIR RESTful Search API Requirements for detailed information on requirements by search parameter type.

Because this profile derives directly or indirectly from US Core, servers SHALL also support all mandatory searches described in the US Core Server CapabilityStatement requirements for RelatedPerson. When possible, this guide reuses mandatory searches from US Core and notes them with the EXISTING US CORE REQUIREMENT flag. While US Quality Core may restate US Core requirements to highlight searches directly relevant to USCDI+ Quality data access, US Core requirements not restated here remain applicable.

See the US Quality Core Server CapabilityStatement for complete requirements for the underlying RelatedPerson resource and Search Requirement Selection for how this focused set was selected.

Servers supporting this profile SHALL support the following search parameters and search parameter combinations:

  1. SHALL support searching for a RelatedPerson resource by id using the _id search parameter. EXISTING US CORE REQUIREMENT

    • Including optional support for OR search on _id (e.g._id=[id],[id],...).

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

    Example:

    GET [base]/RelatedPerson?_id=example

    Implementation Notes: Fetches a bundle of US Quality Core RelatedPerson resources matching the specified search criteria. See how to search by token.

    Rationale for inclusion: Supports retrieval of a known RelatedPerson resource by id.

  2. SHALL support searching for all RelatedPerson resources for a patient using the patient search parameter.

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

    Example:

    GET [base]/RelatedPerson?patient=Patient/example

    Implementation Notes: Fetches a bundle of US Quality Core RelatedPerson resources matching the specified search criteria. See how to search by reference.

    Rationale for inclusion: Supports patient-scoped retrieval of RelatedPerson resources for USCDI+ Quality workflows.