Example CRVS Implementation Guide
0.1.0 - ci-build

Resource Profile: Separation Ruling Resource ( Experimental )

Official URL: https://acsa.africa/std/StructureDefinition/SeparationRuling Version: 0.1.0
Draft as of 2025-12-08 Computable Name: SeparationRuling

A resource for capturing legal separation rulings in the CRVS realm.

Usages:

  • This Resource is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. SeparationRuling 0..* Resource Separation Ruling Resource

Elements defined in Ancestors:id, meta, implicitRules, language
... 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
... rulingDate 1..1 date Date when the ruling was issued
... rulingPlace 0..1 BackboneElement Place where the ruling was issued
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... use 0..1 code home | work | temp | old | billing - purpose of this address
.... type 0..1 code postal | physical | both - the type of address
.... line 0..* string Street name, number, direction & P.O. Box etc.
.... city 0..1 string Name of city, town etc.
.... neighborhood 0..1 string Name of neighborhood, block
.... postalCode 0..1 string Postal code for area
.... parent C 0..1 BackboneElement Location hierarchy information
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code 0..1 code Simple code for the location type
..... coding 0..1 Coding Coded representation of the location
Binding: Birth Place Type Value Set (preferred)
..... reference 0..1 Reference(Location) Reference to a Location resource
..... name 0..1 string Text name of the location when structured data not available
.... period 0..1 Period Time period when address was/is in use
.... text 0..1 string Text representation of the address
... court C 0..1 BackboneElement Court that issued the ruling
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... reference 0..1 Reference(Organization) Reference to the Court that issued the ruling
.... coding 0..1 Coding Coding for the court that issued the ruling
.... name 0..1 string Name of the court that issued the ruling
... judge 0..1 Reference(Practitioner) Judge who issued the ruling
... parties 0..* BackboneElement Additional parties involved in the ruling
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... role 1..1 code Role of this party
Binding: Party Role ValueSet (required)
.... individual 1..1 Reference(Individual Person) The individual party
... rulingDetails 0..1 string Details of the ruling
... eventNote 0..1 string Free text note about the ruling event
... marriageReference 0..1 Reference(Marriage Declaration Resource) Reference to the marriage being legally separated
... separationType 0..1 code Type of legal separation
Binding: Separation Type Value Set (extensible)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
SeparationRuling.language Base required All Languages 📍5.0.0 FHIR Std.
SeparationRuling.rulingType Base required Ruling Type Value Set 📦0.1.0 This IG
SeparationRuling.rulingPlace.​parent.coding Base preferred Birth Place Type Value Set 📦0.1.0 This IG
SeparationRuling.parties.​role Base required Party Role ValueSet 📦0.1.0 This IG
SeparationRuling.separationType Base extensible Separation Type Value Set 📦0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
court-1 error **ALL** elements 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 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
parent-1 error **ALL** elements At least one of coding, code, reference, or name must be present coding.exists() or reference.exists() or name.exists() or code.exists()

This structure is derived from Resource

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. SeparationRuling 0..* Resource Separation Ruling Resource

