AU Core Implementation Guide
1.1.0-preview - Preview

Publication Build: This will be filled in by the publication tooling

## Extension: AU Core Sex Assigned At Birth

Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-rsg-sexassignedab | Version: 1.1.0-preview
Standards status: Trial-use | Maturity Level: 2 | Computable Name: AUCoreSexAssignedAtBirth
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2022+; Licensed Under Creative Commons No Rights Reserved.

This profile defines the minimum expectations for a Person Recorded Sex or Gender extension when representing Sex Assigned at Birth. This profile identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the Extension when conforming to this profile.

This extension may be used on the following element(s):

- Element ID Patient
- Element ID RelatedPerson
- Element ID Person
- Element ID Practitioner

### Profile specific implementation guidance

- See the Sex and Gender page for guidance on exchanging sex and gender related concepts conformant to AU Core.

Examples:

- Examples for this Extension Profile: Patient/banks-mia-leanne

Usage:

- This Extension is not used by any profiles in this Implementation Guide

Changes since version 1.0.0:

- No changes

### Formal Views of Extension Content

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

- Differential Table
- Snapshot Table
- All

This structure is derived from RecordedSexOrGender

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Extension |  | 0..* | RecordedSexOrGender | Sex Assigned at Birth
Slices for extension |  |  |  | Content/Rules for all slices
extension:value | SO | 1..1 | Extension | Extension
Obligations | Actor
SHALL:populate-if-known | AU Core Responder
SHALL:no-error | AU Core Requester
value[x] |  | 1..1 | CodeableConcept | Value of extension Binding: Biological Sex (extensible)
extension:type | SO | 1..1 | Extension | SNOMED Sex Assigned at Birth
Obligations | Actor
SHALL:populate-if-known | AU Core Responder
SHALL:no-error | AU Core Requester
value[x] |  | 1..1 | CodeableConcept | Value of extension Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1515311000168102
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Extension |  | 0..* | RecordedSexOrGender | Sex Assigned at Birth
id |  | 0..1 | id | Unique id for inter-element referencing
Slices for extension |  | 2..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:value | SO | 1..1 | Extension | Extension
Obligations | Actor
SHALL:populate-if-known | AU Core Responder
SHALL:no-error | AU Core Requester
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: Biological Sex (extensible)
extension:type | SO | 1..1 | Extension | SNOMED Sex Assigned at Birth
Obligations | Actor
SHALL:populate-if-known | AU Core Responder
SHALL:no-error | AU Core Requester
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 (example) Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1515311000168102
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
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:source |  | 0..1 | Extension | The source of the Recorded Sex or Gender value.
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..0 |  |
url |  | 1..1 | uri | "source"
value[x] |  | 1..1 |  | Value of extension
valueCodeableConcept |  |  | CodeableConcept |
valueReference |  |  | Reference(Organization | Device | RelatedPerson | Practitioner) |
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 |  | Value of extension
valueCodeableConcept |  |  | CodeableConcept |
valueReference |  |  | Reference(DocumentReference) |
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 ValueSet (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
extension:genderElementQualifier |  | 0..1 | Extension | Whether this recorded sex or gender value qualifies the .gender element.
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..0 |  |
url |  | 1..1 | uri | "genderElementQualifier"
value[x] |  | 1..1 | boolean | Value of extension
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender"
Documentation for this format

This structure is derived from RecordedSexOrGender

Summary

Complex Extension: This profile defines the minimum expectations for a Person Recorded Sex or Gender extension when representing Sex Assigned at Birth. This profile identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the Extension when conforming to this profile.

- value: CodeableConcept: An Extension
- type: CodeableConcept: The type or category of sex or gender that is recorded is sex assigned at birth.
- effectivePeriod: Period: The time period during which the recorded sex or gender value applies to the individual
- acquisitionDate: dateTime: The date/time when the sex or gender value was first recorded in the system.
- source: CodeableConcept, Reference: A reference to the source of the Recorded Sex or Gender value.
- sourceDocument: CodeableConcept, Reference: The reference to the source document or the code representing the type of document where this sex or gender property is initially recorded.
- sourceField: string: The name of the field within the source document where this sex or gender property is initially recorded.
- jurisdiction: CodeableConcept: Jurisdiction responsible for the source and/or the sourceDocument where the recored sex or gender value was acquired.
- comment: string: Further explanation about the context or source of the recorded sex or gender value
- genderElementQualifier: boolean: Instances of the individual-recordedSexOrGender extension with this value set to 'true' provides additional semantics or provenance of the data communicated in the relevant '.gender' property in the resource. For example, if a system populates Patient.gender using a sex assigned at birth value, the individual-recordedSexOrGender extension with genderElementQualifier=true can provide that context.

Maturity: 2

Differential View

This structure is derived from RecordedSexOrGender

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Extension |  | 0..* | RecordedSexOrGender | Sex Assigned at Birth
Slices for extension |  |  |  | Content/Rules for all slices
extension:value | SO | 1..1 | Extension | Extension
Obligations | Actor
SHALL:populate-if-known | AU Core Responder
SHALL:no-error | AU Core Requester
value[x] |  | 1..1 | CodeableConcept | Value of extension Binding: Biological Sex (extensible)
extension:type | SO | 1..1 | Extension | SNOMED Sex Assigned at Birth
Obligations | Actor
SHALL:populate-if-known | AU Core Responder
SHALL:no-error | AU Core Requester
value[x] |  | 1..1 | CodeableConcept | Value of extension Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1515311000168102
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Extension |  | 0..* | RecordedSexOrGender | Sex Assigned at Birth
id |  | 0..1 | id | Unique id for inter-element referencing
Slices for extension |  | 2..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:value | SO | 1..1 | Extension | Extension
Obligations | Actor
SHALL:populate-if-known | AU Core Responder
SHALL:no-error | AU Core Requester
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: Biological Sex (extensible)
extension:type | SO | 1..1 | Extension | SNOMED Sex Assigned at Birth
Obligations | Actor
SHALL:populate-if-known | AU Core Responder
SHALL:no-error | AU Core Requester
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 (example) Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 1515311000168102
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
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:source |  | 0..1 | Extension | The source of the Recorded Sex or Gender value.
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..0 |  |
url |  | 1..1 | uri | "source"
value[x] |  | 1..1 |  | Value of extension
valueCodeableConcept |  |  | CodeableConcept |
valueReference |  |  | Reference(Organization | Device | RelatedPerson | Practitioner) |
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 |  | Value of extension
valueCodeableConcept |  |  | CodeableConcept |
valueReference |  |  | Reference(DocumentReference) |
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 ValueSet (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
extension:genderElementQualifier |  | 0..1 | Extension | Whether this recorded sex or gender value qualifies the .gender element.
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..0 |  |
url |  | 1..1 | uri | "genderElementQualifier"
value[x] |  | 1..1 | boolean | 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

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Extension.extension:value.value[x] | extensible | BiologicalSex `https://healthterminologies.gov.au/fhir/ValueSet/biological-sex-1` from https://tx.ontoserver.csiro.au/fhir
Extension.extension:type.value[x] | example | Pattern: SNOMED-CT Code 1515311000168102 `http://terminology.hl7.org/ValueSet/recorded-sex-or-gender-type`
Extension.extension:jurisdiction.value[x] | extensible | JurisdictionValueSet `http://terminology.hl7.org/ValueSet/jurisdiction`

#### Constraints

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