2nd DSTU Draft For Comment

This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Profile: cqf-familyhistory

The official URL for this profile is: 

http://hl7.org/fhir/Profile/cqf-familyhistory-cqf-familyhistory

. Profile of Family History for decision support/quality metrics. Indicates which elements must be supported by CQF rules and measure engines. : Clinical Quality Framework (CQF) Family History Profile

This profile was published on Tue, Nov 4, 2014 00:00+1100 as a draft by Health Level Seven, Inc. - CQI WG.

Summary

Required/Prohibited Elements

  • The element FamilyHistory is required
  • The element FamilyHistory.patient is required
  • The element FamilyHistory.relation.relationship is required
  • The element FamilyHistory.relation.condition.type is required

Formal Views of Profile Content

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

Differential View

This structure is derived from FamilyHistory.

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyHistory 1..1Information about patient's relatives, relevant for patient
... id 0..1idLogical id of this artefact
... meta 0..1MetaMetadata about the resource
... implicitRules M0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Language (required, not 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 S Σ1..1PatientPatient history is about
... date S Σ0..1dateTimeWhen history was captured/updated
... note 0..1stringAdditional details not covered elsewhere
... relation S I0..*Relative described by history
fhs-1: Can have age[x] or birth[x], but not both
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... name Σ0..1stringThe family member described
.... relationship S Σ1..1CodeableConceptRelationship to the subject
Binding: FamilialRelationship (preferred, extensible)
.... born[x] S I0..1Period, date, string(approximate) date of birth
.... age[x] S I0..1Age, Range, string(approximate) age
.... deceased[x] S0..1boolean, Age, Range, date, stringDead? How old/when?
.... note 0..1stringGeneral note about related person
.... condition S0..*Condition that the related person had
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension 0..*ExtensionExtensions that cannot be ignored
..... type S1..1CodeableConceptCondition suffered by relation
..... outcome S0..1CodeableConceptdeceased | permanent disability | etc.
Binding: ConditionOutcome (preferred, extensible)
..... onset[x] S0..1Age, Range, stringWhen condition first manifested
..... note 0..1stringExtra information about condition

XML Template

JSON Template

todo

Differential View

This structure is derived from FamilyHistory.

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. FamilyHistory 1..1Information about patient's relatives, relevant for patient
... id 0..1idLogical id of this artefact
... meta 0..1MetaMetadata about the resource
... implicitRules M0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Language (required, not 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 S Σ1..1PatientPatient history is about
... date S Σ0..1dateTimeWhen history was captured/updated
... note 0..1stringAdditional details not covered elsewhere
... relation S I0..*Relative described by history
fhs-1: Can have age[x] or birth[x], but not both
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... name Σ0..1stringThe family member described
.... relationship S Σ1..1CodeableConceptRelationship to the subject
Binding: FamilialRelationship (preferred, extensible)
.... born[x] S I0..1Period, date, string(approximate) date of birth
.... age[x] S I0..1Age, Range, string(approximate) age
.... deceased[x] S0..1boolean, Age, Range, date, stringDead? How old/when?
.... note 0..1stringGeneral note about related person
.... condition S0..*Condition that the related person had
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension 0..*ExtensionExtensions that cannot be ignored
..... type S1..1CodeableConceptCondition suffered by relation
..... outcome S0..1CodeableConceptdeceased | permanent disability | etc.
Binding: ConditionOutcome (preferred, extensible)
..... onset[x] S0..1Age, Range, stringWhen condition first manifested
..... note 0..1stringExtra information about condition

XML Template

JSON Template

todo

 

Other definitions: (todo)

Terminology Bindings

PathNameConformanceValueSet
FamilyHistory.languageLanguagerequiredhttp://tools.ietf.org/html/bcp47
FamilyHistory.relation.relationshipFamilialRelationshippreferred (extensible)FamilyMember
FamilyHistory.relation.condition.outcomeConditionOutcomepreferred (extensible)

Constraints

IdPathNameDetails
fhs-1FamilyHistory.relationAge or BirthdateCan have age[x] or birth[x], but not both
XPath: not (*[starts-with(local-name(.), 'age')] and *[starts-with(local-name(.), 'birth')])
.