QI-Core Implementation Guide: STU 4 (v4.0.0 for FHIR 4.0.1)

QI-Core Implementation Guide - This is the current published version.. 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 UTC 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..*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 ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierA human identifier for this person
... active ?!ΣI0..1booleanWhether this related person's record is in active use
... patient SΣI1..1Reference(QICorePatient)The patient this person is related to
... relationship SΣI0..*CodeableConceptThe nature of the relationship
Binding: PatientRelationshipType (preferred)
... name ΣI0..*HumanNameA name associated with the person
... telecom ΣI0..*ContactPointA contact detail for the person
... gender SΣI0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate ΣI0..1dateThe date on which the related person was born
... address ΣI0..*AddressAddress where the related person can be contacted or visited
... photo I0..*AttachmentImage of the person
... period SI0..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 I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language I1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
.... preferred I0..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..*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 ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierA human identifier for this person
... active ?!ΣI0..1booleanWhether this related person's record is in active use
... patient SΣI1..1Reference(QICorePatient)The patient this person is related to
... relationship SΣI0..*CodeableConceptThe nature of the relationship
Binding: PatientRelationshipType (preferred)
... name ΣI0..*HumanNameA name associated with the person
... telecom ΣI0..*ContactPointA contact detail for the person
... gender SΣI0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate ΣI0..1dateThe date on which the related person was born
... address ΣI0..*AddressAddress where the related person can be contacted or visited
... photo I0..*AttachmentImage of the person
... period SI0..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 I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language I1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
.... preferred I0..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-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-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-5RelatedPersonIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6RelatedPersonA resource should have narrative for robust management
: text.`div`.exists()
ele-1RelatedPerson.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1RelatedPerson.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1RelatedPerson.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1RelatedPerson.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1RelatedPerson.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1RelatedPerson.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1RelatedPerson.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1RelatedPerson.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1RelatedPerson.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1RelatedPerson.activeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1RelatedPerson.patientAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1RelatedPerson.relationshipAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1RelatedPerson.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1RelatedPerson.telecomAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1RelatedPerson.genderAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1RelatedPerson.birthDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1RelatedPerson.addressAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1RelatedPerson.photoAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1RelatedPerson.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1RelatedPerson.communicationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1RelatedPerson.communication.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1RelatedPerson.communication.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1RelatedPerson.communication.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1RelatedPerson.communication.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1RelatedPerson.communication.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1RelatedPerson.communication.preferredAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())