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-familymemberhistory

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is: 

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

This profile was published on Fri Feb 27 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 FamilyMemberHistory

Summary

Must-Support: 6 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory I0..*Information about patient's relatives, relevant for patient
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
fhs-2: Can only have estimatedAge is age[x] is present
fhs-1: Can have age[x] or born[x], but not both
... 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..*IdentifierExternal Id(s) for this record
... patient S1..1Reference(Profile qicore-patient)Patient history is about
... date S0..1dateTimeWhen history was captured/updated
... status ?!∑1..1codepartial | completed | entered-in-error | health-unknown
Binding: FamilyHistoryStatus (required)
... name ∑0..1stringThe family member described
... relationship S1..1CodeableConceptRelationship to the subject
Binding: FamilyMember (example)
... gender ∑0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... born[x] I0..1Period, date, string(approximate) date of birth
... age[x] SI0..1Age, Range, string(approximate) age
... estimatedAge ?!∑I0..1booleanAge is estimated?
... deceased[x] S0..1boolean, Age, Range, date, stringDead? How old/when?
... note 0..1AnnotationGeneral note about related person
... condition 0..*BackboneElementCondition that the related person had
.... id 0..1stringxml:id (or equivalent in JSON)
.... familymemberhistory-abatement I0..1date, Age, booleanExtension
URL: http://hl7.org/fhir/StructureDefinition/familymemberhistory-abatement
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... familymemberhistory-severity I0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/familymemberhistory-severity
Binding: Condition/Diagnosis Severity (example)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... code S1..1CodeableConceptCondition suffered by relation
Binding: 7.org/fhir/daf/ValueSet/daf-problem (preferred)
.... outcome 0..1CodeableConceptdeceased | permanent disability | etc.
Binding: Condition Outcome Codes (example)
.... onset[x] 0..1Age, Range, Period, stringWhen condition first manifested
.... note 0..1AnnotationExtra information about condition

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: 6 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyMemberHistory I0..*Information about patient's relatives, relevant for patient
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
fhs-2: Can only have estimatedAge is age[x] is present
fhs-1: Can have age[x] or born[x], but not both
... 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..*IdentifierExternal Id(s) for this record
... patient S1..1Reference(Profile qicore-patient)Patient history is about
... date S0..1dateTimeWhen history was captured/updated
... status ?!∑1..1codepartial | completed | entered-in-error | health-unknown
Binding: FamilyHistoryStatus (required)
... name ∑0..1stringThe family member described
... relationship S1..1CodeableConceptRelationship to the subject
Binding: FamilyMember (example)
... gender ∑0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... born[x] I0..1Period, date, string(approximate) date of birth
... age[x] SI0..1Age, Range, string(approximate) age
... estimatedAge ?!∑I0..1booleanAge is estimated?
... deceased[x] S0..1boolean, Age, Range, date, stringDead? How old/when?
... note 0..1AnnotationGeneral note about related person
... condition 0..*BackboneElementCondition that the related person had
.... id 0..1stringxml:id (or equivalent in JSON)
.... familymemberhistory-abatement I0..1date, Age, booleanExtension
URL: http://hl7.org/fhir/StructureDefinition/familymemberhistory-abatement
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... familymemberhistory-severity I0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/familymemberhistory-severity
Binding: Condition/Diagnosis Severity (example)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... code S1..1CodeableConceptCondition suffered by relation
Binding: 7.org/fhir/daf/ValueSet/daf-problem (preferred)
.... outcome 0..1CodeableConceptdeceased | permanent disability | etc.
Binding: Condition Outcome Codes (example)
.... onset[x] 0..1Age, Range, Period, stringWhen condition first manifested
.... note 0..1AnnotationExtra information about condition

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
FamilyMemberHistory.languageCommon LanguagesextensibleCommon Languages
FamilyMemberHistory.statusFamilyHistoryStatusrequiredFamilyHistoryStatus
FamilyMemberHistory.relationshipFamilyMemberexampleFamilyMember
FamilyMemberHistory.genderAdministrativeGenderrequiredAdministrativeGender
FamilyMemberHistory.condition.extension
http://hl7.org/fhir/StructureDefinition/familymemberhistory-severity		Condition/Diagnosis SeveritypreferredCondition/Diagnosis Severity
FamilyMemberHistory.condition.code?extpreferredhttp://hl7.org/fhir/daf/ValueSet/daf-problem
FamilyMemberHistory.condition.outcomeCondition Outcome CodesexampleCondition Outcome Codes

D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2FamilyMemberHistoryIf the resource is contained in another resource, it SHALL NOT contain nested Resources
XPath: not(parent::f:contained and f:contained)
dom-1FamilyMemberHistoryIf the resource is contained in another resource, it SHALL NOT contain any narrative
XPath: not(parent::f:contained and f:text)
dom-4FamilyMemberHistoryIf 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-3FamilyMemberHistoryIf 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))]))
fhs-2FamilyMemberHistoryCan only have estimatedAge is age[x] is present
XPath: exists(*[starts-with(local-name(.), 'age')]) or not(exists(f:estimatedAge))
fhs-1FamilyMemberHistoryCan have age[x] or born[x], but not both
XPath: not (*[starts-with(local-name(.), 'age')] and *[starts-with(local-name(.), 'birth')])
ele-1FamilyMemberHistory.condition.extensionAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
ext-1FamilyMemberHistory.condition.extensionMust have either extensions or value[x], not both
XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
ele-1FamilyMemberHistory.condition.extensionAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
ext-1FamilyMemberHistory.condition.extensionMust have either extensions or value[x], not both
XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
ele-1FamilyMemberHistory.condition.extensionAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
ext-1FamilyMemberHistory.condition.extensionMust have either extensions or value[x], not both
XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
.