Example CRVS Implementation Guide
0.1.0 - ci-build

Resource Profile: Individual Person

Official URL: http://acsa.africa/standard/StructureDefinition/Individual Version: 0.1.0
Active as of 2025-03-28 Computable Name: Individual

A custom resource representing a person in the context of Civil Registration and Vital Statistics (CRVS) systems.

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Individual 0..* DomainResource Individual Person
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... meta Σ 0..1 Meta Metadata about the resource
ele-1: All FHIR elements must have a @value or children
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguages Starter

ele-1: All FHIR elements must have a @value or children
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... dateOfBirth 1..1 date Date of birth
... placeOfBirth[x] 0..1 Country of birth of the person
Binding: CountryValueSet (extensible)
.... placeOfBirthCoding Coding
.... placeOfBirthAddress Address
.... placeOfBirthReference Reference(Location)
... mother 1..1 Reference(Individual Person) Mother of the child
... father 0..1 Reference(Individual Person) Father of the child
... name 0..1 HumanName Name of the child
... sex 1..1 code Sex of the child
Binding: Sex Value Set (required)
... maritalStatus 0..1 code Martial Status
Binding: Person Marital Status Value Set (extensible)
... civilStatus 0..1 code Civil status
Binding: civil Status Value Set (required)
... dateOfDeath 0..1 date Date of birth
... deathPlace[x] 0..1 place where lives
.... deathPlaceAddress Address
.... deathPlaceReference Reference(Location)
... placeOfResidence[x] 0..1 place where lives
.... placeOfResidenceAddress Address
.... placeOfResidenceReference Reference(Location)
... placeOfResidenceSince 0..1 date Date the ' moved in in that residence
... previousPlacesOfResidence[x] 0..* previous places where lived
.... previousPlacesOfResidenceAddress Address
.... previousPlacesOfResidenceReference Reference(Location)
... ethnicity 0..1 code Ethnicity
... nationality 0..1 Coding Nationality
Binding: CountryValueSet (extensible)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Individual.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
Individual.placeOfBirth[x]extensibleCountryValueSet
http://hl7.org/fhir/ValueSet/country
from the FHIR Standard
Individual.sexrequiredSex
http://acsa.afrika/standard/ValueSet/sex
from this IG
Individual.maritalStatusextensibleMaritalStatus
http://acsa.afrika/standard/ValueSet/marital-status
from this IG
Individual.civilStatusrequiredCivilStatus
http://acsa.afrika/standard/ValueSet/civil-status
from this IG
Individual.nationalityextensibleCountryValueSet
http://hl7.org/fhir/ValueSet/country
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorIndividualIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorIndividualIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorIndividualIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorIndividualIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceIndividualA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from DomainResource

