Consolidated CDA (C-CDA)
4.0.0-ballot - STU4 Ballot United States of America flag

Consolidated CDA (C-CDA), published by Health Level Seven. This guide is not an authorized publication; it is the continuous build for version 4.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-ccda/ and changes regularly. See the Directory of published versions

Logical Model: FamilyHistoryObservation - Detailed Descriptions

Draft as of 2024-12-19

Definitions for the FamilyHistoryObservation logical model.

Guidance on how to interpret the contents of this table can be found here

0. Observation
Logical ContainerClinicalDocument (CDA Class)
ValidationInstance of this type are validated by templateId
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
Invariantsshould-text-ref-value: SHOULD contain text/reference/@value (text.reference.value.exists())
should-effectiveTime: SHOULD contain effectiveTime (effectiveTime.exists())
2. Observation.templateId
Control1..?
SlicingThis element introduces a set of slices on Observation.templateId. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ root
  • value @ extension
  • 4. Observation.templateId:family-history-obs
    Slice Namefamily-history-obs
    Control1..1
    6. Observation.templateId:family-history-obs.root
    Control1..?
    Pattern Value2.16.840.1.113883.10.20.22.4.46
    8. Observation.templateId:family-history-obs.extension
    Control1..?
    Pattern Value2015-08-01
    10. Observation.classCode
    Comments

    SHALL contain exactly one [1..1] @classCode="OBS" Observation (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1198-8586).

    Fixed ValueOBS
    12. Observation.moodCode
    Comments

    SHALL contain exactly one [1..1] @moodCode="EVN" Event (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC) (CONF:1198-8587).

    Fixed ValueEVN
    14. Observation.id
    Comments

    SHALL contain at least one [1..*] id (CONF:1198-8592).

    Control1..?
    16. Observation.code
    Comments

    SHALL contain exactly one [1..1] code, which SHOULD be selected from ValueSet Problem Type urn:oid:2.16.840.1.113762.1.4.1267.1.

    BindingThe codes SHOULD be taken from Problem Type .
    (preferred to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1267.1)
    18. Observation.text
    ShortSHOULD reference the portion of section narrative text corresponding to this entry
    20. Observation.text.reference
    Invariantsvalue-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative (value.exists() implies value.startsWith('#'))
    22. Observation.statusCode
    Comments

    SHALL contain exactly one [1..1] statusCode (CONF:1198-8590).

    Control1..?
    24. Observation.statusCode.code
    Comments

    This statusCode SHALL contain exactly one [1..1] @code="completed" Completed (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14 STATIC) (CONF:1198-19098).

    Control1..?
    Fixed Valuecompleted
    26. Observation.effectiveTime
    Comments

    SHOULD contain zero or one [0..1] effectiveTime (CONF:1198-8593).

    28. Observation.value
    Comments

    SHALL contain exactly one [1..1] value with @xsi:type="CD", where the code SHALL be selected from ValueSet US Core Condition Codes.

    Control1..1
    BindingThe codes SHALL be taken from US Core Condition Codes
    (required to http://hl7.org/fhir/us/core/ValueSet/us-core-condition-code)
    Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/CO, http://hl7.org/cda/stds/core/StructureDefinition/TEL, http://hl7.org/cda/stds/core/StructureDefinition/EN, http://hl7.org/cda/stds/core/StructureDefinition/BL, http://hl7.org/cda/stds/core/StructureDefinition/AD, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/RTO-PQ-PQ, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS, http://hl7.org/cda/stds/core/StructureDefinition/ED, http://hl7.org/cda/stds/core/StructureDefinition/TS, http://hl7.org/cda/stds/core/StructureDefinition/II, http://hl7.org/cda/stds/core/StructureDefinition/ST, http://hl7.org/cda/stds/core/StructureDefinition/PQ, http://hl7.org/cda/stds/core/StructureDefinition/IVL-PQ, http://hl7.org/cda/stds/core/StructureDefinition/CE, http://hl7.org/cda/stds/core/StructureDefinition/MO, http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/ANY, http://hl7.org/cda/stds/core/StructureDefinition/INT, http://hl7.org/cda/stds/core/StructureDefinition/REAL, http://hl7.org/cda/stds/core/StructureDefinition/CV, http://hl7.org/cda/stds/core/StructureDefinition/SC
    30. Observation.entryRelationship
    SlicingThis element introduces a set of slices on Observation.entryRelationship. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • profile @ observation
    • value @ typeCode
    • 32. Observation.entryRelationship:ageObservation
      Slice NameageObservation
      Comments

      MAY contain zero or one [0..1] entryRelationship (CONF:1198-8675) such that it

      Control0..1
      34. Observation.entryRelationship:ageObservation.typeCode
      Comments

      SHALL contain exactly one [1..1] @typeCode="SUBJ" Subject (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90 STATIC) (CONF:1198-8676).

      Fixed ValueSUBJ
      36. Observation.entryRelationship:ageObservation.inversionInd
      Comments

      SHALL contain exactly one [1..1] @inversionInd="true" True (CONF:1198-8677).

      Control1..?
      Fixed Valuetrue
      38. Observation.entryRelationship:ageObservation.observation
      Comments

      SHALL contain exactly one [1..1] Age Observation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.31) (CONF:1198-15526).

      Control1..?
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Age Observation)
      40. Observation.entryRelationship:deathObservation
      Slice NamedeathObservation
      Comments

      MAY contain zero or one [0..1] entryRelationship (CONF:1198-8678) such that it

      Control0..1
      42. Observation.entryRelationship:deathObservation.typeCode
      Comments

      SHALL contain exactly one [1..1] @typeCode="CAUS" Causal or Contributory (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90 STATIC) (CONF:1198-8679).

      Fixed ValueCAUS
      44. Observation.entryRelationship:deathObservation.observation
      Comments

      SHALL contain exactly one [1..1] Family History Death Observation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.47) (CONF:1198-15527).

      Control1..?
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Family History Death Observation)