STU 3 Ballot

This page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

9.12.9.2 StructureDefinition: FamilyMemberHistory-Genetic

The official URL for this profile is: 

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

Adds additional information to a family member history supporting both the capture of mother/father relationships as well as additional observations necessary to enable genetics-based risk analysis for patients

This profile was published on Wed, Oct 2, 2013 00:00+1000 as a draft by Health Level Seven International (Clinical Genomics).

9.12.9.2.1 Formal Views of Profile Content

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

This structure is derived from FamilyMemberHistory.

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
... family-member-history-genetics-parent SI0..*(Complex)Extension
URL: http://hl7.org/fhir/StructureDefinition/family-member-history-genetics-parent
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... family-member-history-genetics-observation I0..*Reference(Observation)Extension
URL: http://hl7.org/fhir/StructureDefinition/family-member-history-genetics-observation
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
... identifier 0..*IdentifierExternal Id(s) for this record
... patient ∑1..1Reference(Patient)Patient history is about
... date ∑0..1dateTimeWhen history was captured/updated
... status ?!∑1..1codepartial | completed | entered-in-error | health-unknown
Binding: FamilyHistoryStatus (required)
... name ∑0..1stringThe family member described
... relationship ∑1..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] ∑I0..1Age, Range, string(approximate) age
... estimatedAge ?!∑I0..1booleanAge is estimated?
... deceased[x] ∑0..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)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... code 1..1CodeableConceptCondition suffered by relation
Binding: Condition/Problem/Diagnosis Codes (example)
.... 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

todo

This structure is derived from FamilyMemberHistory.

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
... family-member-history-genetics-parent SI0..*(Complex)Extension
URL: http://hl7.org/fhir/StructureDefinition/family-member-history-genetics-parent
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... family-member-history-genetics-observation I0..*Reference(Observation)Extension
URL: http://hl7.org/fhir/StructureDefinition/family-member-history-genetics-observation
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
... identifier 0..*IdentifierExternal Id(s) for this record
... patient ∑1..1Reference(Patient)Patient history is about
... date ∑0..1dateTimeWhen history was captured/updated
... status ?!∑1..1codepartial | completed | entered-in-error | health-unknown
Binding: FamilyHistoryStatus (required)
... name ∑0..1stringThe family member described
... relationship ∑1..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] ∑I0..1Age, Range, string(approximate) age
... estimatedAge ?!∑I0..1booleanAge is estimated?
... deceased[x] ∑0..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)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... code 1..1CodeableConceptCondition suffered by relation
Binding: Condition/Problem/Diagnosis Codes (example)
.... 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

JSON Template

todo

 

Other representations of profile: Schematron

9.12.9.2.2 Terminology Bindings

PathNameConformanceValueSet
FamilyMemberHistory.languageCommon LanguagesextensibleCommon Languages
FamilyMemberHistory.statusFamilyHistoryStatusrequiredFamilyHistoryStatus
FamilyMemberHistory.relationshipFamilyMemberexampleFamilyMember
FamilyMemberHistory.genderAdministrativeGenderrequiredAdministrativeGender
FamilyMemberHistory.condition.codeCondition/Problem/Diagnosis CodesexampleCondition/Problem/Diagnosis Codes
FamilyMemberHistory.condition.outcomeCondition Outcome CodesexampleCondition Outcome Codes

9.12.9.2.3 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.extensionAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
ext-1FamilyMemberHistory.extensionMust have either extensions or value[x], not both
XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
ele-1FamilyMemberHistory.extensionAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
ext-1FamilyMemberHistory.extensionMust have either extensions or value[x], not both
XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
ele-1FamilyMemberHistory.extensionAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
ext-1FamilyMemberHistory.extensionMust have either extensions or value[x], not both
XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
.