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: PregnancyStatusObservation - Detailed Descriptions

Draft as of 2024-12-19

Definitions for the PregnancyStatusObservation 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
  • 4. Observation.templateId:pregnancy-obs
    Slice Namepregnancy-obs
    Control1..1
    6. Observation.templateId:pregnancy-obs.root
    Control1..?
    Pattern Value2.16.840.1.113883.10.20.15.3.8
    8. Observation.templateId:pregnancy-obs.extension
    Control0..0
    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:81-451).

    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:81-452).

    Fixed ValueEVN
    14. Observation.code
    Comments

    SHALL contain exactly one [1..1] code (CONF:81-19153).

    16. Observation.code.code
    ShortPregnancy Status
    Comments

    This code SHALL contain exactly one [1..1] @code="82810-3" Pregnancy Status.

    Control1..?
    Pattern Value82810-3
    18. Observation.code.codeSystem
    Comments

    This code SHALL contain exactly one [1..1] @codeSystem="2.16.840.1.113883.5.4" (CodeSystem: HL7ActCode urn:oid:2.16.840.1.113883.5.4) (CONF:81-26505).

    Control1..?
    Pattern Value2.16.840.1.113883.5.4
    20. Observation.text
    ShortSHOULD reference the portion of section narrative text corresponding to this entry
    22. 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('#'))
    24. Observation.statusCode
    Comments

    SHALL contain exactly one [1..1] statusCode (CONF:81-455).

    Control1..?
    26. 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:81-19110).

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

    SHALL contain exactly one [1..1] effectiveTime.

    Control1..?
    Invariantsvalue-only: Interval fields SHALL NOT be present ((low | high | width | center).empty())
    30. Observation.effectiveTime.value
    Shortvalue should be used instead of low/high
    32. Observation.value
    Comments

    SHALL contain exactly one [1..1] value with @xsi:type="CD".

    Control1..1
    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
    34. Observation.value.nullFlavor
    Control0..0
    36. Observation.value.code
    Control1..?
    BindingThe codes SHALL be taken from Pregnancy Status Observation .
    (required to http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1240.12)
    38. 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
    • 40. Observation.entryRelationship:estimatedDateofDelivery
      Slice NameestimatedDateofDelivery
      Comments

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

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

      SHALL contain exactly one [1..1] @typeCode="REFR" Refers to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:81-459).

      Fixed ValueREFR
      44. Observation.entryRelationship:estimatedDateofDelivery.observation
      Comments

      SHALL contain exactly one [1..1] observationEstimated Date of Delivery (identifier: urn:oid:2.16.840.1.113883.10.20.15.3.1) (CONF:81-15584).

      Control1..?
      Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation(Estimated Date of Delivery)