AU Core Implementation Guide
0.3.0-ballot - R1 Australia flag

This page is part of the AU Core (v0.3.0-ballot: AU Core R1 Ballot 5) based on FHIR (HL7® FHIR® Standard) R4. . For a full list of available versions, see the Directory of published versions

Extension: AU Core Sex Assigned At Birth

Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-rsg-sexassignedab Version: 0.3.0-ballot
Standards status: Draft Maturity Level: 0 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

Examples:

Usage:

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

Formal Views of Extension Content

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

This structure is derived from RecordedSexOrGender

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*RecordedSexOrGenderSex Assigned at Birth
... extension:value S1..1ExtensionExtension
.... value[x] 1..1CodeableConceptValue of extension
Binding: Biological Sex . (extensible)
... extension:type S1..1ExtensionSNOMED Sex Assigned at Birth
.... value[x] 1..1CodeableConceptValue of extension
Required Pattern: At least the following
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1515311000168102

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*RecordedSexOrGenderSex Assigned at Birth
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 2..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:value S1..1ExtensionExtension
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"value"
.... value[x] 1..1CodeableConceptValue of extension
Binding: Biological Sex . (extensible)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"type"
.... value[x] 1..1CodeableConceptValue of extension
Binding: Recorded Sex Or Gender Type (example)
Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1515311000168102
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... text0..1stringPlain text representation of the concept
... extension:effectivePeriod 0..1ExtensionWhen the recorded sex or gender value applies
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"effectivePeriod"
.... value[x] 0..1PeriodValue of extension
... extension:acquisitionDate 0..1ExtensionWhen the sex or gender value was recorded.
.... id 0..1stringUnique id for inter-element referencing
.... 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.
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"sourceDocument"
.... value[x] 1..1Value of extension
..... valueCodeableConceptCodeableConcept
..... valueReferenceReference(DocumentReference)
... extension:sourceField 0..1ExtensionThe name of the field within the source document where this sex or gender property is initially recorded.
.... id 0..1stringUnique id for inter-element referencing
.... 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
.... id 0..1stringUnique id for inter-element referencing
.... 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
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"comment"
.... value[x] 1..1stringValue of extension
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender"

doco 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.
  • 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: The jurisdiction or organization that issued the document from which the sex or gender was aquired
  • comment: string: Further explanation about the context or source of the recorded sex or gender value

Maturity: 0

Differential View

This structure is derived from RecordedSexOrGender

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*RecordedSexOrGenderSex Assigned at Birth
... extension:value S1..1ExtensionExtension
.... value[x] 1..1CodeableConceptValue of extension
Binding: Biological Sex . (extensible)
... extension:type S1..1ExtensionSNOMED Sex Assigned at Birth
.... value[x] 1..1CodeableConceptValue of extension
Required Pattern: At least the following
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1515311000168102

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*RecordedSexOrGenderSex Assigned at Birth
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 2..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:value S1..1ExtensionExtension
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"value"
.... value[x] 1..1CodeableConceptValue of extension
Binding: Biological Sex . (extensible)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"type"
.... value[x] 1..1CodeableConceptValue of extension
Binding: Recorded Sex Or Gender Type (example)
Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: 1515311000168102
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... text0..1stringPlain text representation of the concept
... extension:effectivePeriod 0..1ExtensionWhen the recorded sex or gender value applies
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"effectivePeriod"
.... value[x] 0..1PeriodValue of extension
... extension:acquisitionDate 0..1ExtensionWhen the sex or gender value was recorded.
.... id 0..1stringUnique id for inter-element referencing
.... 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.
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"sourceDocument"
.... value[x] 1..1Value of extension
..... valueCodeableConceptCodeableConcept
..... valueReferenceReference(DocumentReference)
... extension:sourceField 0..1ExtensionThe name of the field within the source document where this sex or gender property is initially recorded.
.... id 0..1stringUnique id for inter-element referencing
.... 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
.... id 0..1stringUnique id for inter-element referencing
.... 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
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"comment"
.... value[x] 1..1stringValue of extension
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / CodeURI
Extension.extension:value.value[x]extensibleBiologicalSex .
https://healthterminologies.gov.au/fhir/ValueSet/biological-sex-1
Extension.extension:type.value[x]examplePattern: SNOMED CT code 1515311000168102
http://terminology.hl7.org/ValueSet/recorded-sex-or-gender-type
Extension.extension:jurisdiction.value[x]extensibleJurisdiction ValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard

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