Example CRVS Implementation Guide
0.1.0 - ci-build

Logical Model: BirthStatisticBackbone - Detailed Descriptions

Active as of 2025-03-28

Definitions for the BirthStatisticBackbone logical model.

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

0. BirthStatisticBackbone
Definition

A profile defining statistical details.


Base definition for all elements that are defined inside a resource - but not those in a data type.

ShortStatistic ProfileBase for elements defined inside a resource
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. BirthStatisticBackbone.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
This element is affected by the following invariants: ele-1
Typeidstring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
4. BirthStatisticBackbone.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on BirthStatisticBackbone.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 6. BirthStatisticBackbone.modifierExtension
    Definition

    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

    ShortExtensions that cannot be ignored even if unrecognized
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
    Summarytrue
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content, modifiers
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    8. BirthStatisticBackbone.gestationalAge
    Definition

    Gestational age at birth

    ShortGestational age at birth
    Control0..1
    TypeDuration
    10. BirthStatisticBackbone.attendanceOfBirth
    Definition

    person present during the delivery

    Shortperson present during the delivery
    Control0..*
    TypeReference(Individual Person)
    12. BirthStatisticBackbone.birthType
    Definition

    Type of birth (live or stillborn)

    ShortType of birth (live or stillborn)
    Control1..1
    BindingThe codes SHALL be taken from Birth Type Value Set
    (required to http://acsa.afrika/standard/ValueSet/birth-type)
    Typecode
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    14. BirthStatisticBackbone.previousLiveBirthDate
    Definition

    date of the last live birth

    Shortdate of the last live birth
    Control0..1
    Typedate
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    16. BirthStatisticBackbone.otherPregnancyLiveBirths
    Definition

    Number of other live births in this pregnancy

    ShortNumber of other live births in this pregnancy
    Control0..1
    Typeinteger
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    18. BirthStatisticBackbone.otherPregnancyStillBirths
    Definition

    Number of other stillbirths in this pregnancy

    ShortNumber of other stillbirths in this pregnancy
    Control0..1
    Typeinteger
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    20. BirthStatisticBackbone.previousLiveBirths
    Definition

    Number of previous live births for the mother

    ShortNumber of previous live births for the mother
    Control0..1
    Typeinteger
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    22. BirthStatisticBackbone.previousStillBirths
    Definition

    Number of previous stillbirths for the mother

    ShortNumber of previous stillbirths for the mother
    Control0..1
    Typeinteger
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    24. BirthStatisticBackbone.parentsRelationType
    Definition

    Type of relationship between parents

    ShortType of relationship between parents
    Control0..1
    BindingThe codes SHALL be taken from Person Marital Status Value Set
    (required to http://acsa.afrika/standard/ValueSet/marital-status)
    Typecode
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    26. BirthStatisticBackbone.parentRelationshipSince
    Definition

    Date the parents' relationship began

    ShortDate the parents' relationship began
    Control0..1
    Typedate
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    28. BirthStatisticBackbone.motherDetails
    Definition

    Mother's details

    ShortMother's details
    Control0..1
    Typehttp://acsa.africa/standard/StructureDefinition/ParentDetailBackbone
    30. BirthStatisticBackbone.fatherDetails
    Definition

    Father's details

    ShortFather's details
    Control0..1
    Typehttp://acsa.africa/standard/StructureDefinition/ParentDetailBackbone

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

    0. BirthStatisticBackbone
    Definition

    A profile defining statistical details.

    ShortStatistic Profile
    Logical ModelInstances of this logical model are not marked to be the target of a Reference
    2. BirthStatisticBackbone.gestationalAge
    Definition

    Gestational age at birth

    ShortGestational age at birth
    Control0..1
    TypeDuration
    4. BirthStatisticBackbone.attendanceOfBirth
    Definition

    person present during the delivery

    Shortperson present during the delivery
    Control0..*
    TypeReference(Individual Person)
    6. BirthStatisticBackbone.birthType
    Definition

    Type of birth (live or stillborn)

    ShortType of birth (live or stillborn)
    Control1..1
    BindingThe codes SHALL be taken from Birth Type Value Set
    (required to http://acsa.afrika/standard/ValueSet/birth-type)
    Typecode
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    8. BirthStatisticBackbone.previousLiveBirthDate
    Definition

    date of the last live birth

    Shortdate of the last live birth
    Control0..1
    Typedate
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    10. BirthStatisticBackbone.otherPregnancyLiveBirths
    Definition

    Number of other live births in this pregnancy

    ShortNumber of other live births in this pregnancy
    Control0..1
    Typeinteger
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    12. BirthStatisticBackbone.otherPregnancyStillBirths
    Definition

    Number of other stillbirths in this pregnancy

    ShortNumber of other stillbirths in this pregnancy
    Control0..1
    Typeinteger
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    14. BirthStatisticBackbone.previousLiveBirths
    Definition

    Number of previous live births for the mother

    ShortNumber of previous live births for the mother
    Control0..1
    Typeinteger
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    16. BirthStatisticBackbone.previousStillBirths
    Definition

    Number of previous stillbirths for the mother

    ShortNumber of previous stillbirths for the mother
    Control0..1
    Typeinteger
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    18. BirthStatisticBackbone.parentsRelationType
    Definition

    Type of relationship between parents

    ShortType of relationship between parents
    Control0..1
    BindingThe codes SHALL be taken from Person Marital Status Value Set
    (required to http://acsa.afrika/standard/ValueSet/marital-status)
    Typecode
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    20. BirthStatisticBackbone.parentRelationshipSince
    Definition

    Date the parents' relationship began

    ShortDate the parents' relationship began
    Control0..1
    Typedate
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    22. BirthStatisticBackbone.motherDetails
    Definition

    Mother's details

    ShortMother's details
    Control0..1
    Typehttp://acsa.africa/standard/StructureDefinition/ParentDetailBackbone
    24. BirthStatisticBackbone.fatherDetails
    Definition

    Father's details

    ShortFather's details
    Control0..1
    Typehttp://acsa.africa/standard/StructureDefinition/ParentDetailBackbone

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

    0. BirthStatisticBackbone
    Definition

    A profile defining statistical details.

    ShortStatistic Profile
    Control0..*
    Is Modifierfalse
    Logical ModelInstances of this logical model are not marked to be the target of a Reference
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    2. BirthStatisticBackbone.id
    Definition

    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

    ShortUnique id for inter-element referencing
    Control0..1
    This element is affected by the following invariants: ele-1
    Typeid
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    4. BirthStatisticBackbone.extension
    Definition

    May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

    ShortAdditional content defined by implementations
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Alternate Namesextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    SlicingThis element introduces a set of slices on BirthStatisticBackbone.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 6. BirthStatisticBackbone.modifierExtension
      Definition

      May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

      Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

      ShortExtensions that cannot be ignored even if unrecognized
      Comments

      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

      Control0..*
      TypeExtension
      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
      Summarytrue
      Requirements

      Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

      Alternate Namesextensions, user content, modifiers
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      8. BirthStatisticBackbone.gestationalAge
      Definition

      Gestational age at birth

      ShortGestational age at birth
      Control0..1
      TypeDuration
      10. BirthStatisticBackbone.attendanceOfBirth
      Definition

      person present during the delivery

      Shortperson present during the delivery
      Control0..*
      TypeReference(Individual Person)
      12. BirthStatisticBackbone.birthType
      Definition

      Type of birth (live or stillborn)

      ShortType of birth (live or stillborn)
      Control1..1
      BindingThe codes SHALL be taken from Birth Type Value Set
      (required to http://acsa.afrika/standard/ValueSet/birth-type)
      Typecode
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      14. BirthStatisticBackbone.previousLiveBirthDate
      Definition

      date of the last live birth

      Shortdate of the last live birth
      Control0..1
      Typedate
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      16. BirthStatisticBackbone.otherPregnancyLiveBirths
      Definition

      Number of other live births in this pregnancy

      ShortNumber of other live births in this pregnancy
      Control0..1
      Typeinteger
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      18. BirthStatisticBackbone.otherPregnancyStillBirths
      Definition

      Number of other stillbirths in this pregnancy

      ShortNumber of other stillbirths in this pregnancy
      Control0..1
      Typeinteger
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      20. BirthStatisticBackbone.previousLiveBirths
      Definition

      Number of previous live births for the mother

      ShortNumber of previous live births for the mother
      Control0..1
      Typeinteger
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      22. BirthStatisticBackbone.previousStillBirths
      Definition

      Number of previous stillbirths for the mother

      ShortNumber of previous stillbirths for the mother
      Control0..1
      Typeinteger
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      24. BirthStatisticBackbone.parentsRelationType
      Definition

      Type of relationship between parents

      ShortType of relationship between parents
      Control0..1
      BindingThe codes SHALL be taken from Person Marital Status Value Set
      (required to http://acsa.afrika/standard/ValueSet/marital-status)
      Typecode
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      26. BirthStatisticBackbone.parentRelationshipSince
      Definition

      Date the parents' relationship began

      ShortDate the parents' relationship began
      Control0..1
      Typedate
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      28. BirthStatisticBackbone.motherDetails
      Definition

      Mother's details

      ShortMother's details
      Control0..1
      Typehttp://acsa.africa/standard/StructureDefinition/ParentDetailBackbone
      30. BirthStatisticBackbone.fatherDetails
      Definition

      Father's details

      ShortFather's details
      Control0..1
      Typehttp://acsa.africa/standard/StructureDefinition/ParentDetailBackbone