Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build United States of America flag

Consolidated CDA Release 2.1 StructureDefinition Publication, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.1). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.1-sd/ and changes regularly. See the Directory of published versions

Logical Model: Birth Sex Observation

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/BirthSexObservation Version: 2.1
Draft as of 2023-09-29 Computable Name: BirthSexObservation
Other Identifiers: id: urn:hl7ii:2.16.840.1.113883.10.20.22.4.200:2023-05-01

This observation represents the sex of the patient at birth. It is the sex that is entered on the person’s birth certificate at time of birth.

This observation is not appropriate for recording patient gender (administrativeGender).

This observation is not appropriate for recording Gender Identity (GI).

It is recommended systems include the Birth Sex observation in the Social History section.

Usage:

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

Formal Views of Profile Content

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

This structure is derived from CDAR2.Observation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 1..1CDAR2.ObservationXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @classCode, @moodCode, @negationInd, realmCode, typeId, templateId, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, referenceRange
Base for all types and resources
... classCode 1..1csFixed Value: OBS
... moodCode 1..1csFixed Value: EVN
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:templateId1 1..1IItemplateId
..... root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.200
..... extension 1..1stRequired Pattern: 2023-05-01
.... code 1..1csRequired Pattern: 76689-9
.... codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.1
... statusCode 1..1CS
.... code 1..1csFixed Value: completed
... effectiveTime 1..1IVL_TS
.... low 1..1IVXB_TS
.... center 1..1TS
.... width 1..1PQ
.... high 1..1IVXB_TS
... value C1..1CDBinding: ONC Administrative Sex (required)
4537-33040: If value/@code not from value set ONC Administrative Sex urn:oid:2.16.840.1.113762.1.4.1 STATIC 2016-06-01, then value/@nullFlavor SHALL be “UNK” (CONF:4537-33040).

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Observation.valuerequiredONC Administrative Sex

Constraints

IdGradePath(s)DetailsRequirements
4537-33040errorObservation.valueIf value/@code not from value set ONC Administrative Sex urn:oid:2.16.840.1.113762.1.4.1 STATIC 2016-06-01, then value/@nullFlavor SHALL be “UNK” (CONF:4537-33040).
:
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 1..1CDAR2.ObservationXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @classCode, @moodCode, @negationInd, realmCode, typeId, templateId, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, referenceRange
Base for all types and resources
... @classCode 1..1csBinding: ActClassObservation (required)
Fixed Value: OBS
... @moodCode 1..1csFixed Value: EVN
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:templateId1 1..1IItemplateId
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.200
..... @extension 1..1stRequired Pattern: 2023-05-01
.... @code 1..1csRequired Pattern: 76689-9
.... @codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.1
... statusCode 1..1CSBinding: ActStatus (required)
.... @code 1..1csFixed Value: completed
... effectiveTime 1..1IVL_TS
.... low 1..1IVXB_TS
.... center 1..1TS
.... width 1..1PQ
.... high 1..1IVXB_TS
... value C1..1CDBinding: ONC Administrative Sex (required)
4537-33040: If value/@code not from value set ONC Administrative Sex urn:oid:2.16.840.1.113762.1.4.1 STATIC 2016-06-01, then value/@nullFlavor SHALL be “UNK” (CONF:4537-33040).

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.classCoderequiredFixed Value: OBS
Observation.codeextensibleObservationType
Observation.statusCoderequiredActStatus
Observation.valuerequiredONC Administrative Sex

Constraints

