AU Base Implementation Guide
4.1.2-preview - Preview
This page is part of the Australian Base IG (v4.1.2-preview: AU Base) based on FHIR R4. For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender | Version: 4.1.2-preview | |||
Standards status: Trial-use | Maturity Level: 2 | Computable Name: RecordedSexOrGender | ||
Other Identifiers: id: Uniform Resource Identifier (URI)#urn:oid:2.16.840.1.113883.4.642.5.1342 | ||||
Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved. |
Recorded sex or gender (RSG) information includes the various sex and gender concepts that are often used in existing systems but are known NOT to represent a gender identity, sex parameter for clinical use, or attributes related to sexuality, such as sexual orientation, sexual activity, or sexual attraction. Examples of recorded sex or gender concepts include administrative gender, administrative sex, and sex assigned at birth. When exchanging this concept, refer to the guidance in the Gender Harmony Implementation Guide.
This extension is published in this guide to pre-adopt an extension published in the R5 FHIR Extensions Pack. The only material difference is the data type for extension part sourceDocument (R5 CodeableReference to a choice between R4 CodeableConcept or Reference).
This extension may be used on the following element(s):
This R4 (4.0.1) conversion of the Person Recorded Sex Or Gender extension is not forwards compatible due to data types. The extension part sourceDocument, CodeableReference in R5, is represented in the R4 extension as a choice between CodeableConcept and Reference. Implementers are advised to take note that this content may be removed or changed and to take caution if using this extension.
Usage:
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Extension
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Extension | 0..* | Extension | A recorded sex or gender property for the individual | |
extension:value | 1..1 | Extension | The recorded sex or gender property for the individual | |
extension | 0..0 | |||
url | 1..1 | uri | "value" | |
value[x] | 1..1 | CodeableConcept | Value of extension Binding: AdministrativeGender (example) | |
extension:type | 0..1 | Extension | Type of recorded sex or gender. | |
extension | 0..0 | |||
url | 1..1 | uri | "type" | |
value[x] | 1..1 | CodeableConcept | Value of extension Binding: Recorded Sex Or Gender Type (example) | |
extension:effectivePeriod | 0..1 | Extension | When the recorded sex or gender value applies | |
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. | |
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. | |
extension | 0..0 | |||
url | 1..1 | uri | "sourceDocument" | |
Slices for value[x] | 1..1 | CodeableConcept, Reference() | Value of extension Slice: Unordered, Closed by type:$this | |
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension | |
value[x]:valueReference | 0..1 | Reference(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. | |
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 | |
extension | 0..0 | |||
url | 1..1 | uri | "jurisdiction" | |
value[x] | 1..1 | CodeableConcept | Value of extension Binding: Jurisdiction ValueSet (extensible) | |
extension:comment | 0..1 | Extension | Context or source information about the recorded sex or gender | |
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 |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Extension | 0..* | Extension | A recorded sex or gender property for the individual | |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 1..* | 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 | string | 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:type | 0..1 | Extension | Type of recorded sex or gender. | |
id | 0..1 | string | 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 (example) | |
extension:effectivePeriod | 0..1 | Extension | When the recorded sex or gender value applies | |
id | 0..1 | string | 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 | string | 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 | string | Unique id for inter-element referencing | |
extension | 0..0 | |||
url | 1..1 | uri | "sourceDocument" | |
Slices for value[x] | 1..1 | Value of extension Slice: Unordered, Closed by type:$this | ||
valueCodeableConcept | CodeableConcept | |||
valueReference | Reference(Any) | |||
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension | |
value[x]:valueReference | 0..1 | Reference(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 | string | 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 | string | Unique id for inter-element referencing | |
extension | 0..0 | |||
url | 1..1 | uri | "jurisdiction" | |
value[x] | 1..1 | CodeableConcept | Value of extension Binding: Jurisdiction ValueSet (extensible) | |
extension:comment | 0..1 | Extension | Context or source information about the recorded sex or gender | |
id | 0..1 | string | 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" | |
Documentation for this format |
This structure is derived from Extension
Summary
Complex Extension: Recorded sex or gender (RSG) information includes the various sex and gender concepts that are often used in existing systems but are known NOT to represent a gender identity, sex parameter for clinical use, or attributes related to sexuality, such as sexual orientation, sexual activity, or sexual attraction. Examples of recorded sex or gender concepts include administrative gender, administrative sex, and sex assigned at birth. When exchanging this concept, refer to the guidance in the Gender Harmony Implementation Guide. This extension is published in this guide to pre-adopt an extension published in the R5 FHIR Extensions Pack. The only material difference is the data type for extension part sourceDocument (R5 CodeableReference to a choice between R4 CodeableConcept or Reference).
Maturity: 2
Differential View
This structure is derived from Extension
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Extension | 0..* | Extension | A recorded sex or gender property for the individual | |
extension:value | 1..1 | Extension | The recorded sex or gender property for the individual | |
extension | 0..0 | |||
url | 1..1 | uri | "value" | |
value[x] | 1..1 | CodeableConcept | Value of extension Binding: AdministrativeGender (example) | |
extension:type | 0..1 | Extension | Type of recorded sex or gender. | |
extension | 0..0 | |||
url | 1..1 | uri | "type" | |
value[x] | 1..1 | CodeableConcept | Value of extension Binding: Recorded Sex Or Gender Type (example) | |
extension:effectivePeriod | 0..1 | Extension | When the recorded sex or gender value applies | |
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. | |
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. | |
extension | 0..0 | |||
url | 1..1 | uri | "sourceDocument" | |
Slices for value[x] | 1..1 | CodeableConcept, Reference() | Value of extension Slice: Unordered, Closed by type:$this | |
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension | |
value[x]:valueReference | 0..1 | Reference(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. | |
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 | |
extension | 0..0 | |||
url | 1..1 | uri | "jurisdiction" | |
value[x] | 1..1 | CodeableConcept | Value of extension Binding: Jurisdiction ValueSet (extensible) | |
extension:comment | 0..1 | Extension | Context or source information about the recorded sex or gender | |
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 |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Extension | 0..* | Extension | A recorded sex or gender property for the individual | |
id | 0..1 | string | Unique id for inter-element referencing | |
Slices for extension | 1..* | 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 | string | 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:type | 0..1 | Extension | Type of recorded sex or gender. | |
id | 0..1 | string | 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 (example) | |
extension:effectivePeriod | 0..1 | Extension | When the recorded sex or gender value applies | |
id | 0..1 | string | 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 | string | 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 | string | Unique id for inter-element referencing | |
extension | 0..0 | |||
url | 1..1 | uri | "sourceDocument" | |
Slices for value[x] | 1..1 | Value of extension Slice: Unordered, Closed by type:$this | ||
valueCodeableConcept | CodeableConcept | |||
valueReference | Reference(Any) | |||
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension | |
value[x]:valueReference | 0..1 | Reference(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 | string | 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 | string | Unique id for inter-element referencing | |
extension | 0..0 | |||
url | 1..1 | uri | "jurisdiction" | |
value[x] | 1..1 | CodeableConcept | Value of extension Binding: Jurisdiction ValueSet (extensible) | |
extension:comment | 0..1 | Extension | Context or source information about the recorded sex or gender | |
id | 0..1 | string | 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" | |
Documentation for this format |
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet |
Extension.extension:value.value[x] | example | AdministrativeGender |
Extension.extension:type.value[x] | example | RecordedSexOrGenderType |
Extension.extension:jurisdiction.value[x] | extensible | Jurisdiction ValueSet |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |