QI-Core Implementation Guide
4.1.0 - release

This page is part of the Quality Improvement Core Framework (v4.1.0: STU 4) based on FHIR R4. The current version which supercedes this version is 4.1.1. For a full list of available versions, see the Directory of published versions

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.

This structure is derived from RelatedPerson

Summary

Must-Support: 4 elements

Structures

This structure refers to these other structures:

This structure is derived from RelatedPerson

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson 0..*RelatedPersonA person that is related to a patient, but who is not a direct target of care
... patient S1..1Reference(QICorePatient)The patient this person is related to
... relationship S0..*CodeableConceptThe nature of the relationship
... gender S0..1codemale | female | other | unknown

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson 0..*RelatedPersonA person that is related to a patient, but who is not a direct target of care
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierA human identifier for this person
... active ?!Σ0..1booleanWhether this related person's record is in active use
... patient SΣ1..1Reference(QICorePatient)The patient this person is related to
... relationship SΣ0..*CodeableConceptThe nature of the relationship
Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.


... name Σ0..*HumanNameA name associated with the person
... telecom Σ0..*ContactPointA contact detail for the person
... gender SΣ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ0..1dateThe date on which the related person was born
... address Σ0..*AddressAddress where the related person can be contacted or visited
... photo 0..*AttachmentImage of the person
... period S0..1PeriodPeriod of time that this relationship is considered valid
... communication 0..*BackboneElementA language which may be used to communicate with about the patient's health
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language 1..1CodeableConceptThe 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..1booleanLanguage preference indicator

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson 0..*RelatedPersonA person that is related to a patient, but who is not a direct target of care
... patient Σ1..1Reference(QICorePatient)The patient this person is related to
... relationship Σ0..*CodeableConceptThe nature of the relationship
Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.


... gender Σ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.


doco Documentation for this format

This structure is derived from RelatedPerson

Summary

Must-Support: 4 elements

Structures

This structure refers to these other structures:

Differential View

This structure is derived from RelatedPerson

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson 0..*RelatedPersonA person that is related to a patient, but who is not a direct target of care
... patient S1..1Reference(QICorePatient)The patient this person is related to
... relationship S0..*CodeableConceptThe nature of the relationship
... gender S0..1codemale | female | other | unknown

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson 0..*RelatedPersonA person that is related to a patient, but who is not a direct target of care
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierA human identifier for this person
... active ?!Σ0..1booleanWhether this related person's record is in active use
... patient SΣ1..1Reference(QICorePatient)The patient this person is related to
... relationship SΣ0..*CodeableConceptThe nature of the relationship
Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.


... name Σ0..*HumanNameA name associated with the person
... telecom Σ0..*ContactPointA contact detail for the person
... gender SΣ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ0..1dateThe date on which the related person was born
... address Σ0..*AddressAddress where the related person can be contacted or visited
... photo 0..*AttachmentImage of the person
... period S0..1PeriodPeriod of time that this relationship is considered valid
... communication 0..*BackboneElementA language which may be used to communicate with about the patient's health
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language 1..1CodeableConceptThe 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..1booleanLanguage preference indicator

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
RelatedPerson.languagepreferredCommonLanguages
Max Binding: AllLanguages
RelatedPerson.relationshippreferredPatientRelationshipType
RelatedPerson.genderrequiredAdministrativeGender
RelatedPerson.communication.languagepreferredCommonLanguages
Max Binding: AllLanguages

Constraints

IdGradePathDetailsRequirements
dom-2errorRelatedPersonIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorRelatedPersonIf 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-4errorRelatedPersonIf 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-5errorRelatedPersonIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6Best PracticeRelatedPersonA resource should have narrative for robust management
: text.`div`.exists()
ele-1errorRelatedPerson.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorRelatedPerson.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorRelatedPerson.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorRelatedPerson.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorRelatedPerson.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorRelatedPerson.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorRelatedPerson.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorRelatedPerson.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorRelatedPerson.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorRelatedPerson.activeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorRelatedPerson.patientAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorRelatedPerson.relationshipAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorRelatedPerson.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorRelatedPerson.telecomAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorRelatedPerson.genderAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorRelatedPerson.birthDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorRelatedPerson.addressAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorRelatedPerson.photoAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorRelatedPerson.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorRelatedPerson.communicationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorRelatedPerson.communication.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorRelatedPerson.communication.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorRelatedPerson.communication.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorRelatedPerson.communication.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorRelatedPerson.communication.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorRelatedPerson.communication.preferredAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())