Vital Records Death Reporting (VRDR) FHIR Implementation Guide
3.0.0-ballot - ballot United States of America flag

This page is part of the Vital Records Death Reporting FHIR Implementation Guide (v3.0.0-ballot: STU 3 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 2.2.0. For a full list of available versions, see the Directory of published versions

Resource Profile: Decedent Spouse

Official URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/vrdr-decedent-spouse Version: 3.0.0-ballot
Draft as of 2024-04-05 Computable Name: DecedentSpouse
Other Identifiers: OID:2.16.840.1.113883.4.642.40.10.42.36

Decedent Spouse (USCoreRelatedPerson)

IJE Mapping

Mortality (Decedent)
Use Case # Description IJE Name Field Type Value Set/Comments
Mortality 144 Spouse's First Name SPOUSEF name.given string -
Mortality 145 Husband's Surname/Wife's Maiden Last Name SPOUSEL name.family, name.use = 'maiden string -
Mortality 197 Spouse's Middle Name SPOUSEMIDNAME name.given , name.use = official string -
Mortality 198 Spouse's Suffix SPOUSESUFFIX name.suffix , name.use = official string -

Form Mapping

Form Mapping
Item # Form Field FHIR Profile Field Reference
10 Surviving Spouse's Name name Certificate of Death

Usage:

Changes since version true:

  • No changes
  • Formal Views of Profile Content

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

    This structure is derived from USCoreRelatedPersonProfile

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. RelatedPerson USCoreRelatedPersonProfile
    ... active 1..1 boolean Whether this related person's record is in active use
    Required Pattern: true
    ... patient 1..1 Reference(Patient - Vital Records) Decedent
    ... relationship 1..1 CodeableConcept relationship
    Required Pattern: At least the following
    .... coding 1..* Coding Code defined by a terminology system
    Fixed Value: (complex)
    ..... system 1..1 uri Identity of the terminology system
    Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode
    ..... code 1..1 code Symbol in syntax defined by the system
    Fixed Value: SPS
    .... text 0..1 string Plain text representation of the concept
    Required Pattern: Spouse
    .... family 0..1 string Maiden name if name.use=maiden

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. RelatedPerson C 0..* USCoreRelatedPersonProfile A person that is related to a patient, but who is not a direct target of care
    us-core-14: Either a name or a relationship SHALL be provided (or both)
    ... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
    ... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
    ... active ?!SΣ 1..1 boolean Whether this related person's record is in active use
    Required Pattern: true
    ... relationship SΣC 1..1 CodeableConcept relationship
    Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.



    Required Pattern: At least the following
    .... coding 1..* Coding Code defined by a terminology system
    Fixed Value: (complex)
    ..... system 1..1 uri Identity of the terminology system
    Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode
    ..... code 1..1 code Symbol in syntax defined by the system
    Fixed Value: SPS
    .... text Σ 0..1 string Plain text representation of the concept
    Required Pattern: Spouse
    ... name SΣC 0..* HumanName A name associated with the person
    .... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
    Binding: NameUse (required): The use of a human name.

    .... family Σ 0..1 string Maiden name if name.use=maiden
    ... telecom SΣ 0..* ContactPoint A contact detail for the person
    ... address SΣ 0..* Address Address where the related person can be contacted or visited

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSet / CodeURI
    RelatedPerson.relationshippreferredPattern: SPS
    http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype
    from the FHIR Standard
    RelatedPerson.name.userequiredNameUse
    http://hl7.org/fhir/ValueSet/name-use|4.0.1
    from the FHIR Standard
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. RelatedPerson C 0..* USCoreRelatedPersonProfile A person that is related to a patient, but who is not a direct target of care
    us-core-14: Either a name or a relationship SHALL be provided (or both)
    ... id Σ 0..1 id Logical id of this artifact
    ... meta Σ 0..1 Meta Metadata about the resource
    ... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
    ... text 0..1 Narrative Text summary of the resource, for human interpretation
    ... contained 0..* Resource Contained, inline Resources
    ... extension 0..* Extension Additional content defined by implementations
    ... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
    ... identifier Σ 0..* Identifier A human identifier for this person
    ... active ?!SΣ 1..1 boolean Whether this related person's record is in active use
    Required Pattern: true
    ... patient SΣ 1..1 Reference(Patient - Vital Records) Decedent
    ... relationship SΣC 1..1 CodeableConcept relationship
    Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.



    Required Pattern: At least the following
    .... id 0..1 string Unique id for inter-element referencing
    .... extension 0..* Extension Additional content defined by implementations
    .... coding 1..* Coding Code defined by a terminology system
    Fixed Value: (complex)
    ..... id 0..1 string Unique id for inter-element referencing
    ..... extension 0..* Extension Additional content defined by implementations
    ..... system 1..1 uri Identity of the terminology system
    Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode
    ..... version 0..1 string Version of the system - if relevant
    ..... code 1..1 code Symbol in syntax defined by the system
    Fixed Value: SPS
    ..... display 0..1 string Representation defined by the system
    ..... userSelected 0..1 boolean If this coding was chosen directly by the user
    .... text 0..1 string Plain text representation of the concept
    .... id 0..1 string Unique id for inter-element referencing
    .... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... coding Σ 0..* Coding Code defined by a terminology system
    .... text Σ 0..1 string Plain text representation of the concept
    Required Pattern: Spouse
    ... name SΣC 0..* HumanName A name associated with the person
    .... id 0..1 string Unique id for inter-element referencing
    .... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
    Binding: NameUse (required): The use of a human name.

    .... text Σ 0..1 string Text representation of the full name
    .... family Σ 0..1 string Maiden name if name.use=maiden
    .... given Σ 0..* string Given names (not always 'first'). Includes middle names
    This repeating element order: Given Names appear in the correct order for presenting the name
    .... prefix Σ 0..* string Parts that come before the name
    This repeating element order: Prefixes appear in the correct order for presenting the name
    .... suffix Σ 0..* string Parts that come after the name
    This repeating element order: Suffixes appear in the correct order for presenting the name
    .... period Σ 0..1 Period Time period when name was/is in use
    ... telecom SΣ 0..* ContactPoint A contact detail for the person
    ... gender Σ 0..1 code male | female | other | unknown
    Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

    ... birthDate Σ 0..1 date The date on which the related person was born
    ... address SΣ 0..* Address Address where the related person can be contacted or visited
    ... photo 0..* Attachment Image of the person
    ... period 0..1 Period Period of time that this relationship is considered valid
    ... communication 0..* BackboneElement A language which may be used to communicate with about the patient's health
    .... id 0..1 string Unique id for inter-element referencing
    .... extension 0..* Extension Additional content defined by implementations
    .... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    .... language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
    Binding: CommonLanguages (preferred): A human language.

    Additional BindingsPurpose
    AllLanguages Max Binding
    .... preferred 0..1 boolean Language preference indicator

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSet / CodeURI
    RelatedPerson.languagepreferredCommonLanguages
    Additional Bindings Purpose
    AllLanguages Max Binding
    http://hl7.org/fhir/ValueSet/languages
    from the FHIR Standard
    RelatedPerson.relationshippreferredPattern: SPS
    http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype
    from the FHIR Standard
    RelatedPerson.name.userequiredNameUse
    http://hl7.org/fhir/ValueSet/name-use|4.0.1
    from the FHIR Standard
    RelatedPerson.genderrequiredAdministrativeGender
    http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
    from the FHIR Standard
    RelatedPerson.communication.languagepreferredCommonLanguages
    Additional Bindings Purpose
    AllLanguages Max Binding
    http://hl7.org/fhir/ValueSet/languages
    from the FHIR Standard

    This structure is derived from USCoreRelatedPersonProfile

    Summary

    Mandatory: 1 element

    Structures

    This structure refers to these other structures:

    Differential View

    This structure is derived from USCoreRelatedPersonProfile

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. RelatedPerson USCoreRelatedPersonProfile
    ... active 1..1 boolean Whether this related person's record is in active use
    Required Pattern: true
    ... patient 1..1 Reference(Patient - Vital Records) Decedent
    ... relationship 1..1 CodeableConcept relationship
    Required Pattern: At least the following
    .... coding 1..* Coding Code defined by a terminology system
    Fixed Value: (complex)
    ..... system 1..1 uri Identity of the terminology system
    Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode
    ..... code 1..1 code Symbol in syntax defined by the system
    Fixed Value: SPS
    .... text 0..1 string Plain text representation of the concept
    Required Pattern: Spouse
    .... family 0..1 string Maiden name if name.use=maiden

    doco Documentation for this format

    Key Elements View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. RelatedPerson C 0..* USCoreRelatedPersonProfile A person that is related to a patient, but who is not a direct target of care
    us-core-14: Either a name or a relationship SHALL be provided (or both)
    ... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
    ... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
    ... active ?!SΣ 1..1 boolean Whether this related person's record is in active use
    Required Pattern: true
    ... relationship SΣC 1..1 CodeableConcept relationship
    Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.



    Required Pattern: At least the following
    .... coding 1..* Coding Code defined by a terminology system
    Fixed Value: (complex)
    ..... system 1..1 uri Identity of the terminology system
    Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode
    ..... code 1..1 code Symbol in syntax defined by the system
    Fixed Value: SPS
    .... text Σ 0..1 string Plain text representation of the concept
    Required Pattern: Spouse
    ... name SΣC 0..* HumanName A name associated with the person
    .... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
    Binding: NameUse (required): The use of a human name.

    .... family Σ 0..1 string Maiden name if name.use=maiden
    ... telecom SΣ 0..* ContactPoint A contact detail for the person
    ... address SΣ 0..* Address Address where the related person can be contacted or visited

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSet / CodeURI
    RelatedPerson.relationshippreferredPattern: SPS
    http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype
    from the FHIR Standard
    RelatedPerson.name.userequiredNameUse
    http://hl7.org/fhir/ValueSet/name-use|4.0.1
    from the FHIR Standard

    Snapshot View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. RelatedPerson C 0..* USCoreRelatedPersonProfile A person that is related to a patient, but who is not a direct target of care
    us-core-14: Either a name or a relationship SHALL be provided (or both)
    ... id Σ 0..1 id Logical id of this artifact
    ... meta Σ 0..1 Meta Metadata about the resource
    ... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
    ... text 0..1 Narrative Text summary of the resource, for human interpretation
    ... contained 0..* Resource Contained, inline Resources
    ... extension 0..* Extension Additional content defined by implementations
    ... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
    ... identifier Σ 0..* Identifier A human identifier for this person
    ... active ?!SΣ 1..1 boolean Whether this related person's record is in active use
    Required Pattern: true
    ... patient SΣ 1..1 Reference(Patient - Vital Records) Decedent
    ... relationship SΣC 1..1 CodeableConcept relationship
    Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.



    Required Pattern: At least the following
    .... id 0..1 string Unique id for inter-element referencing
    .... extension 0..* Extension Additional content defined by implementations
    .... coding 1..* Coding Code defined by a terminology system
    Fixed Value: (complex)
    ..... id 0..1 string Unique id for inter-element referencing
    ..... extension 0..* Extension Additional content defined by implementations
    ..... system 1..1 uri Identity of the terminology system
    Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode
    ..... version 0..1 string Version of the system - if relevant
    ..... code 1..1 code Symbol in syntax defined by the system
    Fixed Value: SPS
    ..... display 0..1 string Representation defined by the system
    ..... userSelected 0..1 boolean If this coding was chosen directly by the user
    .... text 0..1 string Plain text representation of the concept
    .... id 0..1 string Unique id for inter-element referencing
    .... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... coding Σ 0..* Coding Code defined by a terminology system
    .... text Σ 0..1 string Plain text representation of the concept
    Required Pattern: Spouse
    ... name SΣC 0..* HumanName A name associated with the person
    .... id 0..1 string Unique id for inter-element referencing
    .... extension 0..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... use ?!Σ 0..1 code usual | official | temp | nickname | anonymous | old | maiden
    Binding: NameUse (required): The use of a human name.

    .... text Σ 0..1 string Text representation of the full name
    .... family Σ 0..1 string Maiden name if name.use=maiden
    .... given Σ 0..* string Given names (not always 'first'). Includes middle names
    This repeating element order: Given Names appear in the correct order for presenting the name
    .... prefix Σ 0..* string Parts that come before the name
    This repeating element order: Prefixes appear in the correct order for presenting the name
    .... suffix Σ 0..* string Parts that come after the name
    This repeating element order: Suffixes appear in the correct order for presenting the name
    .... period Σ 0..1 Period Time period when name was/is in use
    ... telecom SΣ 0..* ContactPoint A contact detail for the person
    ... gender Σ 0..1 code male | female | other | unknown
    Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

    ... birthDate Σ 0..1 date The date on which the related person was born
    ... address SΣ 0..* Address Address where the related person can be contacted or visited
    ... photo 0..* Attachment Image of the person
    ... period 0..1 Period Period of time that this relationship is considered valid
    ... communication 0..* BackboneElement A language which may be used to communicate with about the patient's health
    .... id 0..1 string Unique id for inter-element referencing
    .... extension 0..* Extension Additional content defined by implementations
    .... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
    .... language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
    Binding: CommonLanguages (preferred): A human language.

    Additional BindingsPurpose
    AllLanguages Max Binding
    .... preferred 0..1 boolean Language preference indicator

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSet / CodeURI
    RelatedPerson.languagepreferredCommonLanguages
    Additional Bindings Purpose
    AllLanguages Max Binding
    http://hl7.org/fhir/ValueSet/languages
    from the FHIR Standard
    RelatedPerson.relationshippreferredPattern: SPS
    http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype
    from the FHIR Standard
    RelatedPerson.name.userequiredNameUse
    http://hl7.org/fhir/ValueSet/name-use|4.0.1
    from the FHIR Standard
    RelatedPerson.genderrequiredAdministrativeGender
    http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
    from the FHIR Standard
    RelatedPerson.communication.languagepreferredCommonLanguages
    Additional Bindings Purpose
    AllLanguages Max Binding
    http://hl7.org/fhir/ValueSet/languages
    from the FHIR Standard

    This structure is derived from USCoreRelatedPersonProfile

    Summary

    Mandatory: 1 element

    Structures

    This structure refers to these other structures:

     

    Other representations of profile: CSV, Excel, Schematron