Elements defined in Ancestors:id, meta, implicitRules, language
... rulingType 1..1 code Type of ruling
Binding: Ruling Type Value Set (required)
... rulingDate 1..1 date Date when the ruling was issued
... rulingPlace 0..1 BackboneElement Place where the ruling was issued
.... use 0..1 code home | work | temp | old | billing - purpose of this address
.... type 0..1 code postal | physical | both - the type of address
.... line 0..* string Street name, number, direction & P.O. Box etc.
.... city 0..1 string Name of city, town etc.
.... neighborhood 0..1 string Name of neighborhood, block
.... postalCode 0..1 string Postal code for area
.... parent C 0..1 BackboneElement Location hierarchy information
..... code 0..1 code Simple code for the location type
..... coding 0..1 Coding Coded representation of the location
Binding: Birth Place Type Value Set (preferred)
..... reference 0..1 Reference(Location) Reference to a Location resource
..... name 0..1 string Text name of the location when structured data not available
.... period 0..1 Period Time period when address was/is in use
.... text 0..1 string Text representation of the address
.... reference 0..1 Reference(Organization) Reference to the Court that issued the ruling
.... coding 0..1 Coding Coding for the court that issued the ruling
.... name 0..1 string Name of the court that issued the ruling
... judge 0..1 Reference(Practitioner) Judge who issued the ruling
... parties 0..* BackboneElement Additional parties involved in the ruling
.... role 1..1 code Role of this party
Binding: Party Role ValueSet (required)
.... individual 1..1 Reference(Individual Person) The individual party
... rulingDetails 0..1 string Details of the ruling
... eventNote 0..1 string Free text note about the ruling event
... marriageReference 0..1 Reference(Marriage Declaration Resource) Reference to the marriage being legally separated
... separationType 0..1 code Type of legal separation
Binding: Separation Type Value Set (extensible)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
SeparationRuling.rulingType Base required Ruling Type Value Set 📦0.1.0 This IG
SeparationRuling.rulingPlace.​parent.coding Base preferred Birth Place Type Value Set 📦0.1.0 This IG
SeparationRuling.parties.​role Base required Party Role ValueSet 📦0.1.0 This IG
SeparationRuling.separationType Base extensible Separation Type Value Set 📦0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
court-1 error **ALL** elements At least one of coding, code, reference, or name must be present coding.exists() or reference.exists() or name.exists() or code.exists()
parent-1 error **ALL** elements At least one of coding, code, reference, or name must be present coding.exists() or reference.exists() or name.exists() or code.exists()
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. SeparationRuling 0..* Resource Separation Ruling Resource

Elements defined in Ancestors:id, meta, implicitRules, language
... 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
... rulingDate 1..1 date Date when the ruling was issued
... rulingPlace 0..1 BackboneElement Place where the ruling was issued
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... use 0..1 code home | work | temp | old | billing - purpose of this address
.... type 0..1 code postal | physical | both - the type of address
.... line 0..* string Street name, number, direction & P.O. Box etc.
.... city 0..1 string Name of city, town etc.
.... neighborhood 0..1 string Name of neighborhood, block
.... postalCode 0..1 string Postal code for area
.... parent C 0..1 BackboneElement Location hierarchy information
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code 0..1 code Simple code for the location type
..... coding 0..1 Coding Coded representation of the location
Binding: Birth Place Type Value Set (preferred)
..... reference 0..1 Reference(Location) Reference to a Location resource
..... name 0..1 string Text name of the location when structured data not available
.... period 0..1 Period Time period when address was/is in use
.... text 0..1 string Text representation of the address
... court C 0..1 BackboneElement Court that issued the ruling
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... reference 0..1 Reference(Organization) Reference to the Court that issued the ruling
.... coding 0..1 Coding Coding for the court that issued the ruling
.... name 0..1 string Name of the court that issued the ruling
... judge 0..1 Reference(Practitioner) Judge who issued the ruling
... parties 0..* BackboneElement Additional parties involved in the ruling
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... role 1..1 code Role of this party
Binding: Party Role ValueSet (required)
.... individual 1..1 Reference(Individual Person) The individual party
... rulingDetails 0..1 string Details of the ruling
... eventNote 0..1 string Free text note about the ruling event
... marriageReference 0..1 Reference(Marriage Declaration Resource) Reference to the marriage being legally separated
... separationType 0..1 code Type of legal separation
Binding: Separation Type Value Set (extensible)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
SeparationRuling.language Base required All Languages 📍5.0.0 FHIR Std.
SeparationRuling.rulingType Base required Ruling Type Value Set 📦0.1.0 This IG
SeparationRuling.rulingPlace.​parent.coding Base preferred Birth Place Type Value Set 📦0.1.0 This IG
SeparationRuling.parties.​role Base required Party Role ValueSet 📦0.1.0 This IG
SeparationRuling.separationType Base extensible Separation Type Value Set 📦0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
court-1 error **ALL** elements 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 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
parent-1 error **ALL** elements At least one of coding, code, reference, or name must be present coding.exists() or reference.exists() or name.exists() or code.exists()

