QI-Core Implementation Guide: STU Ballot (v3.3.0 for FHIR 4.0.0)

Quality Improvement Core Framework (v3.3.0: STU 4 Ballot 1). The current version is 3.2.0 based on FHIR R4. See the Directory of published versions

D.4.1 StructureDefinition-qicore-relatedperson

Introduction:

See the patterns page for implementation and usage patterns.

Examples:

Emergency Contact Example

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is: 

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

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

This profile builds on RelatedPerson.

This profile was published on Wed Aug 22 00:00:00 EDT 2018 as a draft by Health Level Seven, Inc. - CQI WG.

Description of Profiles, Differentials, and Snapshots.

Summary

Must-Support: 4 elements

Structures

This structure refers to these other structures:

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson I0..*A person that is related to a patient, but who is not a direct target of care
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... 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)
... 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)
... 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 I0..*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
.... preferred 0..1booleanLanguage preference indicator

doco Documentation for this format

Summary

Must-Support: 4 elements

Structures

This structure refers to these other structures:

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson I0..*A person that is related to a patient, but who is not a direct target of care
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... 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)
... 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)
... 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 I0..*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
.... preferred 0..1booleanLanguage preference indicator

doco Documentation for this format

 

D.4.1.2 Terminology Bindings

Terminology Bindings

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

D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2RelatedPersonIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-4RelatedPersonIf 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-3RelatedPersonIf 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-6RelatedPersonA resource should have narrative for robust management
: text.div.exists()
dom-5RelatedPersonIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
ele-1RelatedPerson.communicationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())