NameFlagsCard.TypeDescription & Constraintsdoco
.. Individual 0..* DomainResource Individual Person
... dateOfBirth 1..1 date Date of birth
... placeOfBirth[x] 0..1 Country of birth of the person
Binding: CountryValueSet (extensible)
.... placeOfBirthCoding Coding
.... placeOfBirthAddress Address
.... placeOfBirthReference Reference(Location)
... mother 1..1 Reference(Individual Person) Mother of the child
... name 0..1 HumanName Name of the child
... sex 1..1 code Sex of the child
Binding: Sex Value Set (required)
... maritalStatus 0..1 code Martial Status
Binding: Person Marital Status Value Set (extensible)
... civilStatus 0..1 code Civil status
Binding: civil Status Value Set (required)
... dateOfDeath 0..1 date Date of birth
... deathPlace[x] 0..1 place where lives
.... deathPlaceAddress Address
.... deathPlaceReference Reference(Location)
... placeOfResidence[x] 0..1 place where lives
.... placeOfResidenceAddress Address
.... placeOfResidenceReference Reference(Location)
... placeOfResidenceSince 0..1 date Date the ' moved in in that residence
... previousPlacesOfResidence[x] 0..* previous places where lived
.... previousPlacesOfResidenceAddress Address
.... previousPlacesOfResidenceReference Reference(Location)
... ethnicity 0..1 code Ethnicity
... nationality 0..1 Coding Nationality
Binding: CountryValueSet (extensible)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Individual.placeOfBirth[x]extensibleCountryValueSet
http://hl7.org/fhir/ValueSet/country
from the FHIR Standard
Individual.sexrequiredSex
http://acsa.afrika/standard/ValueSet/sex
from this IG
Individual.maritalStatusextensibleMaritalStatus
http://acsa.afrika/standard/ValueSet/marital-status
from this IG
Individual.civilStatusrequiredCivilStatus
http://acsa.afrika/standard/ValueSet/civil-status
from this IG
Individual.nationalityextensibleCountryValueSet
http://hl7.org/fhir/ValueSet/country
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. Individual 0..* DomainResource Individual Person
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguages Starter
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... dateOfBirth 1..1 date Date of birth
... placeOfBirth[x] 0..1 Country of birth of the person
Binding: CountryValueSet (extensible)
.... placeOfBirthCoding Coding
.... placeOfBirthAddress Address
.... placeOfBirthReference Reference(Location)
... mother 1..1 Reference(Individual Person) Mother of the child
... father 0..1 Reference(Individual Person) Father of the child
... name 0..1 HumanName Name of the child
... sex 1..1 code Sex of the child
Binding: Sex Value Set (required)
... maritalStatus 0..1 code Martial Status
Binding: Person Marital Status Value Set (extensible)
... civilStatus 0..1 code Civil status
Binding: civil Status Value Set (required)
... dateOfDeath 0..1 date Date of birth
... deathPlace[x] 0..1 place where lives
.... deathPlaceAddress Address
.... deathPlaceReference Reference(Location)
... placeOfResidence[x] 0..1 place where lives
.... placeOfResidenceAddress Address
.... placeOfResidenceReference Reference(Location)
... placeOfResidenceSince 0..1 date Date the ' moved in in that residence
... previousPlacesOfResidence[x] 0..* previous places where lived
.... previousPlacesOfResidenceAddress Address
.... previousPlacesOfResidenceReference Reference(Location)
... ethnicity 0..1 code Ethnicity
... nationality 0..1 Coding Nationality
Binding: CountryValueSet (extensible)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Individual.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
Individual.placeOfBirth[x]extensibleCountryValueSet
http://hl7.org/fhir/ValueSet/country
from the FHIR Standard
Individual.sexrequiredSex
http://acsa.afrika/standard/ValueSet/sex
from this IG
Individual.maritalStatusextensibleMaritalStatus
http://acsa.afrika/standard/ValueSet/marital-status
from this IG
Individual.civilStatusrequiredCivilStatus
http://acsa.afrika/standard/ValueSet/civil-status
from this IG
Individual.nationalityextensibleCountryValueSet
http://hl7.org/fhir/ValueSet/country
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorIndividualIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorIndividualIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorIndividualIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorIndividualIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceIndividualA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from DomainResource

Summary

Mandatory: 0 element(3 nested mandatory elements)

Structures

This structure refers to these other structures:

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Individual 0..* DomainResource Individual Person
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... meta Σ 0..1 Meta Metadata about the resource
ele-1: All FHIR elements must have a @value or children
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguages Starter

ele-1: All FHIR elements must have a @value or children
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... dateOfBirth 1..1 date Date of birth
... placeOfBirth[x] 0..1 Country of birth of the person
Binding: CountryValueSet (extensible)
.... placeOfBirthCoding Coding
.... placeOfBirthAddress Address
.... placeOfBirthReference Reference(Location)
... mother 1..1 Reference(Individual Person) Mother of the child
... father 0..1 Reference(Individual Person) Father of the child
... name 0..1 HumanName Name of the child
... sex 1..1 code Sex of the child
Binding: Sex Value Set (required)
... maritalStatus 0..1 code Martial Status
Binding: Person Marital Status Value Set (extensible)
... civilStatus 0..1 code Civil status
Binding: civil Status Value Set (required)
... dateOfDeath 0..1 date Date of birth
... deathPlace[x] 0..1 place where lives
.... deathPlaceAddress Address
.... deathPlaceReference Reference(Location)
... placeOfResidence[x] 0..1 place where lives
.... placeOfResidenceAddress Address
.... placeOfResidenceReference Reference(Location)
... placeOfResidenceSince 0..1 date Date the ' moved in in that residence
... previousPlacesOfResidence[x] 0..* previous places where lived
.... previousPlacesOfResidenceAddress Address
.... previousPlacesOfResidenceReference Reference(Location)
... ethnicity 0..1 code Ethnicity
... nationality 0..1 Coding Nationality
Binding: CountryValueSet (extensible)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Individual.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
Individual.placeOfBirth[x]extensibleCountryValueSet
http://hl7.org/fhir/ValueSet/country
from the FHIR Standard
Individual.sexrequiredSex
http://acsa.afrika/standard/ValueSet/sex
from this IG
Individual.maritalStatusextensibleMaritalStatus
http://acsa.afrika/standard/ValueSet/marital-status
from this IG
Individual.civilStatusrequiredCivilStatus
http://acsa.afrika/standard/ValueSet/civil-status
from this IG
Individual.nationalityextensibleCountryValueSet
http://hl7.org/fhir/ValueSet/country
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorIndividualIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorIndividualIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorIndividualIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorIndividualIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceIndividualA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from DomainResource