This structure is derived from Resource

Summary

Mandatory: 0 element(4 nested mandatory elements)

Structures

This structure refers to these other structures:

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. SeparationRuling 0..* Resource Separation Ruling Resource

Elements defined in Ancestors:id, meta, implicitRules, language
... 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
... rulingDate 1..1 date Date when the ruling was issued
... rulingPlace 0..1 BackboneElement Place where the ruling was issued
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... use 0..1 code home | work | temp | old | billing - purpose of this address
.... type 0..1 code postal | physical | both - the type of address
.... line 0..* string Street name, number, direction & P.O. Box etc.
.... city 0..1 string Name of city, town etc.
.... neighborhood 0..1 string Name of neighborhood, block
.... postalCode 0..1 string Postal code for area
.... parent C 0..1 BackboneElement Location hierarchy information
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code 0..1 code Simple code for the location type
..... coding 0..1 Coding Coded representation of the location
Binding: Birth Place Type Value Set (preferred)
..... reference 0..1 Reference(Location) Reference to a Location resource
..... name 0..1 string Text name of the location when structured data not available
.... period 0..1 Period Time period when address was/is in use
.... text 0..1 string Text representation of the address
... court C 0..1 BackboneElement Court that issued the ruling
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... reference 0..1 Reference(Organization) Reference to the Court that issued the ruling
.... coding 0..1 Coding Coding for the court that issued the ruling
.... name 0..1 string Name of the court that issued the ruling
... judge 0..1 Reference(Practitioner) Judge who issued the ruling
... parties 0..* BackboneElement Additional parties involved in the ruling
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... role 1..1 code Role of this party
Binding: Party Role ValueSet (required)
.... individual 1..1 Reference(Individual Person) The individual party
... rulingDetails 0..1 string Details of the ruling
... eventNote 0..1 string Free text note about the ruling event
... marriageReference 0..1 Reference(Marriage Declaration Resource) Reference to the marriage being legally separated
... separationType 0..1 code Type of legal separation
Binding: Separation Type Value Set (extensible)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
SeparationRuling.language Base required All Languages 📍5.0.0 FHIR Std.
SeparationRuling.rulingType Base required Ruling Type Value Set 📦0.1.0 This IG
SeparationRuling.rulingPlace.​parent.coding Base preferred Birth Place Type Value Set 📦0.1.0 This IG
SeparationRuling.parties.​role Base required Party Role ValueSet 📦0.1.0 This IG
SeparationRuling.separationType Base extensible Separation Type Value Set 📦0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
court-1 error **ALL** elements 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 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
parent-1 error **ALL** elements At least one of coding, code, reference, or name must be present coding.exists() or reference.exists() or name.exists() or code.exists()

Differential View

This structure is derived from Resource

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. SeparationRuling 0..* Resource Separation Ruling Resource

