QI-Core Implementation Guide
4.1.0 - release

Publication Build: This will be filled in by the publication tooling

## Resource Profile: QICoreRelatedPerson

Defining URL: | http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-relatedperson
Version: | 4.1.0
Name: | QICoreRelatedPerson
Status: | Draft as of 8/22/18
Definition: | Profile of RelatedPerson for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.
Publisher: | http://www.hl7.org/Special/committees/cqi/index.cfm
Source Resource: | XML / JSON / Turtle

The official URL for this profile is:

    http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-relatedperson

Usage

See the patterns page for implementation and usage patterns.

### Examples

Emergency Contact Example

### Formal Views of Profile Content

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

- Text Summary
- Differential Table
- Snapshot Table
- Snapshot Table (Must Support)
- All

This structure is derived from RelatedPerson

Summary

Must-Support: 4 elements

Structures

This structure refers to these other structures:

- QICorePatient (http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-patient)

This structure is derived from RelatedPerson

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
RelatedPerson |  | 0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care
patient | S | 1..1 | Reference(QICorePatient) | The patient this person is related to
relationship | S | 0..* | CodeableConcept | The nature of the relationship
gender | S | 0..1 | code | male | female | other | unknown
period | S | 0..1 | Period | Period of time that this relationship is considered valid
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
RelatedPerson |  | 0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care
id | Σ | 0..1 | string | 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
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language.
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
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 | ?!Σ | 0..1 | boolean | Whether this related person's record is in active use
patient | S Σ | 1..1 | Reference(QICorePatient) | The patient this person is related to
relationship | S Σ | 0..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.
name | Σ | 0..* | HumanName | A name associated with the person
telecom | Σ | 0..* | ContactPoint | A contact detail for the person
gender | S Σ | 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 | Σ | 0..* | Address | Address where the related person can be contacted or visited
photo |  | 0..* | Attachment | Image of the person
period | S | 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) Max Binding: AllLanguages: A human language.
preferred |  | 0..1 | boolean | Language preference indicator
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
RelatedPerson |  | 0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care
patient | Σ | 1..1 | Reference(QICorePatient) | The patient this person is related to
relationship | Σ | 0..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.
gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
period |  | 0..1 | Period | Period of time that this relationship is considered valid
Documentation for this format

This structure is derived from RelatedPerson

Summary

Must-Support: 4 elements

Structures

This structure refers to these other structures:

- QICorePatient (http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-patient)

Differential View

This structure is derived from RelatedPerson

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
RelatedPerson |  | 0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care
patient | S | 1..1 | Reference(QICorePatient) | The patient this person is related to
relationship | S | 0..* | CodeableConcept | The nature of the relationship
gender | S | 0..1 | code | male | female | other | unknown
period | S | 0..1 | Period | Period of time that this relationship is considered valid
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
RelatedPerson |  | 0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care
id | Σ | 0..1 | string | 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
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language.
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
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 | ?!Σ | 0..1 | boolean | Whether this related person's record is in active use
patient | S Σ | 1..1 | Reference(QICorePatient) | The patient this person is related to
relationship | S Σ | 0..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.
name | Σ | 0..* | HumanName | A name associated with the person
telecom | Σ | 0..* | ContactPoint | A contact detail for the person
gender | S Σ | 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 | Σ | 0..* | Address | Address where the related person can be contacted or visited
photo |  | 0..* | Attachment | Image of the person
period | S | 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) Max Binding: AllLanguages: A human language.
preferred |  | 0..1 | boolean | Language preference indicator
Documentation for this format

Other representations of profile: CSV, Excel, Schematron

#### Terminology Bindings

Path | Conformance | ValueSet
RelatedPerson.language | preferred | CommonLanguages Max Binding: AllLanguages
RelatedPerson.relationship | preferred | PatientRelationshipType
RelatedPerson.gender | required | AdministrativeGender
RelatedPerson.communication.language | preferred | CommonLanguages Max Binding: AllLanguages

#### Constraints

Id | Grade | Path | Details | Requirements
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 | RelatedPerson.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | RelatedPerson.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | RelatedPerson.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | RelatedPerson.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | RelatedPerson.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | RelatedPerson.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
ele-1 | error | RelatedPerson.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | RelatedPerson.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
ele-1 | error | RelatedPerson.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | RelatedPerson.active | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | RelatedPerson.patient | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | RelatedPerson.relationship | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | RelatedPerson.name | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | RelatedPerson.telecom | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | RelatedPerson.gender | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | RelatedPerson.birthDate | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | RelatedPerson.address | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | RelatedPerson.photo | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | RelatedPerson.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | RelatedPerson.communication | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | RelatedPerson.communication.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | RelatedPerson.communication.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
ele-1 | error | RelatedPerson.communication.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | RelatedPerson.communication.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
ele-1 | error | RelatedPerson.communication.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | RelatedPerson.communication.preferred | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |