Extension: Individual Pronouns

Patient Administration Work Group

Maturity Level: 1

Trial Use

Use Context: Any

Official URL: `http://hl7.org/fhir/StructureDefinition/individual-pronouns`				Version: 5.0.0-snapshot3
draft as of 2020-12-28				Computable Name: PPronouns
Flags: Non-Modifier				OID: 2.16.840.1.113883.4.642.5.1335

Context of Use: Use on Element ID Patient, Element ID RelatedPerson, Element ID Person or Element ID Practitioner

Definition

The pronouns to use when referring to an individual in verbal or written communication.

Summary

Name	Card.	Type	Description & Constraints
PPronouns	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/individual-pronouns PPronouns: The pronouns to use when referring to an individual in verbal or written communication. Use on Element ID Patient, Element ID RelatedPerson, Element ID Person or Element ID Practitioner
value	1..1	CodeableConcept	The individual's pronouns Binding: Personal Pronouns (example)
period	0..1	Period	When the pronouns apply to the individual
comment	0..1	string	Explaination about the use of the pronouns
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/individual-pronouns PPronouns: The pronouns to use when referring to an individual in verbal or written communication. Use on Element ID Patient, Element ID RelatedPerson, Element ID Person or Element ID Practitioner
Slices for extension	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:value	1..1	Extension	The individual's pronouns
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"value"
value[x]	1..1	CodeableConcept	Value of extension Binding: Personal Pronouns (example)
extension:period	0..1	Extension	When the pronouns apply to the individual
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"period"
value[x]	1..1	Period	Value of extension
extension:comment	0..1	Extension	Explaination about the use of the pronouns
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"comment"
value[x]	1..1	string	Value of extension
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/individual-pronouns"
value[x]	0..0
Documentation for this format

XML Template

<!-- PPronouns -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/individual-pronouns" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="value"> I 1..1 Extension  <!-- I 1..1 The individual's pronouns -->
  <valueCodeableConcept><!-- I 1..1 CodeableConcept Value of extension --></valueCodeableConcept>
 </extension>
 <extension url="period"> I 0..1 Extension  <!-- I 0..1 When the pronouns apply to the individual -->
  <valuePeriod><!-- I 1..1 Period Value of extension --></valuePeriod>
 </extension>
 <extension url="comment"> I 0..1 Extension  <!-- I 0..1 Explaination about the use of the pronouns -->
  <valueString value="[string]"/><!-- I 1..1 Value of extension -->
 </extension>
</extension>

JSON Template

{ // PPronouns
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // The individual's pronouns // I R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "value", // R! 
        "valueCodeableConcept" : { CodeableConcept } // I R! Value of extension
      },
      { // When the pronouns apply to the individual // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "period", // R! 
        "valuePeriod" : { Period } // I R! Value of extension
      },
      { // Explaination about the use of the pronouns // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "comment", // R! 
        "valueString" : "<string>" // I R! Value of extension
      }
    ],
    "extension" : [{ Extension }], // IAdditional content defined by implementations
    "extension" : { Extension }, // I R! The individual's pronouns
    "extension" : { Extension }, // IWhen the pronouns apply to the individual
    "extension" : { Extension }, // IExplaination about the use of the pronouns
    "url" : "http://hl7.org/fhir/StructureDefinition/individual-pronouns" // R! 
  // value[x]: Value of extension: Prohibited
  }

Summary

Name	Card.	Type	Description & Constraints
PPronouns	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/individual-pronouns PPronouns: The pronouns to use when referring to an individual in verbal or written communication. Use on Element ID Patient, Element ID RelatedPerson, Element ID Person or Element ID Practitioner
value	1..1	CodeableConcept	The individual's pronouns Binding: Personal Pronouns (example)
period	0..1	Period	When the pronouns apply to the individual
comment	0..1	string	Explaination about the use of the pronouns
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/individual-pronouns PPronouns: The pronouns to use when referring to an individual in verbal or written communication. Use on Element ID Patient, Element ID RelatedPerson, Element ID Person or Element ID Practitioner
Slices for extension	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:value	1..1	Extension	The individual's pronouns
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"value"
value[x]	1..1	CodeableConcept	Value of extension Binding: Personal Pronouns (example)
extension:period	0..1	Extension	When the pronouns apply to the individual
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"period"
value[x]	1..1	Period	Value of extension
extension:comment	0..1	Extension	Explaination about the use of the pronouns
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"comment"
value[x]	1..1	string	Value of extension
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/individual-pronouns"
value[x]	0..0
Documentation for this format

XML Template

<!-- PPronouns -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/individual-pronouns" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="value"> I 1..1 Extension  <!-- I 1..1 The individual's pronouns -->
  <valueCodeableConcept><!-- I 1..1 CodeableConcept Value of extension --></valueCodeableConcept>
 </extension>
 <extension url="period"> I 0..1 Extension  <!-- I 0..1 When the pronouns apply to the individual -->
  <valuePeriod><!-- I 1..1 Period Value of extension --></valuePeriod>
 </extension>
 <extension url="comment"> I 0..1 Extension  <!-- I 0..1 Explaination about the use of the pronouns -->
  <valueString value="[string]"/><!-- I 1..1 Value of extension -->
 </extension>
</extension>

JSON Template

{ // PPronouns
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // The individual's pronouns // I R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "value", // R! 
        "valueCodeableConcept" : { CodeableConcept } // I R! Value of extension
      },
      { // When the pronouns apply to the individual // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "period", // R! 
        "valuePeriod" : { Period } // I R! Value of extension
      },
      { // Explaination about the use of the pronouns // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "comment", // R! 
        "valueString" : "<string>" // I R! Value of extension
      }
    ],
    "extension" : [{ Extension }], // IAdditional content defined by implementations
    "extension" : { Extension }, // I R! The individual's pronouns
    "extension" : { Extension }, // IWhen the pronouns apply to the individual
    "extension" : { Extension }, // IExplaination about the use of the pronouns
    "url" : "http://hl7.org/fhir/StructureDefinition/individual-pronouns" // R! 
  // value[x]: Value of extension: Prohibited
  }

Constraints

ele-1: All FHIR elements must have a @value or children (xpath: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (xpath: extension.exists() != value.exists())
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: hasValue() or (children().count() > id.count()))
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: extension.exists() != value.exists())
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: hasValue() or (children().count() > id.count()))
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: extension.exists() != value.exists())
ele-1: On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: hasValue() or (children().count() > id.count()))
ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: extension.exists() != value.exists())
ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: hasValue() or (children().count() > id.count()))
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: hasValue() or (children().count() > id.count()))
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: extension.exists() != value.exists())
ele-1: On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: hasValue() or (children().count() > id.count()))
ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: extension.exists() != value.exists())
ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: hasValue() or (children().count() > id.count()))
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: hasValue() or (children().count() > id.count()))
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: extension.exists() != value.exists())
ele-1: On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: hasValue() or (children().count() > id.count()))
ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: extension.exists() != value.exists())
ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: hasValue() or (children().count() > id.count()))
ele-1: On Extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: hasValue() or (children().count() > id.count()))

Search

No Search Extensions defined for this resource

Examples of this extension

Transgender: Patient/patient-example-sex-and-gender