NameFlagsCard.TypeDescription & Constraintsdoco
.. Individual 0..* DomainResource Individual Person
... dateOfBirth 1..1 date Date of birth
... placeOfBirth[x] 0..1 Country of birth of the person
Binding: CountryValueSet (extensible)
.... placeOfBirthCoding Coding
.... placeOfBirthAddress Address
.... placeOfBirthReference Reference(Location)
... mother 1..1 Reference(Individual Person) Mother of the child
... name 0..1 HumanName Name of the child
... sex 1..1 code Sex of the child
Binding: Sex Value Set (required)
... maritalStatus 0..1 code Martial Status
Binding: Person Marital Status Value Set (extensible)
... civilStatus 0..1 code Civil status
Binding: civil Status Value Set (required)
... dateOfDeath 0..1 date Date of birth
... deathPlace[x] 0..1 place where lives
.... deathPlaceAddress Address
.... deathPlaceReference Reference(Location)
... placeOfResidence[x] 0..1 place where lives
.... placeOfResidenceAddress Address
.... placeOfResidenceReference Reference(Location)
... placeOfResidenceSince 0..1 date Date the ' moved in in that residence
... previousPlacesOfResidence[x] 0..* previous places where lived
.... previousPlacesOfResidenceAddress Address
.... previousPlacesOfResidenceReference Reference(Location)
... ethnicity 0..1 code Ethnicity
... nationality 0..1 Coding Nationality
Binding: CountryValueSet (extensible)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Individual.placeOfBirth[x]extensibleCountryValueSet
http://hl7.org/fhir/ValueSet/country
from the FHIR Standard
Individual.sexrequiredSex
http://acsa.afrika/standard/ValueSet/sex
from this IG
Individual.maritalStatusextensibleMaritalStatus
http://acsa.afrika/standard/ValueSet/marital-status
from this IG
Individual.civilStatusrequiredCivilStatus
http://acsa.afrika/standard/ValueSet/civil-status
from this IG
Individual.nationalityextensibleCountryValueSet
http://hl7.org/fhir/ValueSet/country
from the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Individual 0..* DomainResource Individual Person
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguages Starter
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Slice: Unordered, Open by value:url
... dateOfBirth 1..1 date Date of birth
... placeOfBirth[x] 0..1 Country of birth of the person
Binding: CountryValueSet (extensible)
.... placeOfBirthCoding Coding
.... placeOfBirthAddress Address
.... placeOfBirthReference Reference(Location)
... mother 1..1 Reference(Individual Person) Mother of the child
... father 0..1 Reference(Individual Person) Father of the child
... name 0..1 HumanName Name of the child
... sex 1..1 code Sex of the child
Binding: Sex Value Set (required)
... maritalStatus 0..1 code Martial Status
Binding: Person Marital Status Value Set (extensible)
... civilStatus 0..1 code Civil status
Binding: civil Status Value Set (required)
... dateOfDeath 0..1 date Date of birth
... deathPlace[x] 0..1 place where lives
.... deathPlaceAddress Address
.... deathPlaceReference Reference(Location)
... placeOfResidence[x] 0..1 place where lives
.... placeOfResidenceAddress Address
.... placeOfResidenceReference Reference(Location)
... placeOfResidenceSince 0..1 date Date the ' moved in in that residence
... previousPlacesOfResidence[x] 0..* previous places where lived
.... previousPlacesOfResidenceAddress Address
.... previousPlacesOfResidenceReference Reference(Location)
... ethnicity 0..1 code Ethnicity
... nationality 0..1 Coding Nationality
Binding: CountryValueSet (extensible)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Individual.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
Individual.placeOfBirth[x]extensibleCountryValueSet
http://hl7.org/fhir/ValueSet/country
from the FHIR Standard
Individual.sexrequiredSex
http://acsa.afrika/standard/ValueSet/sex
from this IG
Individual.maritalStatusextensibleMaritalStatus
http://acsa.afrika/standard/ValueSet/marital-status
from this IG
Individual.civilStatusrequiredCivilStatus
http://acsa.afrika/standard/ValueSet/civil-status
from this IG
Individual.nationalityextensibleCountryValueSet
http://hl7.org/fhir/ValueSet/country
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorIndividualIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorIndividualIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorIndividualIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorIndividualIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceIndividualA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from DomainResource

Summary

Mandatory: 0 element(3 nested mandatory elements)

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel, Schematron