QI-Core Implementation Guide
5.0.0 - STU5 United States of America flag

QI-Core Implementation Guide, published by http://www.hl7.org/Special/committees/cqi/index.cfm. This is not an authorized publication; it is the continuous build for version 5.0.0). This version is based on the current content of https://github.com/HL7/fhir-qi-core/ and changes regularly. See the Directory of published versions

Resource Profile: QICore RelatedPerson

Official URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-relatedperson Version: 5.0.0
Active as of 2018-08-22 Computable Name: QICoreRelatedPerson

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

Usage

See the patterns page for implementation and usage patterns.

Examples

Emergency Contact Example

Usage:

Formal Views of Profile Content

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

This structure is derived from USCoreRelatedPersonProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson 0..*USCoreRelatedPersonProfileA person that is related to a patient, but who is not a direct target of care
... patient S1..1Reference(QICore Patient)The patient this person is related to
... gender S0..1codemale | female | other | unknown
... period S0..1PeriodPeriod of time that this relationship is considered valid

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson C0..*USCoreRelatedPersonProfileA person that is related to a patient, but who is not a direct target of care
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... active ?!SΣ1..1booleanWhether this related person's record is in active use
... relationship SΣC0..*CodeableConceptThe nature of the relationship
Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.


... name SΣC0..*HumanNameA name associated with the person
... telecom SΣ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.

... address SΣ0..*AddressAddress where the related person can be contacted or visited
... period S0..1PeriodPeriod of time that this relationship is considered valid

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
RelatedPerson.relationshippreferredPatientRelationshipType
RelatedPerson.genderrequiredAdministrativeGender

Constraints

IdGradePath(s)DetailsRequirements
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-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
us-core-14errorRelatedPersonEither a name or a relationship SHALL be provided (or both)
: name.exists() or relationship.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson C0..*USCoreRelatedPersonProfileA 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
... 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 ?!SΣ1..1booleanWhether this related person's record is in active use
... patient SΣ1..1Reference(QICore Patient)The patient this person is related to
... relationship SΣC0..*CodeableConceptThe nature of the relationship
Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.


... name SΣC0..*HumanNameA name associated with the person
... telecom SΣ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 SΣ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): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
.... preferred 0..1booleanLanguage preference indicator

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
RelatedPerson.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
RelatedPerson.relationshippreferredPatientRelationshipType
RelatedPerson.genderrequiredAdministrativeGender
RelatedPerson.communication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from USCoreRelatedPersonProfile

Summary

Must-Support: 3 elements

Structures

This structure refers to these other structures:

Differential View

This structure is derived from USCoreRelatedPersonProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson 0..*USCoreRelatedPersonProfileA person that is related to a patient, but who is not a direct target of care
... patient S1..1Reference(QICore Patient)The patient this person is related to
... gender S0..1codemale | female | other | unknown
... period S0..1PeriodPeriod of time that this relationship is considered valid

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson C0..*USCoreRelatedPersonProfileA person that is related to a patient, but who is not a direct target of care
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... active ?!SΣ1..1booleanWhether this related person's record is in active use
... relationship SΣC0..*CodeableConceptThe nature of the relationship
Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.


... name SΣC0..*HumanNameA name associated with the person
... telecom SΣ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.

... address SΣ0..*AddressAddress where the related person can be contacted or visited
... period S0..1PeriodPeriod of time that this relationship is considered valid

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
RelatedPerson.relationshippreferredPatientRelationshipType
RelatedPerson.genderrequiredAdministrativeGender

Constraints

IdGradePath(s)DetailsRequirements
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-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
us-core-14errorRelatedPersonEither a name or a relationship SHALL be provided (or both)
: name.exists() or relationship.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson C0..*USCoreRelatedPersonProfileA 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
... 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 ?!SΣ1..1booleanWhether this related person's record is in active use
... patient SΣ1..1Reference(QICore Patient)The patient this person is related to
... relationship SΣC0..*CodeableConceptThe nature of the relationship
Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.


... name SΣC0..*HumanNameA name associated with the person
... telecom SΣ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 SΣ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): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
.... preferred 0..1booleanLanguage preference indicator

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
RelatedPerson.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
RelatedPerson.relationshippreferredPatientRelationshipType
RelatedPerson.genderrequiredAdministrativeGender
RelatedPerson.communication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from USCoreRelatedPersonProfile

Summary

Must-Support: 3 elements

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel, Schematron