Elements defined in Ancestors:id, meta, implicitRules, language
... rulingType 1..1 code Type of ruling
Binding: Ruling Type Value Set (required)
... rulingDate 1..1 date Date when the ruling was issued
... rulingPlace 0..1 BackboneElement Place where the ruling was issued
.... use 0..1 code home | work | temp | old | billing - purpose of this address
.... type 0..1 code postal | physical | both - the type of address
.... line 0..* string Street name, number, direction & P.O. Box etc.
.... city 0..1 string Name of city, town etc.
.... neighborhood 0..1 string Name of neighborhood, block
.... postalCode 0..1 string Postal code for area
.... parent C 0..1 BackboneElement Location hierarchy information
..... code 0..1 code Simple code for the location type
..... coding 0..1 Coding Coded representation of the location
Binding: Birth Place Type Value Set (preferred)
..... reference 0..1 Reference(Location) Reference to a Location resource
..... name 0..1 string Text name of the location when structured data not available
.... period 0..1 Period Time period when address was/is in use
.... text 0..1 string Text representation of the address
.... reference 0..1 Reference(Organization) Reference to the Court that issued the ruling
.... coding 0..1 Coding Coding for the court that issued the ruling
.... name 0..1 string Name of the court that issued the ruling
... judge 0..1 Reference(Practitioner) Judge who issued the ruling
... parties 0..* BackboneElement Additional parties involved in the ruling
.... role 1..1 code Role of this party
Binding: Party Role ValueSet (required)
.... individual 1..1 Reference(Individual Person) The individual party
... rulingDetails 0..1 string Details of the ruling
... eventNote 0..1 string Free text note about the ruling event
... marriageReference 0..1 Reference(Marriage Declaration Resource) Reference to the marriage being legally separated
... separationType 0..1 code Type of legal separation
Binding: Separation Type Value Set (extensible)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
SeparationRuling.rulingType Base required Ruling Type Value Set 📦0.1.0 This IG
SeparationRuling.rulingPlace.​parent.coding Base preferred Birth Place Type Value Set 📦0.1.0 This IG
SeparationRuling.parties.​role Base required Party Role ValueSet 📦0.1.0 This IG
SeparationRuling.separationType Base extensible Separation Type Value Set 📦0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
court-1 error **ALL** elements At least one of coding, code, reference, or name must be present coding.exists() or reference.exists() or name.exists() or code.exists()
parent-1 error **ALL** elements At least one of coding, code, reference, or name must be present coding.exists() or reference.exists() or name.exists() or code.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. SeparationRuling 0..* Resource Separation Ruling Resource

Elements defined in Ancestors:id, meta, implicitRules, language
... 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
... rulingDate 1..1 date Date when the ruling was issued
... rulingPlace 0..1 BackboneElement Place where the ruling was issued
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... use 0..1 code home | work | temp | old | billing - purpose of this address
.... type 0..1 code postal | physical | both - the type of address
.... line 0..* string Street name, number, direction & P.O. Box etc.
.... city 0..1 string Name of city, town etc.
.... neighborhood 0..1 string Name of neighborhood, block
.... postalCode 0..1 string Postal code for area
.... parent C 0..1 BackboneElement Location hierarchy information
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... code 0..1 code Simple code for the location type
..... coding 0..1 Coding Coded representation of the location
Binding: Birth Place Type Value Set (preferred)
..... reference 0..1 Reference(Location) Reference to a Location resource
..... name 0..1 string Text name of the location when structured data not available
.... period 0..1 Period Time period when address was/is in use
.... text 0..1 string Text representation of the address
... court C 0..1 BackboneElement Court that issued the ruling
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... reference 0..1 Reference(Organization) Reference to the Court that issued the ruling
.... coding 0..1 Coding Coding for the court that issued the ruling
.... name 0..1 string Name of the court that issued the ruling
... judge 0..1 Reference(Practitioner) Judge who issued the ruling
... parties 0..* BackboneElement Additional parties involved in the ruling
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... role 1..1 code Role of this party
Binding: Party Role ValueSet (required)
.... individual 1..1 Reference(Individual Person) The individual party
... rulingDetails 0..1 string Details of the ruling
... eventNote 0..1 string Free text note about the ruling event
... marriageReference 0..1 Reference(Marriage Declaration Resource) Reference to the marriage being legally separated
... separationType 0..1 code Type of legal separation
Binding: Separation Type Value Set (extensible)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
SeparationRuling.language Base required All Languages 📍5.0.0 FHIR Std.
SeparationRuling.rulingType Base required Ruling Type Value Set 📦0.1.0 This IG
SeparationRuling.rulingPlace.​parent.coding Base preferred Birth Place Type Value Set 📦0.1.0 This IG
SeparationRuling.parties.​role Base required Party Role ValueSet 📦0.1.0 This IG
SeparationRuling.separationType Base extensible Separation Type Value Set 📦0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
court-1 error **ALL** elements 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 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
parent-1 error **ALL** elements At least one of coding, code, reference, or name must be present coding.exists() or reference.exists() or name.exists() or code.exists()

This structure is derived from Resource

Summary

Mandatory: 0 element(4 nested mandatory elements)

Structures

This structure refers to these other structures:

 

​Other representations of profile: CSV, Excel, Schematron