Visit the HL7 website
Visit the FHIR website

CA Core+

1.2.0-dft-ballot   Canada flag
  • Index
  • Home
  • Business Context
    • Business Context
    • Relationship to PCHDCF
    • Relationship to Other Specifications
    • CA Core+ to PCHDCF Mapping
  • Technical Context
    • Technical Context
    • Artifact Status Summary
    • Profiling Conventions & Approach
    • General Guidance
    • Mapping Logic
    • Security And Privacy
  • Modules
    • Modules
    • Common Data Exchange
    • Workflows
  • FHIR Artifacts
    • FHIR Artifacts
    • Profiles
    • Extensions
    • Data Types
    • Terminology
    • Actors
    • Examples
    • Download
  • Change Log
    • Change Log
    • Specification Guidance
    • Copyrights
    • Known Issues & Future Development
    • Specification Feedback
    1. Index
    2. FHIR Artifacts
    3. Extensions
    4. BirthSex

DFT-Ballot - The specification is a DFT-Ballot version of CA Core+ for collecting ballot feedback. For a full list of available versions, see the Directory of published versions

BirthSex

Links

Extension

ext-patientbirthsex

Description

A code classifying the person's sex assigned at birth. Replicates the birthsex extension in US-Core-R4 for interoperability.

References to this Extension

PatientCACore

Standards Status FMM
trial-use 2

Resource Content

  • Overview
  • Tree view
  • XML
  • JSON
ExtensionBirthSex (Extension)CExtension
There are no (further) constraints on this element
Element id
Extension
Short description

Optional Extensions Element

Definition

Optional Extension Element - found in all resources.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
  • CACDI: Sex at Birth
id0..1string
There are no (further) constraints on this element
Element id
Extension.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..0Extension
There are no (further) constraints on this element
Element id
Extension.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
url1..1uriFixed Value
There are no (further) constraints on this element
Element id
Extension.url
Short description

identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Data type

uri

Fixed value
http://fhir.infoway-inforoute.ca/ca-ext/StructureDefinition/patient-birthSex
Mappings
  • rim: N/A
value[x]1..1
There are no (further) constraints on this element
Element id
Extension.value[x]
Short description

Value of extension

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Slicing

Unordered, Open, by $this(Type)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
valueAddressAddress
There are no (further) constraints on this element
Data type

Address

valueAgeAge
There are no (further) constraints on this element
Data type

Age

valueAnnotationAnnotation
There are no (further) constraints on this element
Data type

Annotation

valueAttachmentAttachment
There are no (further) constraints on this element
Data type

Attachment

valueBase64Binarybase64Binary
There are no (further) constraints on this element
Data type

base64Binary

valueBooleanboolean
There are no (further) constraints on this element
Data type

boolean

valueCanonicalcanonical
There are no (further) constraints on this element
Data type

canonical

valueCodecode
There are no (further) constraints on this element
Data type

code

valueCodeableConceptCodeableConcept
There are no (further) constraints on this element
Data type

CodeableConcept

valueContactDetailContactDetail
There are no (further) constraints on this element
Data type

ContactDetail

valueContactPointContactPoint
There are no (further) constraints on this element
Data type

ContactPoint

valueContributorContributor
There are no (further) constraints on this element
Data type

Contributor

valueCountCount
There are no (further) constraints on this element
Data type

Count

valueDataRequirementDataRequirement
There are no (further) constraints on this element
Data type

DataRequirement

valueDatedate
There are no (further) constraints on this element
Data type

date

valueDateTimedateTime
There are no (further) constraints on this element
Data type

dateTime

valueDecimaldecimal
There are no (further) constraints on this element
Data type

decimal

valueDistanceDistance
There are no (further) constraints on this element
Data type

Distance

valueDosageDosage
There are no (further) constraints on this element
Data type

Dosage

valueDurationDuration
There are no (further) constraints on this element
Data type

Duration

valueExpressionExpression
There are no (further) constraints on this element
Data type

Expression

valueHumanNameHumanName
There are no (further) constraints on this element
Data type

HumanName

valueIdid
There are no (further) constraints on this element
Data type

id

valueIdentifierIdentifier
There are no (further) constraints on this element
Data type

Identifier

valueInstantinstant
There are no (further) constraints on this element
Data type

instant

valueIntegerinteger
There are no (further) constraints on this element
Data type

integer

valueMarkdownmarkdown
There are no (further) constraints on this element
Data type

markdown

valueMetaMeta
There are no (further) constraints on this element
Data type

Meta

valueMoneyMoney
There are no (further) constraints on this element
Data type

Money

valueOidoid
There are no (further) constraints on this element
Data type

oid

valueParameterDefinitionParameterDefinition
There are no (further) constraints on this element
Data type

ParameterDefinition

valuePeriodPeriod
There are no (further) constraints on this element
Data type

Period

valuePositiveIntpositiveInt
There are no (further) constraints on this element
Data type

positiveInt

valueQuantityQuantity
There are no (further) constraints on this element
Data type

Quantity

valueRangeRange
There are no (further) constraints on this element
Data type

Range

valueRatioRatio
There are no (further) constraints on this element
Data type

Ratio

valueReferenceReference
There are no (further) constraints on this element
Data type

Reference

valueRelatedArtifactRelatedArtifact
There are no (further) constraints on this element
Data type

RelatedArtifact

valueSampledDataSampledData
There are no (further) constraints on this element
Data type

SampledData

valueSignatureSignature
There are no (further) constraints on this element
Data type

Signature

valueStringstring
There are no (further) constraints on this element
Data type

string

valueTimetime
There are no (further) constraints on this element
Data type

time

valueTimingTiming
There are no (further) constraints on this element
Data type

Timing

valueTriggerDefinitionTriggerDefinition
There are no (further) constraints on this element
Data type

TriggerDefinition

valueUnsignedIntunsignedInt
There are no (further) constraints on this element
Data type

unsignedInt

valueUriuri
There are no (further) constraints on this element
Data type

uri

valueUrlurl
There are no (further) constraints on this element
Data type

url

valueUsageContextUsageContext
There are no (further) constraints on this element
Data type

UsageContext

valueUuiduuid
There are no (further) constraints on this element
Data type

uuid

valueCoding1..1Coding
There are no (further) constraints on this element
Element id
Extension.value[x]:valueCoding
Short description

A code classifying the person's sex assigned at birth

Definition

Uses the SexAssignedAtBirthValueSet to define a person's sex assigned at Birth.

Comments

The codes required are intended to present birth sex (i.e., the sex recorded on the patient’s birth certificate) and not gender identity or reassigned sex.

Data type

Coding

Binding

Code for sex assigned at birth

