Release 5 Draft Ballot

This page is part of the FHIR Specification (v4.6.0: R5 Draft Ballot). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R4B R4 R3

Extension: partner-name

FHIR Infrastructure Work Group

Maturity Level: 1

Informative

Use Context: Any

URL for this extension:

http://hl7.org/fhir/StructureDefinition/humanname-partner-name

Status: draft. Extension maintained by: Health Level Seven, Inc. - FHIR Core WG

The portion of the family name that is derived from the person's partner's surname, as distinguished from any portion that is derived from the surname of the person's own name.

Comment:

If the person's surname has legally changed to become (or incorporate) the surname of the person's partner or spouse, this is the person's surname immediately prior to such change. Often this is the person's "maiden name".

Context of Use: Use on Element ID HumanName.family

Summary

Name	Flags	Card.	Type	Description & Constraints
partner-name		0..1	string	URL = http://hl7.org/fhir/StructureDefinition/humanname-partner-name partner-name: The portion of the family name that is derived from the person's partner's surname, as distinguished from any portion that is derived from the surname of the person's own name. Use on Element ID HumanName.family
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/humanname-partner-name partner-name: The portion of the family name that is derived from the person's partner's surname, as distinguished from any portion that is derived from the surname of the person's own name. Use on Element ID HumanName.family
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/humanname-partner-name"
value[x]	1..1	string	Value of extension
Documentation for this format

XML Template

<!-- partner-name -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/humanname-partner-name" >
  <!-- from Element: extension -->
 <valueString value="[string]"/><!--  1..1 Value of extension -->
</extension>

JSON Template

{ // partner-name
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/humanname-partner-name", // R! 
    "valueString" : "<string>" // C? R! Value of extension
  }

Summary

Name	Flags	Card.	Type	Description & Constraints
partner-name		0..1	string	URL = http://hl7.org/fhir/StructureDefinition/humanname-partner-name partner-name: The portion of the family name that is derived from the person's partner's surname, as distinguished from any portion that is derived from the surname of the person's own name. Use on Element ID HumanName.family
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/humanname-partner-name partner-name: The portion of the family name that is derived from the person's partner's surname, as distinguished from any portion that is derived from the surname of the person's own name. Use on Element ID HumanName.family
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/humanname-partner-name"
value[x]	1..1	string	Value of extension
Documentation for this format

XML Template

<!-- partner-name -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/humanname-partner-name" >
  <!-- from Element: extension -->
 <valueString value="[string]"/><!--  1..1 Value of extension -->
</extension>

JSON Template

{ // partner-name
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
    "url" : "http://hl7.org/fhir/StructureDefinition/humanname-partner-name", // R! 
    "valueString" : "<string>" // C? R! Value of extension
  }

Constraints

ele-1: All FHIR elements must have a @value or children (xpath: @value|f:*|h:div)
ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]))
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: @value|f:*|h:div)