Vital Records Death Reporting (VRDR) FHIR Implementation Guide
2.1.0 - STU 2 United States of America flag

This page is part of the Vital Records Death Reporting FHIR Implementation Guide (v2.1.0: STU 2) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). 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: 2.1.0
Active as of 2023-03-24 Computable Name: DecedentSpouse

Decedent Spouse (USCoreRelatedPerson)

Usage

# Description IJE Name IJE only Field Type Value Set
144 Spouse’s First Name SPOUSEF x name.given string -
145 Husband’s Surname/Wife’s Maiden Last Name SPOUSEL x name.family, name.use = ‘maiden string -
197 Spouse’s Middle Name SPOUSEMIDNAME x name.given , name.use = official string -
198 Spouse’s Suffix SPOUSESUFFIX x name.suffix , name.use = official string -

Usage:

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 0..*USCoreRelatedPersonProfileA person that is related to a patient, but who is not a direct target of care
... active 1..1booleanWhether this related person's record is in active use
Required Pattern: true
... patient 1..1Reference(Decedent)Decedent
... relationship 1..1CodeableConceptrelationship
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: SPS
.... text 0..1stringPlain text representation of the concept
Required Pattern: Spouse
.... family 0..1stringMaiden name if name.use=maiden

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson C0..*USCoreRelatedPersonProfileA person that is related to a patient, but who is not a direct target of care
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... active ?!SΣ1..1booleanWhether this related person's record is in active use
Required Pattern: true
... relationship SΣC1..1CodeableConceptrelationship
Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.



Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: SPS
.... text Σ0..1stringPlain text representation of the concept
Required Pattern: Spouse
... name SΣC0..*HumanNameA name associated with the person
.... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... family Σ0..1stringMaiden name if name.use=maiden
... telecom SΣ0..*ContactPointA contact detail for the person
... address SΣ0..*AddressAddress where the related person can be contacted or visited

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
RelatedPerson.relationshippreferredPattern: SPS
RelatedPerson.name.userequiredNameUse
NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson C0..*USCoreRelatedPersonProfileA person that is related to a patient, but who is not a direct target of care
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierA human identifier for this person
... active ?!SΣ1..1booleanWhether this related person's record is in active use
Required Pattern: true
... patient SΣ1..1Reference(Decedent)Decedent
... relationship SΣC1..1CodeableConceptrelationship
Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.



Required Pattern: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: SPS
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*CodingCode defined by a terminology system
.... text Σ0..1stringPlain text representation of the concept
Required Pattern: Spouse
... name SΣC0..*HumanNameA name associated with the person
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

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

... birthDate Σ0..1dateThe date on which the related person was born
... address SΣ0..*AddressAddress where the related person can be contacted or visited
... photo 0..*AttachmentImage of the person
... period 0..1PeriodPeriod of time that this relationship is considered valid
... communication 0..*BackboneElementA language which may be used to communicate with about the patient's health
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language 1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
.... preferred 0..1booleanLanguage preference indicator

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
RelatedPerson.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
RelatedPerson.relationshippreferredPattern: SPS
RelatedPerson.name.userequiredNameUse
RelatedPerson.genderrequiredAdministrativeGender
RelatedPerson.communication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding

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 0..*USCoreRelatedPersonProfileA person that is related to a patient, but who is not a direct target of care
... active 1..1booleanWhether this related person's record is in active use
Required Pattern: true
... patient 1..1Reference(Decedent)Decedent
... relationship 1..1CodeableConceptrelationship
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: SPS
.... text 0..1stringPlain text representation of the concept
Required Pattern: Spouse
.... family 0..1stringMaiden name if name.use=maiden

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson C0..*USCoreRelatedPersonProfileA person that is related to a patient, but who is not a direct target of care
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... active ?!SΣ1..1booleanWhether this related person's record is in active use
Required Pattern: true
... relationship SΣC1..1CodeableConceptrelationship
Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.



Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: SPS
.... text Σ0..1stringPlain text representation of the concept
Required Pattern: Spouse
... name SΣC0..*HumanNameA name associated with the person
.... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... family Σ0..1stringMaiden name if name.use=maiden
... telecom SΣ0..*ContactPointA contact detail for the person
... address SΣ0..*AddressAddress where the related person can be contacted or visited

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
RelatedPerson.relationshippreferredPattern: SPS
RelatedPerson.name.userequiredNameUse

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedPerson C0..*USCoreRelatedPersonProfileA person that is related to a patient, but who is not a direct target of care
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierA human identifier for this person
... active ?!SΣ1..1booleanWhether this related person's record is in active use
Required Pattern: true
... patient SΣ1..1Reference(Decedent)Decedent
... relationship SΣC1..1CodeableConceptrelationship
Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.



Required Pattern: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: SPS
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*CodingCode defined by a terminology system
.... text Σ0..1stringPlain text representation of the concept
Required Pattern: Spouse
... name SΣC0..*HumanNameA name associated with the person
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

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

... birthDate Σ0..1dateThe date on which the related person was born
... address SΣ0..*AddressAddress where the related person can be contacted or visited
... photo 0..*AttachmentImage of the person
... period 0..1PeriodPeriod of time that this relationship is considered valid
... communication 0..*BackboneElementA language which may be used to communicate with about the patient's health
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... language 1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
.... preferred 0..1booleanLanguage preference indicator

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
RelatedPerson.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
RelatedPerson.relationshippreferredPattern: SPS
RelatedPerson.name.userequiredNameUse
RelatedPerson.genderrequiredAdministrativeGender
RelatedPerson.communication.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding

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