AU Base Implementation Guide
4.1.2-preview - Preview Australia flag

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

Extension: Person Recorded Sex Or Gender

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):

  • Element ID Patient
  • Element ID RelatedPerson
  • Element ID Person
  • Element ID Practitioner

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 Notes

Usage:

Formal Views of Extension Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionA recorded sex or gender property for the individual
... extension:value 1..1ExtensionThe recorded sex or gender property for the individual
.... extension 0..0
.... url 1..1uri"value"
.... value[x] 1..1CodeableConceptValue of extension
Binding: AdministrativeGender (example)
... extension:type 0..1ExtensionType of recorded sex or gender.
.... extension 0..0
.... url 1..1uri"type"
.... value[x] 1..1CodeableConceptValue of extension
Binding: Recorded Sex Or Gender Type (example)
... extension:effectivePeriod 0..1ExtensionWhen the recorded sex or gender value applies
.... extension 0..0
.... url 1..1uri"effectivePeriod"
.... value[x] 0..1PeriodValue of extension
.... extension 0..0
.... url 1..1uri"acquisitionDate"
.... value[x] 1..1dateTimeValue of extension
... extension:sourceDocument 0..1ExtensionThe document the sex or gender property was acquired from.
.... extension 0..0
.... url 1..1uri"sourceDocument"
.... Slices for value[x] 1..1CodeableConcept, Reference()Value of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueCodeableConcept 0..1CodeableConceptValue of extension
..... value[x]:valueReference 0..1Reference(DocumentReference)Value of extension
... extension:sourceField 0..1ExtensionThe name of the field within the source document where this sex or gender property is initially recorded.
.... extension 0..0
.... url 1..1uri"sourceField"
.... value[x] 1..1stringValue of extension
... extension:jurisdiction 0..1ExtensionWho issued the document where the sex or gender was aquired
.... extension 0..0
.... url 1..1uri"jurisdiction"
.... value[x] 1..1CodeableConceptValue of extension
Binding: Jurisdiction ValueSet (extensible)
... extension:comment 0..1ExtensionContext or source information about the recorded sex or gender
.... extension 0..0
.... url 1..1uri"comment"
.... value[x] 1..1stringValue of extension
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender"
... value[x] 0..0

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Extension.extension:value.value[x]exampleAdministrativeGender
Extension.extension:type.value[x]exampleRecordedSexOrGenderType
Extension.extension:jurisdiction.value[x]extensibleJurisdiction ValueSet

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()