Release 5 Ballot
AdministrationThis page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - see ballot notes). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
| Patient Administration Work Group | Maturity Level: 1 | Informative | Use Context: Any |
Summary
| Defining URL: | http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender |
| Version: | 5.0.0-ballot |
| Name: | recordedSexOrGender |
| Title: | recordedSexOrGender |
| Modifier: | This extension is not a modifier extension |
| Status: | draft |
| Definition: | The recorded sex and gender is to be used to differentiate existing sex or gender data. This element is used for existing 'sex' or 'gender' elements in a document or record when the intent and meaning is unclear. For example, the individual's birth certificate information, passport information, and national identity document information may all be present. This is necessary because an individual's documents may be updated at different rates or for different reasons. Sex assigned at birth (SAAB), while very common and considered essential in some jurisdictions, is considered a recorded sex and gender entry. |
| Committee: | Patient Administration Work Group |
Status: draft. Extension maintained by: HL7
The recorded sex and gender is to be used to differentiate existing sex or gender data. This element is used for existing 'sex' or 'gender' elements in a document or record when the intent and meaning is unclear. For example, the individual's birth certificate information, passport information, and national identity document information may all be present. This is necessary because an individual's documents may be updated at different rates or for different reasons. Sex assigned at birth (SAAB), while very common and considered essential in some jurisdictions, is considered a recorded sex and gender entry.
Context of Use: Use on Element ID Patient, Element ID RelatedPerson, Element ID Person or Element ID Practitioner
Summary
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  recordedSexOrGender | 0..* | Extension | URL = http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender recordedSexOrGender: The recorded sex and gender is to be used to differentiate existing sex or gender data. This element is used for existing 'sex' or 'gender' elements in a document or record when the intent and meaning is unclear. For example, the individual's birth certificate information, passport information, and national identity document information may all be present. This is necessary because an individual's documents may be updated at different rates or for different reasons. Sex assigned at birth (SAAB), while very common and considered essential in some jurisdictions, is considered a recorded sex and gender entry. Use on Element ID Patient, Element ID RelatedPerson, Element ID Person or Element ID Practitioner | |
  value | 1..1 | CodeableConcept | The recorded sex or gender property for the individual Binding: AdministrativeGender (example) | |
| internationalEquivalent | 0..1 | CodeableConcept | An international representation of the value found on the document Binding: International Civil Aviation Organization Sex Or Gender (extensible) | |
| type | 0..1 | CodeableConcept | Type of recorded sex or gender. Binding: Recorded Sex Or Gender Type (preferred) | |
| effectivePeriod | 0..1 | Period | When the recorded sex or gender value applies | |
| acquisitionDate | 0..1 | dateTime | When the sex or gender value was recorded. | |
| sourceDocument | 0..1 | CodeableReference(DocumentReference) | The document the sex or gender property was acquired from. | |
| sourceField | 0..1 | string | The name of the field within the source document where this sex or gender property is initially recorded. | |
| jurisdiction | 0..1 | CodeableConcept | Who issued the document where the sex or gender was aquired Binding: Jurisdiction (extensible) | |
 comment | 0..1 | string | Context or source information about the recorded sex or gender | |
| Documentation for this format | ||||
Full Structure
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| extension | 0..* | Extension | URL = http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender recordedSexOrGender: The recorded sex and gender is to be used to differentiate existing sex or gender data. This element is used for existing 'sex' or 'gender' elements in a document or record when the intent and meaning is unclear. For example, the individual's birth certificate information, passport information, and national identity document information may all be present. This is necessary because an individual's documents may be updated at different rates or for different reasons. Sex assigned at birth (SAAB), while very common and considered essential in some jurisdictions, is considered a recorded sex and gender entry. 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 recorded sex or gender property for the individual | |
   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: AdministrativeGender (example) | |
| extension:internationalEquivalent | 0..1 | Extension | An international representation of the value found on the document | |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..0 | |||
| url | 1..1 | uri | "internationalEquivalent" | |
| value[x] | 1..1 | CodeableConcept | Value of extension Binding: International Civil Aviation Organization Sex Or Gender (extensible) | |
| extension:type | 0..1 | Extension | Type of recorded sex or gender. | |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..0 | |||
| url | 1..1 | uri | "type" | |
| value[x] | 1..1 | CodeableConcept | Value of extension Binding: Recorded Sex Or Gender Type (preferred) | |
| extension:effectivePeriod | 0..1 | Extension | When the recorded sex or gender value applies | |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..0 | |||
| url | 1..1 | uri | "effectivePeriod" | |
| value[x] | 0..1 | Period | Value of extension | |
| extension:acquisitionDate | 0..1 | Extension | When the sex or gender value was recorded. | |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..0 | |||
| url | 1..1 | uri | "acquisitionDate" | |
| value[x] | 1..1 | dateTime | Value of extension | |
| extension:sourceDocument | 0..1 | Extension | The document the sex or gender property was acquired from. | |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..0 | |||
| url | 1..1 | uri | "sourceDocument" | |
 value[x] | 1..1 | CodeableReference(DocumentReference) | Value of extension | |
| extension:sourceField | 0..1 | Extension | The name of the field within the source document where this sex or gender property is initially recorded. | |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..0 | |||
| url | 1..1 | uri | "sourceField" | |
| value[x] | 1..1 | string | Value of extension | |
| extension:jurisdiction | 0..1 | Extension | Who issued the document where the sex or gender was aquired | |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..0 | |||
| url | 1..1 | uri | "jurisdiction" | |
| value[x] | 1..1 | CodeableConcept | Value of extension Binding: Jurisdiction (extensible) | |
| extension:comment | 0..1 | Extension | Context or source information about the recorded sex or gender | |
| 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-recordedSexOrGender" | |
 value[x] | 0..0 | |||
| Documentation for this format | ||||
XML Template
<!-- recordedSexOrGender --><extension xmlns="http://hl7.org/fhir" url="http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender" > <-- extension sliced by value:url in the specified orderOpen--> <extension url="value"> I 1..1 Extension <!-- I 1..1 The recorded sex or gender property for the individual --> <valueCodeableConcept><!-- I 1..1 CodeableConcept Value of extension --></valueCodeableConcept> </extension> <extension url="internationalEquivalent"> I 0..1 Extension <!-- I 0..1 An international representation of the value found on the document --> <valueCodeableConcept><!-- I 1..1 CodeableConcept Value of extension --></valueCodeableConcept> </extension> <extension url="type"> I 0..1 Extension <!-- I 0..1 Type of recorded sex or gender. --> <valueCodeableConcept><!-- I 1..1 CodeableConcept Value of extension --></valueCodeableConcept> </extension> <extension url="effectivePeriod"> I 0..1 Extension <!-- I 0..1 When the recorded sex or gender value applies --> <valuePeriod><!-- I 0..1 Period Value of extension --></valuePeriod> </extension> <extension url="acquisitionDate"> I 0..1 Extension <!-- I 0..1 When the sex or gender value was recorded. --> <valueDateTime value="[dateTime]"/><!-- I 1..1 Value of extension --> </extension> <extension url="sourceDocument"> I 0..1 Extension <!-- I 0..1 The document the sex or gender property was acquired from. --> <valueCodeableReference><!-- I 1..1 CodeableReference Value of extension --></valueCodeableReference> </extension> <extension url="sourceField"> I 0..1 Extension <!-- I 0..1 The name of the field within the source document where this sex or gender property is initially recorded. --> <valueString value="[string]"/><!-- I 1..1 Value of extension --> </extension> <extension url="jurisdiction"> I 0..1 Extension <!-- I 0..1 Who issued the document where the sex or gender was aquired --> <valueCodeableConcept><!-- I 1..1 CodeableConcept Value of extension --></valueCodeableConcept> </extension> <extension url="comment"> I 0..1 Extension <!-- I 0..1 Context or source information about the recorded sex or gender --> <valueString value="[string]"/><!-- I 1..1 Value of extension --> </extension> </extension>
JSON Template
{ // recordedSexOrGender
"extension" : [ // sliced by value:url in the specified order, Open
{ // The recorded sex or gender property for the individual // 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
},
{ // An international representation of the value found on the document // I
// from Element: extension
"extension" : [ // sliced by value:url in the specified order, Open ]
"url" : "internationalEquivalent", // R!
"valueCodeableConcept" : { CodeableConcept } // I R! Value of extension
},
{ // Type of recorded sex or gender. // I
// from Element: extension
"extension" : [ // sliced by value:url in the specified order, Open ]
"url" : "type", // R!
"valueCodeableConcept" : { CodeableConcept } // I R! Value of extension
},
{ // When the recorded sex or gender value applies // I
// from Element: extension
"extension" : [ // sliced by value:url in the specified order, Open ]
"url" : "effectivePeriod", // R!
"valuePeriod" : { Period } // IValue of extension
},
{ // When the sex or gender value was recorded. // I
// from Element: extension
"extension" : [ // sliced by value:url in the specified order, Open ]
"url" : "acquisitionDate", // R!
"valueDateTime" : "<dateTime>" // I R! Value of extension
},
{ // The document the sex or gender property was acquired from. // I
// from Element: extension
"extension" : [ // sliced by value:url in the specified order, Open ]
"url" : "sourceDocument", // R!
"valueCodeableReference" : { CodeableReference(DocumentReference) } // I R! Value of extension
},
{ // The name of the field within the source document where this sex or gender property is initially recorded. // I
// from Element: extension
"extension" : [ // sliced by value:url in the specified order, Open ]
"url" : "sourceField", // R!
"valueString" : "<string>" // I R! Value of extension
},
{ // Who issued the document where the sex or gender was aquired // I
// from Element: extension
"extension" : [ // sliced by value:url in the specified order, Open ]
"url" : "jurisdiction", // R!
"valueCodeableConcept" : { CodeableConcept } // I R! Value of extension
},
{ // Context or source information about the recorded sex or gender // 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 recorded sex or gender property for the individual
"extension" : { Extension }, // IAn international representation of the value found on the document
"extension" : { Extension }, // IType of recorded sex or gender.
"extension" : { Extension }, // IWhen the recorded sex or gender value applies
"extension" : { Extension }, // IWhen the sex or gender value was recorded.
"extension" : { Extension }, // IThe document the sex or gender property was acquired from.
"extension" : { Extension }, // IThe name of the field within the source document where this sex or gender property is initially recorded.
"extension" : { Extension }, // IWho issued the document where the sex or gender was aquired
"extension" : { Extension }, // IContext or source information about the recorded sex or gender
"url" : "http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender" // R!
// value[x]: Value of extension: Prohibited
}
Summary
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| recordedSexOrGender | 0..* | Extension | URL = http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender recordedSexOrGender: The recorded sex and gender is to be used to differentiate existing sex or gender data. This element is used for existing 'sex' or 'gender' elements in a document or record when the intent and meaning is unclear. For example, the individual's birth certificate information, passport information, and national identity document information may all be present. This is necessary because an individual's documents may be updated at different rates or for different reasons. Sex assigned at birth (SAAB), while very common and considered essential in some jurisdictions, is considered a recorded sex and gender entry. Use on Element ID Patient, Element ID RelatedPerson, Element ID Person or Element ID Practitioner | |
| value | 1..1 | CodeableConcept | The recorded sex or gender property for the individual Binding: AdministrativeGender (example) | |
| internationalEquivalent | 0..1 | CodeableConcept | An international representation of the value found on the document Binding: International Civil Aviation Organization Sex Or Gender (extensible) | |
| type | 0..1 | CodeableConcept | Type of recorded sex or gender. Binding: Recorded Sex Or Gender Type (preferred) | |
| effectivePeriod | 0..1 | Period | When the recorded sex or gender value applies | |
| acquisitionDate | 0..1 | dateTime | When the sex or gender value was recorded. | |
| sourceDocument | 0..1 | CodeableReference(DocumentReference) | The document the sex or gender property was acquired from. | |
| sourceField | 0..1 | string | The name of the field within the source document where this sex or gender property is initially recorded. | |
| jurisdiction | 0..1 | CodeableConcept | Who issued the document where the sex or gender was aquired Binding: Jurisdiction (extensible) | |
| comment | 0..1 | string | Context or source information about the recorded sex or gender | |
| Documentation for this format | ||||
Full Structure
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| extension | 0..* | Extension | URL = http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender recordedSexOrGender: The recorded sex and gender is to be used to differentiate existing sex or gender data. This element is used for existing 'sex' or 'gender' elements in a document or record when the intent and meaning is unclear. For example, the individual's birth certificate information, passport information, and national identity document information may all be present. This is necessary because an individual's documents may be updated at different rates or for different reasons. Sex assigned at birth (SAAB), while very common and considered essential in some jurisdictions, is considered a recorded sex and gender entry. 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 recorded sex or gender property for the individual | |
| 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: AdministrativeGender (example) | |
| extension:internationalEquivalent | 0..1 | Extension | An international representation of the value found on the document | |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..0 | |||
| url | 1..1 | uri | "internationalEquivalent" | |
| value[x] | 1..1 | CodeableConcept | Value of extension Binding: International Civil Aviation Organization Sex Or Gender (extensible) | |
| extension:type | 0..1 | Extension | Type of recorded sex or gender. | |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..0 | |||
| url | 1..1 | uri | "type" | |
| value[x] | 1..1 | CodeableConcept | Value of extension Binding: Recorded Sex Or Gender Type (preferred) | |
| extension:effectivePeriod | 0..1 | Extension | When the recorded sex or gender value applies | |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..0 | |||
| url | 1..1 | uri | "effectivePeriod" | |
| value[x] | 0..1 | Period | Value of extension | |
| extension:acquisitionDate | 0..1 | Extension | When the sex or gender value was recorded. | |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..0 | |||
| url | 1..1 | uri | "acquisitionDate" | |
| value[x] | 1..1 | dateTime | Value of extension | |
| extension:sourceDocument | 0..1 | Extension | The document the sex or gender property was acquired from. | |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..0 | |||
| url | 1..1 | uri | "sourceDocument" | |
| value[x] | 1..1 | CodeableReference(DocumentReference) | Value of extension | |
| extension:sourceField | 0..1 | Extension | The name of the field within the source document where this sex or gender property is initially recorded. | |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..0 | |||
| url | 1..1 | uri | "sourceField" | |
| value[x] | 1..1 | string | Value of extension | |
| extension:jurisdiction | 0..1 | Extension | Who issued the document where the sex or gender was aquired | |
| id | 0..1 | id | Unique id for inter-element referencing | |
| extension | 0..0 | |||
| url | 1..1 | uri | "jurisdiction" | |
| value[x] | 1..1 | CodeableConcept | Value of extension Binding: Jurisdiction (extensible) | |
| extension:comment | 0..1 | Extension | Context or source information about the recorded sex or gender | |
| 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-recordedSexOrGender" | |
| value[x] | 0..0 | |||
| Documentation for this format | ||||
XML Template
<!-- recordedSexOrGender -->
JSON Template
{ // recordedSexOrGender
"extension" : [ // sliced by value:url in the specified order, Open
{ // The recorded sex or gender property for the individual // 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
},
{ // An international representation of the value found on the document // I
// from Element: extension
"extension" : [ // sliced by value:url in the specified order, Open ]
"url" : "internationalEquivalent", // R!
"valueCodeableConcept" : { CodeableConcept } // I R! Value of extension
},
{ // Type of recorded sex or gender. // I
// from Element: extension
"extension" : [ // sliced by value:url in the specified order, Open ]
"url" : "type", // R!
"valueCodeableConcept" : { CodeableConcept } // I R! Value of extension
},
{ // When the recorded sex or gender value applies // I
// from Element: extension
"extension" : [ // sliced by value:url in the specified order, Open ]
"url" : "effectivePeriod", // R!
"valuePeriod" : { Period } // IValue of extension
},
{ // When the sex or gender value was recorded. // I
// from Element: extension
"extension" : [ // sliced by value:url in the specified order, Open ]
"url" : "acquisitionDate", // R!
"valueDateTime" : "<dateTime>" // I R! Value of extension
},
{ // The document the sex or gender property was acquired from. // I
// from Element: extension
"extension" : [ // sliced by value:url in the specified order, Open ]
"url" : "sourceDocument", // R!
"valueCodeableReference" : { CodeableReference(DocumentReference) } // I R! Value of extension
},
{ // The name of the field within the source document where this sex or gender property is initially recorded. // I
// from Element: extension
"extension" : [ // sliced by value:url in the specified order, Open ]
"url" : "sourceField", // R!
"valueString" : "<string>" // I R! Value of extension
},
{ // Who issued the document where the sex or gender was aquired // I
// from Element: extension
"extension" : [ // sliced by value:url in the specified order, Open ]
"url" : "jurisdiction", // R!
"valueCodeableConcept" : { CodeableConcept } // I R! Value of extension
},
{ // Context or source information about the recorded sex or gender // 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 recorded sex or gender property for the individual
"extension" : { Extension }, // IAn international representation of the value found on the document
"extension" : { Extension }, // IType of recorded sex or gender.
"extension" : { Extension }, // IWhen the recorded sex or gender value applies
"extension" : { Extension }, // IWhen the sex or gender value was recorded.
"extension" : { Extension }, // IThe document the sex or gender property was acquired from.
"extension" : { Extension }, // IThe name of the field within the source document where this sex or gender property is initially recorded.
"extension" : { Extension }, // IWho issued the document where the sex or gender was aquired
"extension" : { Extension }, // IContext or source information about the recorded sex or gender
"url" : "http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender" // R!
// value[x]: Value of extension: Prohibited
}
Constraints
Search
| No Search Extensions defined for this resource |
Examples of this extension
FHIR ®© HL7.org 2011+. FHIR R5 Ballot hl7.fhir.core#5.0.0-ballot generated on Sat, Sep 10, 2022 04:58+1000.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R4B |
Compare to R5 Draft |
|
Propose a change