IdGradePath(s)DetailsRequirements
4537-33040errorObservation.valueIf value/@code not from value set ONC Administrative Sex urn:oid:2.16.840.1.113762.1.4.1 STATIC 2016-06-01, then value/@nullFlavor SHALL be “UNK” (CONF:4537-33040).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 1..1CDAR2.ObservationXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @classCode, @moodCode, @negationInd, realmCode, typeId, templateId, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, referenceRange
Base for all types and resources
... @classCode 1..1csBinding: ActClassObservation (required)
Fixed Value: OBS
... @moodCode 1..1csFixed Value: EVN
... @negationInd 0..1bl
... realmCode 0..*CS
... typeId 0..1II
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:templateId1 1..1IItemplateId
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.200
..... @extension 1..1stRequired Pattern: 2023-05-01
... id 0..*II
... code 1..1CDBinding: ObservationType (extensible)
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @code 1..1csRequired Pattern: 76689-9
.... @codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.1
.... @codeSystemName 0..1st
.... @codeSystemVersion 0..1st
.... @displayName 0..1st
.... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
.... originalText 0..1ED
.... qualifier 0..*CR
.... translation 0..*CD
... derivationExpr 0..1ST
... text 0..1ED
... statusCode 1..1CSBinding: ActStatus (required)
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @code 1..1csFixed Value: completed
.... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
... effectiveTime 1..1IVL_TS
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @value 0..1tsDate Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz]
.... @operator 0..1csBinding: SetOperator (required)
.... low 1..1IVXB_TS
.... center 1..1TS
.... width 1..1PQ
.... high 1..1IVXB_TS
... priorityCode 0..1CEBinding: ActPriority (extensible)
... repeatNumber 0..1IVL_INT
... languageCode 0..1CSBinding: HumanLanguage (required)
... value C1..1CDBinding: ONC Administrative Sex (required)
4537-33040: If value/@code not from value set ONC Administrative Sex urn:oid:2.16.840.1.113762.1.4.1 STATIC 2016-06-01, then value/@nullFlavor SHALL be “UNK” (CONF:4537-33040).
... interpretationCode 0..*CEBinding: ObservationInterpretation (required)
... methodCode 0..*CEBinding: ObservationMethod (extensible)
... targetSiteCode 0..*CD
... subject 0..1Subject
... specimen 0..*Specimen
... performer 0..*Performer2
... author 0..*Author
... informant 0..*Informant
... participant 0..*Participant2
... entryRelationship 0..*EntryRelationship
... reference 0..*Reference
... precondition 0..*Precondition
... referenceRange 0..*InfrastructureRoot
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... @typeCode 0..1csBinding: ActRelationshipPertains (required)
Fixed Value: REFV
.... observationRange 1..1ObservationRange

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.classCoderequiredFixed Value: OBS
Observation.templateId:templateId1.nullFlavorrequiredNullFlavor
Observation.codeextensibleObservationType
Observation.code.nullFlavorrequiredNullFlavor
Observation.statusCoderequiredActStatus
Observation.statusCode.nullFlavorrequiredNullFlavor
Observation.effectiveTime.nullFlavorrequiredNullFlavor
Observation.effectiveTime.operatorrequiredSetOperator
Observation.priorityCodeextensibleActPriority
Observation.languageCoderequiredHumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066)
Observation.valuerequiredONC Administrative Sex
Observation.interpretationCoderequiredObservationInterpretation
Observation.methodCodeextensibleObservationMethod
Observation.referenceRange.nullFlavorrequiredNullFlavor
Observation.referenceRange.typeCoderequiredFixed Value: REFV

Constraints

IdGradePath(s)DetailsRequirements
4537-33040errorObservation.valueIf value/@code not from value set ONC Administrative Sex urn:oid:2.16.840.1.113762.1.4.1 STATIC 2016-06-01, then value/@nullFlavor SHALL be “UNK” (CONF:4537-33040).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

This structure is derived from CDAR2.Observation

Summary

Mandatory: 14 elements
Fixed Value: 3 elements

Slices

This structure defines the following Slices:

  • The element Observation.templateId is sliced based on the values of value:root, value:extension

Differential View

This structure is derived from CDAR2.Observation

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 1..1CDAR2.ObservationXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @classCode, @moodCode, @negationInd, realmCode, typeId, templateId, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, referenceRange
Base for all types and resources
... classCode 1..1csFixed Value: OBS
... moodCode 1..1csFixed Value: EVN
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:templateId1 1..1IItemplateId
..... root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.200
..... extension 1..1stRequired Pattern: 2023-05-01
.... code 1..1csRequired Pattern: 76689-9
.... codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.1
... statusCode 1..1CS
.... code 1..1csFixed Value: completed
... effectiveTime 1..1IVL_TS
.... low 1..1IVXB_TS
.... center 1..1TS
.... width 1..1PQ
.... high 1..1IVXB_TS
... value C1..1CDBinding: ONC Administrative Sex (required)
4537-33040: If value/@code not from value set ONC Administrative Sex urn:oid:2.16.840.1.113762.1.4.1 STATIC 2016-06-01, then value/@nullFlavor SHALL be “UNK” (CONF:4537-33040).

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Observation.valuerequiredONC Administrative Sex

Constraints

IdGradePath(s)DetailsRequirements
4537-33040errorObservation.valueIf value/@code not from value set ONC Administrative Sex urn:oid:2.16.840.1.113762.1.4.1 STATIC 2016-06-01, then value/@nullFlavor SHALL be “UNK” (CONF:4537-33040).
:

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 1..1CDAR2.ObservationXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @classCode, @moodCode, @negationInd, realmCode, typeId, templateId, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, referenceRange
Base for all types and resources
... @classCode 1..1csBinding: ActClassObservation (required)
Fixed Value: OBS
... @moodCode 1..1csFixed Value: EVN
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:templateId1 1..1IItemplateId
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.200
..... @extension 1..1stRequired Pattern: 2023-05-01
.... @code 1..1csRequired Pattern: 76689-9
.... @codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.1
... statusCode 1..1CSBinding: ActStatus (required)
.... @code 1..1csFixed Value: completed
... effectiveTime 1..1IVL_TS
.... low 1..1IVXB_TS
.... center 1..1TS
.... width 1..1PQ
.... high 1..1IVXB_TS
... value C1..1CDBinding: ONC Administrative Sex (required)
4537-33040: If value/@code not from value set ONC Administrative Sex urn:oid:2.16.840.1.113762.1.4.1 STATIC 2016-06-01, then value/@nullFlavor SHALL be “UNK” (CONF:4537-33040).

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.classCoderequiredFixed Value: OBS
Observation.codeextensibleObservationType
Observation.statusCoderequiredActStatus
Observation.valuerequiredONC Administrative Sex

