STU 2 Ballot

This page is part of the Quality Improvement Core Framework (v1.6.0: STU 2 Ballot 1) based on FHIR v1.6.0. The current version which supercedes this version is 4.1.1. For a full list of available versions, see the Directory of published versions

D.4.1 StructureDefinition: qicore-relatedperson

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is:

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

This profile was published on Wed Mar 11 00:00:00 AEDT 2015 as a draft by Health Level Seven International (Clinical Quality Information - QICore).

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

This structure is derived from RelatedPerson

Summary

Must-Support: 4 elements

Structures

This structure refers to these other structures:

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson I0..*An person that is related to a patient, but who is not a direct target of care
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
... 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: Common Languages (extensible)
... text I0..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 S1..1Reference(Profile qicore-patient)Information about an individual or animal receiving health care services
... relationship S0..1CodeableConceptThe nature of the relationship
Binding: PatientRelationshipType (extensible)
... name 0..*HumanNameA name associated with the person
... telecom 0..*ContactPointA contact detail for the person
... gender S0..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

doco Documentation for this format

yet to be done: Xml template

yet to be done: Json template

This structure is derived from StructureDefinition.

Summary

Must-Support: 4 elements

Structures

This structure refers to these other structures:

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson I0..*An person that is related to a patient, but who is not a direct target of care
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
... 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: Common Languages (extensible)
... text I0..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 S1..1Reference(Profile qicore-patient)Information about an individual or animal receiving health care services
... relationship S0..1CodeableConceptThe nature of the relationship
Binding: PatientRelationshipType (extensible)
... name 0..*HumanNameA name associated with the person
... telecom 0..*ContactPointA contact detail for the person
... gender S0..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

doco Documentation for this format

XML Template

yet to be done: Xml template

JSON Template

yet to be done: Json template

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathNameConformanceValueSet
RelatedPerson.languageCommon LanguagesextensibleCommon Languages
RelatedPerson.relationshipPatientRelationshipTypeextensiblePatientRelationshipType
RelatedPerson.genderAdministrativeGenderrequiredAdministrativeGender

D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2RelatedPersonIf the resource is contained in another resource, it SHALL NOT contain nested Resources
XPath: not(parent::f:contained and f:contained)
dom-1RelatedPersonIf the resource is contained in another resource, it SHALL NOT contain any narrative
XPath: not(parent::f:contained and f:text)
dom-4RelatedPersonIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
XPath: not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
dom-3RelatedPersonIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
XPath: not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))
.