Example CRVS Implementation Guide
0.1.0 - ci-build

Resource Profile: BirthNotification - Detailed Descriptions

Draft as of 2025-12-08

Definitions for the BirthNotification resource profile.

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

0. BirthNotification
Definition

A new base resource for capturing birth data in the CRVS realm.


This is the base resource type for everything.

ShortBirth Notification ResourceBase Resource
Control0..*
Is Modifierfalse
Must Supportfalse
Summaryfalse
2. BirthNotification.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

ShortLogical id of this artifact
Comments

Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

Control0..1
Typeid
Is Modifierfalse
Must Supportfalse
Summarytrue
4. BirthNotification.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

ShortMetadata about the resource
Control0..1
TypeMeta
Is Modifierfalse
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. BirthNotification.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. BirthNotification.language
Definition

The base language in which the resource is written.

ShortLanguage of the resource content
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Control0..1
BindingThe codes SHALL be taken from AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0
(required to http://hl7.org/fhir/ValueSet/all-languages|5.0.0)

IETF language tag for a human language

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. BirthNotification.identifier
Definition

Business identifiers for the notification

ShortBusiness identifiers for the notification
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
12. BirthNotification.subject
Definition

Subject of the event (person the event happened to)

ShortSubject of the event (person the event happened to)
Control0..1
TypeReference(Individual Person)
14. BirthNotification.eventDetail
Definition

Free text note about the event

ShortFree text note about the event
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. BirthNotification.dateOfBirth
Definition

Date of birth

ShortDate of birth
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. BirthNotification.placeOfBirth
Definition

place of birth of the person

Shortplace of birth of the person
Control0..1
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
20. BirthNotification.placeOfBirth.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
22. BirthNotification.placeOfBirth.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 BirthNotification.placeOfBirth.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 24. BirthNotification.placeOfBirth.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())
    26. BirthNotification.placeOfBirth.use
    Definition

    home | work | temp | old | billing - purpose of this address

    Shorthome | work | temp | old | billing - purpose of this address
    Control0..1
    Typecode
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    28. BirthNotification.placeOfBirth.type
    Definition

    postal | physical | both - the type of address

    Shortpostal | physical | both - the type of address
    Control0..1
    Typecode
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    30. BirthNotification.placeOfBirth.line
    Definition

    Street name, number, direction & P.O. Box etc.

    ShortStreet name, number, direction & P.O. Box etc.
    Control0..*
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    32. BirthNotification.placeOfBirth.city
    Definition

    Name of city, town etc.

    ShortName of city, town etc.
    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    34. BirthNotification.placeOfBirth.neighborhood
    Definition

    Name of neighborhood, block

    ShortName of neighborhood, block
    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    36. BirthNotification.placeOfBirth.postalCode
    Definition

    Postal code for area

    ShortPostal code for area
    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    38. BirthNotification.placeOfBirth.parent
    Definition

    Location hierarchy information

    ShortLocation hierarchy information
    Control0..1
    TypeBackboneElement
    Invariantsparent-1: At least one of coding, code, reference, or name must be present (coding.exists() or reference.exists() or name.exists() or code.exists())
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    40. BirthNotification.placeOfBirth.parent.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
    42. BirthNotification.placeOfBirth.parent.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 BirthNotification.placeOfBirth.parent.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 44. BirthNotification.placeOfBirth.parent.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())
      46. BirthNotification.placeOfBirth.parent.code
      Definition

      Simple code for the location type

      ShortSimple code for the location type
      Control0..1
      Typecode
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      48. BirthNotification.placeOfBirth.parent.coding
      Definition

      Coded representation of the location

      ShortCoded representation of the location
      Control0..1
      BindingThe codes SHOULD be taken from Birth Place Type Value Set
      (preferred to https://acsa.africa/std/ValueSet/birth-place-type)
      TypeCoding
      50. BirthNotification.placeOfBirth.parent.reference
      Definition

      Reference to a Location resource

      ShortReference to a Location resource
      Control0..1
      TypeReference(Location)
      52. BirthNotification.placeOfBirth.parent.name
      Definition

      Text name of the location when structured data not available

      ShortText name of the location when structured data not available
      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      54. BirthNotification.placeOfBirth.period
      Definition

      Time period when address was/is in use

      ShortTime period when address was/is in use
      Control0..1
      TypePeriod
      56. BirthNotification.placeOfBirth.text
      Definition

      Text representation of the address

      ShortText representation of the address
      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      58. BirthNotification.biologicalMother
      Definition

      Biological Mother of the child

      ShortBiological Mother of the child
      Control0..1
      TypeReference(Individual Person)
      60. BirthNotification.biologicalFather
      Definition

      Biological Father of the child

      ShortBiological Father of the child
      Control0..1
      TypeReference(Individual Person)
      62. BirthNotification.parties
      Definition

      Gardians, ... of the child

      ShortGardians, ... of the child
      Control0..1
      TypeReference(Individual Person)
      64. BirthNotification.name
      Definition

      Name of the child

      ShortName of the child
      Control0..1
      TypeHumanName
      66. BirthNotification.sex
      Definition

      Sex of the child

      ShortSex of the child
      Control1..1
      BindingThe codes SHALL be taken from Sex Value Set
      (required to https://acsa.africa/std/ValueSet/sex)
      Typecode
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      68. BirthNotification.ethnicity
      Definition

      Ethnicity

      ShortEthnicity
      Control0..1
      TypeCoding
      70. BirthNotification.nationality
      Definition

      Nationalities

      ShortNationalities
      Control0..*
      BindingUnless not suitable, these codes SHALL be taken from CountryValueSet
      (extensible to http://hl7.org/fhir/ValueSet/country)
      TypeCoding
      72. BirthNotification.specialMark
      Definition

      Special mark or note about the birth

      ShortSpecial mark or note about the birth
      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      74. BirthNotification.weightAtBirth
      Definition

      Weight at birth

      ShortWeight at birth
      Control0..1
      TypeQuantity

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

      0. BirthNotification
      Definition

      A new base resource for capturing birth data in the CRVS realm.

      ShortBirth Notification Resource
      2. BirthNotification.identifier
      Definition

      Business identifiers for the notification

      ShortBusiness identifiers for the notification
      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control0..*
      TypeIdentifier
      4. BirthNotification.subject
      Definition

      Subject of the event (person the event happened to)

      ShortSubject of the event (person the event happened to)
      Control0..1
      TypeReference(Individual Person)
      6. BirthNotification.eventDetail
      Definition

      Free text note about the event

      ShortFree text note about the event
      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      8. BirthNotification.dateOfBirth
      Definition

      Date of birth

      ShortDate of birth
      Control1..1
      Typedate
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      10. BirthNotification.placeOfBirth
      Definition

      place of birth of the person

      Shortplace of birth of the person
      Control0..1
      TypeBackboneElement
      12. BirthNotification.placeOfBirth.use
      Definition

      home | work | temp | old | billing - purpose of this address

      Shorthome | work | temp | old | billing - purpose of this address
      Control0..1
      Typecode
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      14. BirthNotification.placeOfBirth.type
      Definition

      postal | physical | both - the type of address

      Shortpostal | physical | both - the type of address
      Control0..1
      Typecode
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      16. BirthNotification.placeOfBirth.line
      Definition

      Street name, number, direction & P.O. Box etc.

      ShortStreet name, number, direction & P.O. Box etc.
      Control0..*
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      18. BirthNotification.placeOfBirth.city
      Definition

      Name of city, town etc.

      ShortName of city, town etc.
      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      20. BirthNotification.placeOfBirth.neighborhood
      Definition

      Name of neighborhood, block

      ShortName of neighborhood, block
      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      22. BirthNotification.placeOfBirth.postalCode
      Definition

      Postal code for area

      ShortPostal code for area
      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      24. BirthNotification.placeOfBirth.parent
      Definition

      Location hierarchy information

      ShortLocation hierarchy information
      Control0..1
      TypeBackboneElement
      Invariantsparent-1: At least one of coding, code, reference, or name must be present (coding.exists() or reference.exists() or name.exists() or code.exists())
      26. BirthNotification.placeOfBirth.parent.code
      Definition

      Simple code for the location type

      ShortSimple code for the location type
      Control0..1
      Typecode
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      28. BirthNotification.placeOfBirth.parent.coding
      Definition

      Coded representation of the location

      ShortCoded representation of the location
      Control0..1
      BindingThe codes SHOULD be taken from Birth Place Type Value Set
      (preferred to https://acsa.africa/std/ValueSet/birth-place-type)
      TypeCoding
      30. BirthNotification.placeOfBirth.parent.reference
      Definition

      Reference to a Location resource

      ShortReference to a Location resource
      Control0..1
      TypeReference(Location)
      32. BirthNotification.placeOfBirth.parent.name
      Definition

      Text name of the location when structured data not available

      ShortText name of the location when structured data not available
      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      34. BirthNotification.placeOfBirth.period
      Definition

      Time period when address was/is in use

      ShortTime period when address was/is in use
      Control0..1
      TypePeriod
      36. BirthNotification.placeOfBirth.text
      Definition

      Text representation of the address

      ShortText representation of the address
      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      38. BirthNotification.biologicalMother
      Definition

      Biological Mother of the child

      ShortBiological Mother of the child
      Control0..1
      TypeReference(Individual Person)
      40. BirthNotification.biologicalFather
      Definition

      Biological Father of the child

      ShortBiological Father of the child
      Control0..1
      TypeReference(Individual Person)
      42. BirthNotification.parties
      Definition

      Gardians, ... of the child

      ShortGardians, ... of the child
      Control0..1
      TypeReference(Individual Person)
      44. BirthNotification.name
      Definition

      Name of the child

      ShortName of the child
      Control0..1
      TypeHumanName
      46. BirthNotification.sex
      Definition

      Sex of the child

      ShortSex of the child
      Control1..1
      BindingThe codes SHALL be taken from Sex Value Set
      (required to https://acsa.africa/std/ValueSet/sex)
      Typecode
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      48. BirthNotification.ethnicity
      Definition

      Ethnicity

      ShortEthnicity
      Control0..1
      TypeCoding
      50. BirthNotification.nationality
      Definition

      Nationalities

      ShortNationalities
      Control0..*
      BindingUnless not suitable, these codes SHALL be taken from CountryValueSet
      (extensible to http://hl7.org/fhir/ValueSet/country)
      TypeCoding
      52. BirthNotification.specialMark
      Definition

      Special mark or note about the birth

      ShortSpecial mark or note about the birth
      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      54. BirthNotification.weightAtBirth
      Definition

      Weight at birth

      ShortWeight at birth
      Control0..1
      TypeQuantity

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

      0. BirthNotification
      Definition

      A new base resource for capturing birth data in the CRVS realm.

      ShortBirth Notification Resource
      Control0..*
      Is Modifierfalse
      Must Supportfalse
      Summaryfalse
      2. BirthNotification.id
      Definition

      The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

      ShortLogical id of this artifact
      Comments

      Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

      Control0..1
      Typeid
      Is Modifierfalse
      Must Supportfalse
      Summarytrue
      4. BirthNotification.meta
      Definition

      The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

      ShortMetadata about the resource
      Control0..1
      TypeMeta
      Is Modifierfalse
      Must Supportfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      6. BirthNotification.implicitRules
      Definition

      A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

      ShortA set of rules under which this content was created
      Comments

      Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

      Control0..1
      Typeuri
      Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supportfalse
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      8. BirthNotification.language
      Definition

      The base language in which the resource is written.

      ShortLanguage of the resource content
      Comments

      Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

      Control0..1
      BindingThe codes SHALL be taken from AllLanguages
      (required to http://hl7.org/fhir/ValueSet/all-languages|5.0.0)

      IETF language tag for a human language

      Typecode
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supportfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      10. BirthNotification.identifier
      Definition

      Business identifiers for the notification

      ShortBusiness identifiers for the notification
      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control0..*
      TypeIdentifier
      12. BirthNotification.subject
      Definition

      Subject of the event (person the event happened to)

      ShortSubject of the event (person the event happened to)
      Control0..1
      TypeReference(Individual Person)
      14. BirthNotification.eventDetail
      Definition

      Free text note about the event

      ShortFree text note about the event
      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      16. BirthNotification.dateOfBirth
      Definition

      Date of birth

      ShortDate of birth
      Control1..1
      Typedate
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      18. BirthNotification.placeOfBirth
      Definition

      place of birth of the person

      Shortplace of birth of the person
      Control0..1
      TypeBackboneElement
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      20. BirthNotification.placeOfBirth.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
      22. BirthNotification.placeOfBirth.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 BirthNotification.placeOfBirth.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 24. BirthNotification.placeOfBirth.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())
        26. BirthNotification.placeOfBirth.use
        Definition

        home | work | temp | old | billing - purpose of this address

        Shorthome | work | temp | old | billing - purpose of this address
        Control0..1
        Typecode
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        28. BirthNotification.placeOfBirth.type
        Definition

        postal | physical | both - the type of address

        Shortpostal | physical | both - the type of address
        Control0..1
        Typecode
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        30. BirthNotification.placeOfBirth.line
        Definition

        Street name, number, direction & P.O. Box etc.

        ShortStreet name, number, direction & P.O. Box etc.
        Control0..*
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        32. BirthNotification.placeOfBirth.city
        Definition

        Name of city, town etc.

        ShortName of city, town etc.
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        34. BirthNotification.placeOfBirth.neighborhood
        Definition

        Name of neighborhood, block

        ShortName of neighborhood, block
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        36. BirthNotification.placeOfBirth.postalCode
        Definition

        Postal code for area

        ShortPostal code for area
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        38. BirthNotification.placeOfBirth.parent
        Definition

        Location hierarchy information

        ShortLocation hierarchy information
        Control0..1
        TypeBackboneElement
        Invariantsparent-1: At least one of coding, code, reference, or name must be present (coding.exists() or reference.exists() or name.exists() or code.exists())
        ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        40. BirthNotification.placeOfBirth.parent.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
        42. BirthNotification.placeOfBirth.parent.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 BirthNotification.placeOfBirth.parent.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 44. BirthNotification.placeOfBirth.parent.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())
          46. BirthNotification.placeOfBirth.parent.code
          Definition

          Simple code for the location type

          ShortSimple code for the location type
          Control0..1
          Typecode
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          48. BirthNotification.placeOfBirth.parent.coding
          Definition

          Coded representation of the location

          ShortCoded representation of the location
          Control0..1
          BindingThe codes SHOULD be taken from Birth Place Type Value Set
          (preferred to https://acsa.africa/std/ValueSet/birth-place-type)
          TypeCoding
          50. BirthNotification.placeOfBirth.parent.reference
          Definition

          Reference to a Location resource

          ShortReference to a Location resource
          Control0..1
          TypeReference(Location)
          52. BirthNotification.placeOfBirth.parent.name
          Definition

          Text name of the location when structured data not available

          ShortText name of the location when structured data not available
          Control0..1
          Typestring
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          54. BirthNotification.placeOfBirth.period
          Definition

          Time period when address was/is in use

          ShortTime period when address was/is in use
          Control0..1
          TypePeriod
          56. BirthNotification.placeOfBirth.text
          Definition

          Text representation of the address

          ShortText representation of the address
          Control0..1
          Typestring
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          58. BirthNotification.biologicalMother
          Definition

          Biological Mother of the child

          ShortBiological Mother of the child
          Control0..1
          TypeReference(Individual Person)
          60. BirthNotification.biologicalFather
          Definition

          Biological Father of the child

          ShortBiological Father of the child
          Control0..1
          TypeReference(Individual Person)
          62. BirthNotification.parties
          Definition

          Gardians, ... of the child

          ShortGardians, ... of the child
          Control0..1
          TypeReference(Individual Person)
          64. BirthNotification.name
          Definition

          Name of the child

          ShortName of the child
          Control0..1
          TypeHumanName
          66. BirthNotification.sex
          Definition

          Sex of the child

          ShortSex of the child
          Control1..1
          BindingThe codes SHALL be taken from Sex Value Set
          (required to https://acsa.africa/std/ValueSet/sex)
          Typecode
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          68. BirthNotification.ethnicity
          Definition

          Ethnicity

          ShortEthnicity
          Control0..1
          TypeCoding
          70. BirthNotification.nationality
          Definition

          Nationalities

          ShortNationalities
          Control0..*
          BindingUnless not suitable, these codes SHALL be taken from CountryValueSet
          (extensible to http://hl7.org/fhir/ValueSet/country)
          TypeCoding
          72. BirthNotification.specialMark
          Definition

          Special mark or note about the birth

          ShortSpecial mark or note about the birth
          Control0..1
          Typestring
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          74. BirthNotification.weightAtBirth
          Definition

          Weight at birth

          ShortWeight at birth
          Control0..1
          TypeQuantity