Constraints

IdGradePath(s)DetailsRequirements
4537-33040errorObservation.valueIf value/@code not from value set ONC Administrative Sex urn:oid:2.16.840.1.113762.1.4.1 STATIC 2016-06-01, then value/@nullFlavor SHALL be “UNK” (CONF:4537-33040).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 1..1CDAR2.ObservationXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @classCode, @moodCode, @negationInd, realmCode, typeId, templateId, id, code, derivationExpr, text, statusCode, effectiveTime, priorityCode, repeatNumber, languageCode, value, interpretationCode, methodCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, referenceRange
Base for all types and resources
... @classCode 1..1csBinding: ActClassObservation (required)
Fixed Value: OBS
... @moodCode 1..1csFixed Value: EVN
... @negationInd 0..1bl
... realmCode 0..*CS
... typeId 0..1II
... Slices for templateId 1..*IISlice: Unordered, Open by value:root, value:extension
.... templateId:templateId1 1..1IItemplateId
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.200
..... @extension 1..1stRequired Pattern: 2023-05-01
... id 0..*II
... code 1..1CDBinding: ObservationType (extensible)
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @code 1..1csRequired Pattern: 76689-9
.... @codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.1
.... @codeSystemName 0..1st
.... @codeSystemVersion 0..1st
.... @displayName 0..1st
.... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
.... originalText 0..1ED
.... qualifier 0..*CR
.... translation 0..*CD
... derivationExpr 0..1ST
... text 0..1ED
... statusCode 1..1CSBinding: ActStatus (required)
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @code 1..1csFixed Value: completed
.... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
... effectiveTime 1..1IVL_TS
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @value 0..1tsDate Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz]
.... @operator 0..1csBinding: SetOperator (required)
.... low 1..1IVXB_TS
.... center 1..1TS
.... width 1..1PQ
.... high 1..1IVXB_TS
... priorityCode 0..1CEBinding: ActPriority (extensible)
... repeatNumber 0..1IVL_INT
... languageCode 0..1CSBinding: HumanLanguage (required)
... value C1..1CDBinding: ONC Administrative Sex (required)
4537-33040: If value/@code not from value set ONC Administrative Sex urn:oid:2.16.840.1.113762.1.4.1 STATIC 2016-06-01, then value/@nullFlavor SHALL be “UNK” (CONF:4537-33040).
... interpretationCode 0..*CEBinding: ObservationInterpretation (required)
... methodCode 0..*CEBinding: ObservationMethod (extensible)
... targetSiteCode 0..*CD
... subject 0..1Subject
... specimen 0..*Specimen
... performer 0..*Performer2
... author 0..*Author
... informant 0..*Informant
... participant 0..*Participant2
... entryRelationship 0..*EntryRelationship
... reference 0..*Reference
... precondition 0..*Precondition
... referenceRange 0..*InfrastructureRoot
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... realmCode 0..*CS
.... typeId 0..1II
.... templateId 0..*II
.... @typeCode 0..1csBinding: ActRelationshipPertains (required)
Fixed Value: REFV
.... observationRange 1..1ObservationRange

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Observation.classCoderequiredFixed Value: OBS
Observation.templateId:templateId1.nullFlavorrequiredNullFlavor
Observation.codeextensibleObservationType
Observation.code.nullFlavorrequiredNullFlavor
Observation.statusCoderequiredActStatus
Observation.statusCode.nullFlavorrequiredNullFlavor
Observation.effectiveTime.nullFlavorrequiredNullFlavor
Observation.effectiveTime.operatorrequiredSetOperator
Observation.priorityCodeextensibleActPriority
Observation.languageCoderequiredHumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066)
Observation.valuerequiredONC Administrative Sex
Observation.interpretationCoderequiredObservationInterpretation
Observation.methodCodeextensibleObservationMethod
Observation.referenceRange.nullFlavorrequiredNullFlavor
Observation.referenceRange.typeCoderequiredFixed Value: REFV

Constraints

IdGradePath(s)DetailsRequirements
4537-33040errorObservation.valueIf value/@code not from value set ONC Administrative Sex urn:oid:2.16.840.1.113762.1.4.1 STATIC 2016-06-01, then value/@nullFlavor SHALL be “UNK” (CONF:4537-33040).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

This structure is derived from CDAR2.Observation

Summary

Mandatory: 14 elements
Fixed Value: 3 elements

Slices

This structure defines the following Slices:

  • The element Observation.templateId is sliced based on the values of value:root, value:extension

 

Other representations of profile: CSV, Excel