SexAssignedAtBirthValueSet (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
id0..1string
There are no (further) constraints on this element
Element id
Extension.value[x]:valueCoding.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Extension.value[x]:valueCoding.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
systemΣ1..1uri
There are no (further) constraints on this element
Element id
Extension.value[x]:valueCoding.system
Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
versionΣ0..1string
There are no (further) constraints on this element
Element id
Extension.value[x]:valueCoding.version
Short description

Version of the system - if relevant

Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
codeΣ1..1code
There are no (further) constraints on this element
Element id
Extension.value[x]:valueCoding.code
Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
displayΣ0..1string
There are no (further) constraints on this element
Element id
Extension.value[x]:valueCoding.display
Short description

Optional description of the sex at birth code

Definition

Plain text representation of the sex at birth concept

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
userSelectedΣ0..1boolean
There are no (further) constraints on this element
Element id
Extension.value[x]:valueCoding.userSelected
Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

Data type

boolean

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: Sometimes implied by being first
  • rim: CD.codingRationale
  • orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
ExtensionBirthSex (Extension)CExtensionElement id
Extension
Short description

Optional Extensions Element

Definition

Optional Extension Element - found in all resources.

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
  • CACDI: Sex at Birth
id0..1string
There are no (further) constraints on this element
Element id
Extension.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..0Extension
There are no (further) constraints on this element
Element id
Extension.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
url1..1uriFixed ValueElement id
Extension.url
Short description

identifies the meaning of the extension

Definition

Source of the definition for the extension code - a logical name or a URL.

Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Data type

uri

Fixed value
http://fhir.infoway-inforoute.ca/ca-ext/StructureDefinition/patient-birthSex
Mappings
  • rim: N/A
value[x]1..1Element id
Extension.value[x]
Short description

Value of extension

Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Slicing

Unordered, Open, by $this(Type)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
valueAddressAddress
There are no (further) constraints on this element
Data type

Address

valueAgeAge
There are no (further) constraints on this element
Data type

Age

valueAnnotationAnnotation
There are no (further) constraints on this element
Data type

Annotation

valueAttachmentAttachment
There are no (further) constraints on this element
Data type

Attachment

valueBase64Binarybase64Binary
There are no (further) constraints on this element
Data type

base64Binary

valueBooleanboolean
There are no (further) constraints on this element
Data type

boolean

valueCanonicalcanonical
There are no (further) constraints on this element
Data type

canonical

valueCodecode
There are no (further) constraints on this element
Data type

code

valueCodeableConceptCodeableConcept
There are no (further) constraints on this element
Data type

CodeableConcept

valueContactDetailContactDetail
There are no (further) constraints on this element
Data type

ContactDetail

valueContactPointContactPoint
There are no (further) constraints on this element
Data type

ContactPoint

valueContributorContributor
There are no (further) constraints on this element
Data type

Contributor

valueCountCount
There are no (further) constraints on this element
Data type

Count

valueDataRequirementDataRequirement
There are no (further) constraints on this element
Data type

DataRequirement

valueDatedate
There are no (further) constraints on this element
Data type

date

valueDateTimedateTime
There are no (further) constraints on this element
Data type

dateTime

valueDecimaldecimal
There are no (further) constraints on this element
Data type

decimal

valueDistanceDistance
There are no (further) constraints on this element
Data type

Distance

valueDosageDosage
There are no (further) constraints on this element
Data type

Dosage

valueDurationDuration
There are no (further) constraints on this element
Data type

Duration

valueExpressionExpression
There are no (further) constraints on this element
Data type

Expression

valueHumanNameHumanName
There are no (further) constraints on this element
Data type

HumanName

valueIdid
There are no (further) constraints on this element
Data type

id

valueIdentifierIdentifier
There are no (further) constraints on this element
Data type

Identifier

valueInstantinstant
There are no (further) constraints on this element
Data type

instant

valueIntegerinteger
There are no (further) constraints on this element
Data type

integer

valueMarkdownmarkdown
There are no (further) constraints on this element
Data type

markdown

valueMetaMeta
There are no (further) constraints on this element
Data type

Meta

valueMoneyMoney
There are no (further) constraints on this element
Data type

Money

valueOidoid
There are no (further) constraints on this element
Data type

oid

valueParameterDefinitionParameterDefinition
There are no (further) constraints on this element
Data type

ParameterDefinition

valuePeriodPeriod
There are no (further) constraints on this element
Data type

Period

valuePositiveIntpositiveInt
There are no (further) constraints on this element
Data type

positiveInt

valueQuantityQuantity
There are no (further) constraints on this element
Data type

Quantity

valueRangeRange
There are no (further) constraints on this element
Data type

Range

valueRatioRatio
There are no (further) constraints on this element
Data type

Ratio

valueReferenceReference
There are no (further) constraints on this element
Data type

Reference

valueRelatedArtifactRelatedArtifact
There are no (further) constraints on this element
Data type

RelatedArtifact

valueSampledDataSampledData
There are no (further) constraints on this element
Data type

SampledData

valueSignatureSignature
There are no (further) constraints on this element
Data type

Signature

valueStringstring
There are no (further) constraints on this element
Data type

string

valueTimetime
There are no (further) constraints on this element
Data type

time

valueTimingTiming
There are no (further) constraints on this element
Data type

Timing

valueTriggerDefinitionTriggerDefinition
There are no (further) constraints on this element
Data type

TriggerDefinition

valueUnsignedIntunsignedInt
There are no (further) constraints on this element
Data type

unsignedInt

valueUriuri
There are no (further) constraints on this element
Data type

uri

valueUrlurl
There are no (further) constraints on this element
Data type

url

valueUsageContextUsageContext
There are no (further) constraints on this element
Data type

UsageContext

valueUuiduuid
There are no (further) constraints on this element
Data type

uuid

valueCoding1..1CodingElement id
Extension.value[x]:valueCoding
Short description

A code classifying the person's sex assigned at birth

Definition

Uses the SexAssignedAtBirthValueSet to define a person's sex assigned at Birth.

Comments

The codes required are intended to present birth sex (i.e., the sex recorded on the patient’s birth certificate) and not gender identity or reassigned sex.

Data type

Coding

Binding

Code for sex assigned at birth

SexAssignedAtBirthValueSet (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
id0..1string
There are no (further) constraints on this element
Element id
Extension.value[x]:valueCoding.id
Short description

Unique id for inter-element referencing

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Data type

string

Mappings
  • rim: n/a
extensionC0..*Extension
There are no (further) constraints on this element
Element id
Extension.value[x]:valueCoding.extension
Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
systemΣ1..1uri
There are no (further) constraints on this element
Element id
Extension.value[x]:valueCoding.system
Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
versionΣ0..1string
There are no (further) constraints on this element
Element id
Extension.value[x]:valueCoding.version
Short description

Version of the system - if relevant

Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
codeΣ1..1code
There are no (further) constraints on this element
Element id
Extension.value[x]:valueCoding.code
Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
displayΣ0..1stringElement id
Extension.value[x]:valueCoding.display
Short description

Optional description of the sex at birth code

Definition

Plain text representation of the sex at birth concept

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
userSelectedΣ0..1boolean
There are no (further) constraints on this element
Element id
Extension.value[x]:valueCoding.userSelected
Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

Data type

boolean

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: Sometimes implied by being first
  • rim: CD.codingRationale
  • orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
<StructureDefinition xmlns="http://hl7.org/fhir">
<id value="ext-patientbirthsex" />
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
<valueInteger value="2" />
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
<valueCode value="trial-use" />
</extension>
<url value="http://fhir.infoway-inforoute.ca/ca-ext/StructureDefinition/patient-birthSex" />
<version value="1.1.0" />
<name value="ExtensionBirthSex" />
<title value="Extension: Birth Sex" />
<status value="draft" />
<date value="2024-08-09" />
<publisher value="HL7 Canada - FHIR Implementation Work Group" />
<contact>
<telecom>
<system value="url" />
<value value="https://infocentral.infoway-inforoute.ca/en/collaboration/wg/fhir-implementations" />
</telecom>
</contact>
<description value="A code classifying the person's sex assigned at birth. Replicates the birthsex extension in US-Core-R4 for interoperability." />
<jurisdiction>
<coding>
<system value="urn:iso:std:iso:3166" />
<code value="CA" />
</coding>
</jurisdiction>
<fhirVersion value="4.0.1" />
<mapping>
<identity value="CACDI" />
<name value="Canadian Core Data for Interoperability (CACDI)" />
</mapping>
<kind value="complex-type" />
<abstract value="false" />
<context>
<type value="element" />
<expression value="Patient" />
</context>
<type value="Extension" />
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/Extension" />
<derivation value="constraint" />
<snapshot>
<element id="Extension">
<path value="Extension" />
<short value="Optional Extensions Element" />
<definition value="Optional Extension Element - found in all resources." />
<min value="0" />
<max value="*" />
<base>
<path value="Extension" />
<min value="0" />
<max value="*" />
</base>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<constraint>
<key value="ext-1" />
<severity value="error" />
<human value="Must have either extensions or value[x], not both" />
<expression value="extension.exists() != value.exists()" />
<xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" />
<source value="http://hl7.org/fhir/StructureDefinition/Extension" />
</constraint>
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
<mapping>
<identity value="CACDI" />
<map value="Sex at Birth" />
</mapping>
</element>
<element id="Extension.id">
<path value="Extension.id" />
<representation value="xmlAttr" />
<short value="Unique id for inter-element referencing" />
<definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." />
<min value="0" />
<max value="1" />
<base>
<path value="Element.id" />
<min value="0" />
<max value="1" />
</base>
<type>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="string" />
</extension>
<code value="http://hl7.org/fhirpath/System.String" />
</type>
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
</element>
<element id="Extension.extension">
<path value="Extension.extension" />
<slicing>
<discriminator>
<type value="value" />
<path value="url" />
</discriminator>
<description value="Extensions are always sliced by (at least) url" />
<rules value="open" />
</slicing>
<short value="Additional content defined by implementations" />
<definition value="May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension." />
<comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." />
<alias value="extensions" />
<alias value="user content" />
<min value="0" />
<max value="0" />
<base>
<path value="Element.extension" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="Extension" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<constraint>
<key value="ext-1" />
<severity value="error" />
<human value="Must have either extensions or value[x], not both" />
<expression value="extension.exists() != value.exists()" />
<xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" />
<source value="http://hl7.org/fhir/StructureDefinition/Extension" />
</constraint>
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="Extension.url">
<path value="Extension.url" />
<representation value="xmlAttr" />
<short value="identifies the meaning of the extension" />
<definition value="Source of the definition for the extension code - a logical name or a URL." />
<comment value="The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension." />
<min value="1" />
<max value="1" />
<base>
<path value="Extension.url" />
<min value="1" />
<max value="1" />
</base>
<type>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="uri" />
</extension>
<code value="http://hl7.org/fhirpath/System.String" />
</type>
<fixedUri value="http://fhir.infoway-inforoute.ca/ca-ext/StructureDefinition/patient-birthSex" />
<mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="Extension.value[x]">
<path value="Extension.value[x]" />
<slicing>
<discriminator>
<type value="type" />
<path value="$this" />
</discriminator>
<ordered value="false" />
<rules value="open" />
</slicing>
<short value="Value of extension" />
<definition value="Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list)." />
<min value="1" />
<max value="1" />
<base>
<path value="Extension.value[x]" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="base64Binary" />
</type>
<type>
<code value="boolean" />
</type>
<type>
<code value="canonical" />
</type>
<type>
<code value="code" />
</type>
<type>
<code value="date" />
</type>
<type>
<code value="dateTime" />
</type>
<type>
<code value="decimal" />
</type>
<type>
<code value="id" />
</type>
<type>
<code value="instant" />
</type>
<type>
<code value="integer" />
</type>
<type>
<code value="markdown" />
</type>
<type>
<code value="oid" />
</type>
<type>
<code value="positiveInt" />
</type>
<type>
<code value="string" />
</type>
<type>
<code value="time" />
</type>
<type>
<code value="unsignedInt" />
</type>
<type>
<code value="uri" />
</type>
<type>
<code value="url" />
</type>
<type>
<code value="uuid" />
</type>
<type>
<code value="Address" />
</type>
<type>
<code value="Age" />
</type>
<type>
<code value="Annotation" />
</type>
<type>
<code value="Attachment" />
</type>
<type>
<code value="CodeableConcept" />
</type>
<type>
<code value="Coding" />
</type>
<type>
<code value="ContactPoint" />
</type>
<type>
<code value="Count" />
</type>
<type>
<code value="Distance" />
</type>
<type>
<code value="Duration" />
</type>
<type>
<code value="HumanName" />
</type>
<type>
<code value="Identifier" />
</type>
<type>
<code value="Money" />
</type>
<type>
<code value="Period" />
</type>
<type>
<code value="Quantity" />
</type>
<type>
<code value="Range" />
</type>
<type>
<code value="Ratio" />
</type>
<type>
<code value="Reference" />
</type>
<type>
<code value="SampledData" />
</type>
<type>
<code value="Signature" />
</type>
<type>
<code value="Timing" />
</type>
<type>
<code value="ContactDetail" />
</type>
<type>
<code value="Contributor" />
</type>
<type>
<code value="DataRequirement" />
</type>
<type>
<code value="Expression" />
</type>
<type>
<code value="ParameterDefinition" />
</type>
<type>
<code value="RelatedArtifact" />
</type>
<type>
<code value="TriggerDefinition" />
</type>
<type>
<code value="UsageContext" />
</type>
<type>
<code value="Dosage" />
</type>
<type>
<code value="Meta" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="Extension.value[x]:valueCoding">
<path value="Extension.value[x]" />
<sliceName value="valueCoding" />
<short value="A code classifying the person's sex assigned at birth" />
<definition value="Uses the SexAssignedAtBirthValueSet to define a person's sex assigned at Birth." />
<comment value="The codes required are intended to present birth sex (i.e., the sex recorded on the patient’s birth certificate) and not gender identity or reassigned sex." />
<min value="1" />
<max value="1" />
<base>
<path value="Extension.value[x]" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="Coding" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<binding>
<strength value="example" />
<description value="Code for sex assigned at birth" />
<valueSet value="https://fhir.infoway-inforoute.ca/ValueSet/sexassignedatbirth" />
</binding>
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="Extension.value[x]:valueCoding.id">
<path value="Extension.value[x].id" />
<representation value="xmlAttr" />
<short value="Unique id for inter-element referencing" />
<definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." />
<min value="0" />
<max value="1" />
<base>
<path value="Element.id" />
<min value="0" />
<max value="1" />
</base>
<type>
<extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type">
<valueUrl value="string" />
</extension>
<code value="http://hl7.org/fhirpath/System.String" />
</type>
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
</element>
<element id="Extension.value[x]:valueCoding.extension">
<path value="Extension.value[x].extension" />
<slicing>
<discriminator>
<type value="value" />
<path value="url" />
</discriminator>
<description value="Extensions are always sliced by (at least) url" />
<rules value="open" />
</slicing>
<short value="Additional content defined by implementations" />
<definition value="May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension." />
<comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." />
<alias value="extensions" />
<alias value="user content" />
<min value="0" />
<max value="*" />
<base>
<path value="Element.extension" />
<min value="0" />
<max value="*" />
</base>
<type>
<code value="Extension" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<constraint>
<key value="ext-1" />
<severity value="error" />
<human value="Must have either extensions or value[x], not both" />
<expression value="extension.exists() != value.exists()" />
<xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])" />
<source value="http://hl7.org/fhir/StructureDefinition/Extension" />
</constraint>
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="rim" />
<map value="N/A" />
</mapping>
</element>
<element id="Extension.value[x]:valueCoding.system">
<path value="Extension.value[x].system" />
<short value="Identity of the terminology system" />
<definition value="The identification of the code system that defines the meaning of the symbol in the code." />
<comment value="The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously." />
<requirements value="Need to be unambiguous about the source of the definition of the symbol." />
<min value="1" />
<max value="1" />
<base>
<path value="Coding.system" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="uri" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isSummary value="true" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="v2" />
<map value="C*E.3" />
</mapping>
<mapping>
<identity value="rim" />
<map value="./codeSystem" />
</mapping>
<mapping>
<identity value="orim" />
<map value="fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" />
</mapping>
</element>
<element id="Extension.value[x]:valueCoding.version">
<path value="Extension.value[x].version" />
<short value="Version of the system - if relevant" />
<definition value="The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged." />
<comment value="Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date." />
<min value="0" />
<max value="1" />
<base>
<path value="Coding.version" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="string" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isSummary value="true" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="v2" />
<map value="C*E.7" />
</mapping>
<mapping>
<identity value="rim" />
<map value="./codeSystemVersion" />
</mapping>
<mapping>
<identity value="orim" />
<map value="fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" />
</mapping>
</element>
<element id="Extension.value[x]:valueCoding.code">
<path value="Extension.value[x].code" />
<short value="Symbol in syntax defined by the system" />
<definition value="A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination)." />
<comment value="Note that FHIR strings SHALL NOT exceed 1MB in size" />
<requirements value="Need to refer to a particular code in the system." />
<min value="1" />
<max value="1" />
<base>
<path value="Coding.code" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="code" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isSummary value="true" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="v2" />
<map value="C*E.1" />
</mapping>
<mapping>
<identity value="rim" />
<map value="./code" />
</mapping>
<mapping>
<identity value="orim" />
<map value="fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" />
</mapping>
</element>
<element id="Extension.value[x]:valueCoding.display">
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable">
<valueBoolean value="true" />
</extension>
<path value="Extension.value[x].display" />
<short value="Optional description of the sex at birth code" />
<definition value="Plain text representation of the sex at birth concept" />
<comment value="Note that FHIR strings SHALL NOT exceed 1MB in size" />
<requirements value="Need to be able to carry a human-readable meaning of the code for readers that do not know the system." />
<min value="0" />
<max value="1" />
<base>
<path value="Coding.display" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="string" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isSummary value="true" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="v2" />
<map value="C*E.2 - but note this is not well followed" />
</mapping>
<mapping>
<identity value="rim" />
<map value="CV.displayName" />
</mapping>
<mapping>
<identity value="orim" />
<map value="fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" />
</mapping>
</element>
<element id="Extension.value[x]:valueCoding.userSelected">
<path value="Extension.value[x].userSelected" />
<short value="If this coding was chosen directly by the user" />
<definition value="Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays)." />
<comment value="Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely." />
<requirements value="This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing." />
<min value="0" />
<max value="1" />
<base>
<path value="Coding.userSelected" />
<min value="0" />
<max value="1" />
</base>
<type>
<code value="boolean" />
</type>
<condition value="ele-1" />
<constraint>
<key value="ele-1" />
<severity value="error" />
<human value="All FHIR elements must have a @value or children" />
<expression value="hasValue() or (children().count() > id.count())" />
<xpath value="@value|f:*|h:div" />
<source value="http://hl7.org/fhir/StructureDefinition/Element" />
</constraint>
<isSummary value="true" />
<mapping>
<identity value="rim" />
<map value="n/a" />
</mapping>
<mapping>
<identity value="v2" />
<map value="Sometimes implied by being first" />
</mapping>
<mapping>
<identity value="rim" />
<map value="CD.codingRationale" />
</mapping>
<mapping>
<identity value="orim" />
<map value="fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]" />
</mapping>
</element>
</snapshot>
<differential>
<element id="Extension">
<path value="Extension" />
<mapping>
<identity value="CACDI" />
<map value="Sex at Birth" />
</mapping>
</element>
<element id="Extension.extension">
<path value="Extension.extension" />
<max value="0" />
</element>
<element id="Extension.url">
<path value="Extension.url" />
<fixedUri value="http://fhir.infoway-inforoute.ca/ca-ext/StructureDefinition/patient-birthSex" />
</element>
<element id="Extension.value[x]">
<path value="Extension.value[x]" />
<slicing>
<discriminator>
<type value="type" />
<path value="$this" />
</discriminator>
<ordered value="false" />
<rules value="open" />
</slicing>
<min value="1" />
</element>
<element id="Extension.value[x]:valueCoding">
<path value="Extension.value[x]" />
<sliceName value="valueCoding" />
<short value="A code classifying the person's sex assigned at birth" />
<definition value="Uses the SexAssignedAtBirthValueSet to define a person's sex assigned at Birth." />
<comment value="The codes required are intended to present birth sex (i.e., the sex recorded on the patient’s birth certificate) and not gender identity or reassigned sex." />
<min value="1" />
<max value="1" />
<type>
<code value="Coding" />
</type>
<binding>
<strength value="example" />
<description value="Code for sex assigned at birth" />
<valueSet value="https://fhir.infoway-inforoute.ca/ValueSet/sexassignedatbirth" />
</binding>
</element>
<element id="Extension.value[x]:valueCoding.system">
<path value="Extension.value[x].system" />
<min value="1" />
</element>
<element id="Extension.value[x]:valueCoding.code">
<path value="Extension.value[x].code" />
<min value="1" />
</element>
<element id="Extension.value[x]:valueCoding.display">
<path value="Extension.value[x].display" />
<short value="Optional description of the sex at birth code" />
<definition value="Plain text representation of the sex at birth concept" />
</element>
</differential>
</StructureDefinition>
{
"resourceType": "StructureDefinition",
"id": "ext-patientbirthsex",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 2
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}
],
"url": "http://fhir.infoway-inforoute.ca/ca-ext/StructureDefinition/patient-birthSex",
"version": "1.1.0",
"name": "ExtensionBirthSex",
"title": "Extension: Birth Sex",
"status": "draft",
"date": "2024-08-09",
"publisher": "HL7 Canada - FHIR Implementation Work Group",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "https://infocentral.infoway-inforoute.ca/en/collaboration/wg/fhir-implementations"
}
]
}
],
"description": "A code classifying the person's sex assigned at birth. Replicates the birthsex extension in US-Core-R4 for interoperability.",
"jurisdiction": [
{
"coding": [
{
"system": "urn:iso:std:iso:3166",
"code": "CA"
}
]
}
],
"fhirVersion": "4.0.1",
"mapping": [
{
"identity": "CACDI",
"name": "Canadian Core Data for Interoperability (CACDI)"
}
],
"kind": "complex-type",
"abstract": false,
"context": [
{
"type": "element",
"expression": "Patient"
}
],
"type": "Extension",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
"derivation": "constraint",
"snapshot": {
"element": [
{
"id": "Extension",
"path": "Extension",
"short": "Optional Extensions Element",
"definition": "Optional Extension Element - found in all resources.",
"min": 0,
"max": "*",
"base": {
"path": "Extension",
"min": 0,
"max": "*"
},
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
},
{
"identity": "CACDI",
"map": "Sex at Birth"
}
]
},
{
"id": "Extension.id",
"path": "Extension.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Extension.extension",
"path": "Extension.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "0",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.url",
"path": "Extension.url",
"representation": [
"xmlAttr"
],
"short": "identifies the meaning of the extension",
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
"min": 1,
"max": "1",
"base": {
"path": "Extension.url",
"min": 1,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "uri"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"fixedUri": "http://fhir.infoway-inforoute.ca/ca-ext/StructureDefinition/patient-birthSex",
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.value[x]",
"path": "Extension.value[x]",
"slicing": {
"discriminator": [
{
"type": "type",
"path": "$this"
}
],
"ordered": false,
"rules": "open"
},
"short": "Value of extension",
"definition": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).",
"min": 1,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "base64Binary"
},
{
"code": "boolean"
},
{
"code": "canonical"
},
{
"code": "code"
},
{
"code": "date"
},
{
"code": "dateTime"
},
{
"code": "decimal"
},
{
"code": "id"
},
{
"code": "instant"
},
{
"code": "integer"
},
{
"code": "markdown"
},
{
"code": "oid"
},
{
"code": "positiveInt"
},
{
"code": "string"
},
{
"code": "time"
},
{
"code": "unsignedInt"
},
{
"code": "uri"
},
{
"code": "url"
},
{
"code": "uuid"
},
{
"code": "Address"
},
{
"code": "Age"
},
{
"code": "Annotation"
},
{
"code": "Attachment"
},
{
"code": "CodeableConcept"
},
{
"code": "Coding"
},
{
"code": "ContactPoint"
},
{
"code": "Count"
},
{
"code": "Distance"
},
{
"code": "Duration"
},
{
"code": "HumanName"
},
{
"code": "Identifier"
},
{
"code": "Money"
},
{
"code": "Period"
},
{
"code": "Quantity"
},
{
"code": "Range"
},
{
"code": "Ratio"
},
{
"code": "Reference"
},
{
"code": "SampledData"
},
{
"code": "Signature"
},
{
"code": "Timing"
},
{
"code": "ContactDetail"
},
{
"code": "Contributor"
},
{
"code": "DataRequirement"
},
{
"code": "Expression"
},
{
"code": "ParameterDefinition"
},
{
"code": "RelatedArtifact"
},
{
"code": "TriggerDefinition"
},
{
"code": "UsageContext"
},
{
"code": "Dosage"
},
{
"code": "Meta"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.value[x]:valueCoding",
"path": "Extension.value[x]",
"sliceName": "valueCoding",
"short": "A code classifying the person's sex assigned at birth",
"definition": "Uses the SexAssignedAtBirthValueSet to define a person's sex assigned at Birth.",
"comment": "The codes required are intended to present birth sex (i.e., the sex recorded on the patient’s birth certificate) and not gender identity or reassigned sex.",
"min": 1,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Coding"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"binding": {
"strength": "example",
"description": "Code for sex assigned at birth",
"valueSet": "https://fhir.infoway-inforoute.ca/ValueSet/sexassignedatbirth"
},
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.value[x]:valueCoding.id",
"path": "Extension.value[x].id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Extension.value[x]:valueCoding.extension",
"path": "Extension.value[x].extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Extension.value[x]:valueCoding.system",
"path": "Extension.value[x].system",
"short": "Identity of the terminology system",
"definition": "The identification of the code system that defines the meaning of the symbol in the code.",
"comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.",
"requirements": "Need to be unambiguous about the source of the definition of the symbol.",
"min": 1,
"max": "1",
"base": {
"path": "Coding.system",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "C*E.3"
},
{
"identity": "rim",
"map": "./codeSystem"
},
{
"identity": "orim",
"map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem"
}
]
},
{
"id": "Extension.value[x]:valueCoding.version",
"path": "Extension.value[x].version",
"short": "Version of the system - if relevant",
"definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.",
"comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.",
"min": 0,
"max": "1",
"base": {
"path": "Coding.version",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "C*E.7"
},
{
"identity": "rim",
"map": "./codeSystemVersion"
},
{
"identity": "orim",
"map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion"
}
]
},
{
"id": "Extension.value[x]:valueCoding.code",
"path": "Extension.value[x].code",
"short": "Symbol in syntax defined by the system",
"definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).",
"comment": "Note that FHIR strings SHALL NOT exceed 1MB in size",
"requirements": "Need to refer to a particular code in the system.",
"min": 1,
"max": "1",
"base": {
"path": "Coding.code",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "C*E.1"
},
{
"identity": "rim",
"map": "./code"
},
{
"identity": "orim",
"map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code"
}
]
},
{
"id": "Extension.value[x]:valueCoding.display",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}
],
"path": "Extension.value[x].display",
"short": "Optional description of the sex at birth code",
"definition": "Plain text representation of the sex at birth concept",
"comment": "Note that FHIR strings SHALL NOT exceed 1MB in size",
"requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.",
"min": 0,
"max": "1",
"base": {
"path": "Coding.display",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "C*E.2 - but note this is not well followed"
},
{
"identity": "rim",
"map": "CV.displayName"
},
{
"identity": "orim",
"map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName"
}
]
},
{
"id": "Extension.value[x]:valueCoding.userSelected",
"path": "Extension.value[x].userSelected",
"short": "If this coding was chosen directly by the user",
"definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).",
"comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.",
"requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.",
"min": 0,
"max": "1",
"base": {
"path": "Coding.userSelected",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "v2",
"map": "Sometimes implied by being first"
},
{
"identity": "rim",
"map": "CD.codingRationale"
},
{
"identity": "orim",
"map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]"
}
]
}
]
},
"differential": {
"element": [
{
"id": "Extension",
"path": "Extension",
"mapping": [
{
"identity": "CACDI",
"map": "Sex at Birth"
}
]
},
{
"id": "Extension.extension",
"path": "Extension.extension",
"max": "0"
},
{
"id": "Extension.url",
"path": "Extension.url",
"fixedUri": "http://fhir.infoway-inforoute.ca/ca-ext/StructureDefinition/patient-birthSex"
},
{
"id": "Extension.value[x]",
"path": "Extension.value[x]",
"slicing": {
"discriminator": [
{
"type": "type",
"path": "$this"
}
],
"ordered": false,
"rules": "open"
},
"min": 1
},
{
"id": "Extension.value[x]:valueCoding",
"path": "Extension.value[x]",
"sliceName": "valueCoding",
"short": "A code classifying the person's sex assigned at birth",
"definition": "Uses the SexAssignedAtBirthValueSet to define a person's sex assigned at Birth.",
"comment": "The codes required are intended to present birth sex (i.e., the sex recorded on the patient’s birth certificate) and not gender identity or reassigned sex.",
"min": 1,
"max": "1",
"type": [
{
"code": "Coding"
}
],
"binding": {
"strength": "example",
"description": "Code for sex assigned at birth",
"valueSet": "https://fhir.infoway-inforoute.ca/ValueSet/sexassignedatbirth"
}
},
{
"id": "Extension.value[x]:valueCoding.system",
"path": "Extension.value[x].system",
"min": 1
},
{
"id": "Extension.value[x]:valueCoding.code",
"path": "Extension.value[x].code",
"min": 1
},
{
"id": "Extension.value[x]:valueCoding.display",
"path": "Extension.value[x].display",
"short": "Optional description of the sex at birth code",
"definition": "Plain text representation of the sex at birth concept"
}
]
}
}

Terminology bindings

PathConformanceValueSet
Extension.value[x]:valueCodingexamplehttps://fhir.infoway-inforoute.ca/ValueSet/sexassignedatbirth

IG © based on FHIR R4 | Package package:ca.infoway.io.core@1.2.0-dft-ballot
Copyright © 2026 Canada Health Infoway. All rights reserved. Terms of Use & License Agreements. Privacy Policy.
HL7® and FHIR® are the registered trademarks of Health Level Seven International