Left: | Sex Observation (http://hl7.org/cda/us/ccda/StructureDefinition/SexObservation) |
Right: | Sex Observation (http://hl7.org/cda/us/ccda/StructureDefinition/SexObservation) |
Error | StructureDefinition.version | Values for version differ: '3.0.0' vs '4.0.0-ballot' |
Information | StructureDefinition.date | Values for date differ: '2024-05-18T00:16:25-05:00' vs '2024-11-21T20:34:36+00:00' |
Name | Value | Comments | |
---|---|---|---|
abstract | false | ||
baseDefinition | http://hl7.org/cda/stds/core/StructureDefinition/Observation | ||
copyright | |||
date | 2024-05-18T00:16:25-05:00 | 2024-11-21T20:34:36+00:00 |
|
description | This Sex Observation template is used to reflect the documentation of a person's sex. Systems choosing to record the source of information should include the Provenance participation. USCDI v3 includes a data element for sex, intended to support the exchange of a sex value that is not characterized as sex assigned at birth or birth sex. This version of the C-CDA companion guide supports USCDI Sex data element. Sex assigned at birth or birth sex must be recorded using the Birth Sex Observation which falls under the broader category of a 'Sex observation'. A Data Absent Reason (DAR) code value of 'asked-declined' may be used when a person has chosen not to disclose their sex. Future versions of the template may be informed by the content of the HL7 Cross Paradigm IG: Gender Harmony - Sex and Gender Representation, which may include additional guidance on this Sex observation and the relationship to administrative gender (administrativeGenderCode). It is recommended systems include the Sex Observation in the Social History section. | ||
experimental | |||
fhirVersion | 5.0.0 | ||
jurisdiction | |||
jurisdiction[0] | urn:iso:std:iso:3166#US | ||
kind | logical | ||
name | SexObservation | ||
publisher | Health Level Seven | ||
purpose | |||
status | draft | ||
title | Sex Observation | ||
type | http://hl7.org/cda/stds/core/StructureDefinition/Observation | ||
url | http://hl7.org/cda/us/ccda/StructureDefinition/SexObservation | ||
version | 3.0.0 | 4.0.0-ballot |
|
Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | R Type | R Description & Constraints | Comments |
---|---|---|---|---|---|---|---|---|---|
Observation | C | 1..1 | Observation | Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-text-ref-value: SHOULD contain text/reference/@value | C | 1..1 | Observation | Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-text-ref-value: SHOULD contain text/reference/@value | |
nullFlavor | 0..1 | ?? | Binding: ?? (required) | 0..1 | ?? | Binding: ?? (required) | |||
realmCode | 0..* | CS | 0..* | CS | |||||
typeId | 0..1 | II | 0..1 | II | |||||
nullFlavor | 0..1 | ?? | Binding: ?? (required) | 0..1 | ?? | Binding: ?? (required) | |||
assigningAuthorityName | 0..1 | ?? | 0..1 | ?? | |||||
displayable | 0..1 | ?? | 0..1 | ?? | |||||
root | 1..1 | ??, ??, ?? | Fixed Value: 2.16.840.1.113883.1.3 | 1..1 | ??, ??, ?? | Fixed Value: 2.16.840.1.113883.1.3 | |||
st-simple | 1..1 | string | Primitive Type string URL: http://hl7.org/cda/stds/core/StructureDefinition/st-simple | 1..1 | string | Primitive Type string URL: http://hl7.org/cda/stds/core/StructureDefinition/st-simple | |||
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |||
classCode | 1..1 | ?? | Binding: ?? (required) Fixed Value: OBS | 1..1 | ?? | Binding: ?? (required) Fixed Value: OBS | |||
moodCode | 1..1 | ?? | Binding: ?? (required) Fixed Value: EVN | 1..1 | ?? | Binding: ?? (required) Fixed Value: EVN | |||
negationInd | 0..1 | ?? | 0..1 | ?? | |||||
id | 0..* | II | 0..* | II | |||||
code | 1..1 | CD | Sex Binding: ?? (example) | 1..1 | CD | Sex Binding: ?? (example) | |||
nullFlavor | 0..1 | ?? | Binding: ?? (required) | 0..1 | ?? | Binding: ?? (required) | |||
code | 1..1 | ?? | Required Pattern: 46098-0 | 1..1 | ?? | Required Pattern: 46098-0 | |||
codeSystem | 1..1 | ??, ??, ?? | LOINC Required Pattern: 2.16.840.1.113883.6.1 | 1..1 | ??, ??, ?? | LOINC Required Pattern: 2.16.840.1.113883.6.1 | |||
codeSystemName | 0..1 | ?? | 0..1 | ?? | |||||
codeSystemVersion | 0..1 | ?? | 0..1 | ?? | |||||
displayName | 0..1 | ?? | 0..1 | ?? | |||||
sdtcValueSet | 0..1 | ?? | XML: valueSet (urn:hl7-org:sdtc) | 0..1 | ?? | XML: valueSet (urn:hl7-org:sdtc) | |||
sdtcValueSetVersion | 0..1 | ?? | XML: valueSetVersion (urn:hl7-org:sdtc) | 0..1 | ?? | XML: valueSetVersion (urn:hl7-org:sdtc) | |||
originalText | 0..1 | ED | 0..1 | ED | |||||
qualifier | 0..* | CR | 0..* | CR | |||||
translation | 0..* | CD | 0..* | CD | |||||
derivationExpr | 0..1 | ST | 0..1 | ST | |||||
text | 0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | 0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |||
nullFlavor | 0..1 | ?? | Binding: ?? (required) | 0..1 | ?? | Binding: ?? (required) | |||
compression | 0..1 | ?? | Binding: ?? (required) | 0..1 | ?? | Binding: ?? (required) | |||
integrityCheck | 0..1 | ?? | 0..1 | ?? | |||||
integrityCheckAlgorithm | 0..1 | ?? | Binding: ?? (required) | 0..1 | ?? | Binding: ?? (required) | |||
language | 0..1 | ?? | 0..1 | ?? | |||||
mediaType | 0..1 | ?? | Binding: ?? (example) | 0..1 | ?? | Binding: ?? (example) | |||
representation | 0..1 | ?? | Binding: ?? (required) | 0..1 | ?? | Binding: ?? (required) | |||
xmlText | 0..1 | ?? | Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string. | 0..1 | ?? | Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string. | |||
reference | C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative | C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative | |
thumbnail | 0..1 | ED | 0..1 | ED | |||||
statusCode | 1..1 | CS | Binding: ?? (required) | 1..1 | CS | Binding: ?? (required) | |||
nullFlavor | 0..1 | ?? | Binding: ?? (required) | 0..1 | ?? | Binding: ?? (required) | |||
code | 1..1 | ?? | Fixed Value: completed | 1..1 | ?? | Fixed Value: completed | |||
codeSystem | 0..0 | 0..0 | |||||||
codeSystemName | 0..0 | 0..0 | |||||||
codeSystemVersion | 0..0 | 0..0 | |||||||
displayName | 0..0 | 0..0 | |||||||
sdtcValueSet | 0..1 | ?? | XML: valueSet (urn:hl7-org:sdtc) | 0..1 | ?? | XML: valueSet (urn:hl7-org:sdtc) | |||
sdtcValueSetVersion | 0..1 | ?? | XML: valueSetVersion (urn:hl7-org:sdtc) | 0..1 | ?? | XML: valueSetVersion (urn:hl7-org:sdtc) | |||
originalText | 0..0 | 0..0 | |||||||
qualifier | 0..0 | 0..0 | |||||||
translation | 0..0 | 0..0 | |||||||
effectiveTime | C | 1..1 | IVL_TS | value-only: Interval fields SHALL not be present | C | 1..1 | IVL_TS | value-only: Interval fields SHALL NOT be present | |
nullFlavor | 0..1 | ?? | Binding: ?? (required) | 0..1 | ?? | Binding: ?? (required) | |||
value | 0..1 | ?? | value should be used instead of low/high Date Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz] | 0..1 | ?? | value should be used instead of low/high Date Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz] | |||
operator | 0..1 | ?? | Binding: ?? (required) | 0..1 | ?? | Binding: ?? (required) | |||
low | 0..1 | IVXB_TS | 0..1 | IVXB_TS | |||||
center | 0..1 | TS | 0..1 | TS | |||||
width | 0..1 | PQ | 0..1 | PQ | |||||
high | 0..1 | IVXB_TS | 0..1 | IVXB_TS | |||||
priorityCode | 0..1 | CE | Binding: ?? (example) | 0..1 | CE | Binding: ?? (example) | |||
repeatNumber | 0..1 | IVL_INT | 0..1 | IVL_INT | |||||
languageCode | 0..1 | CS | Binding: ?? (required) | 0..1 | CS | Binding: ?? (required) | |||
value | 1..1 | CD | 1..1 | CD | |||||
nullFlavor | 0..0 | 0..0 | |||||||
code | 1..1 | ?? | Binding: ?? (preferred) | 1..1 | ?? | Binding: ?? (preferred) | |||
codeSystem | 0..1 | ??, ??, ?? | 0..1 | ??, ??, ?? | |||||
codeSystemName | 0..1 | ?? | 0..1 | ?? | |||||
codeSystemVersion | 0..1 | ?? | 0..1 | ?? | |||||
displayName | 0..1 | ?? | 0..1 | ?? | |||||
sdtcValueSet | 0..1 | ?? | XML: valueSet (urn:hl7-org:sdtc) | 0..1 | ?? | XML: valueSet (urn:hl7-org:sdtc) | |||
sdtcValueSetVersion | 0..1 | ?? | XML: valueSetVersion (urn:hl7-org:sdtc) | 0..1 | ?? | XML: valueSetVersion (urn:hl7-org:sdtc) | |||
originalText | 0..1 | ED | 0..1 | ED | |||||
qualifier | 0..* | CR | 0..* | CR | |||||
translation | 0..* | CD | 0..* | CD | |||||
interpretationCode | 0..* | CE | Binding: ?? (required) | 0..* | CE | Binding: ?? (required) | |||
methodCode | 0..* | CE | Binding: ?? (example) | 0..* | CE | Binding: ?? (example) | |||
targetSiteCode | 0..* | CD | 0..* | CD | |||||
subject | 0..1 | Subject | 0..1 | Subject | |||||
specimen | 0..* | Specimen | 0..* | Specimen | |||||
performer | 0..* | Performer2 | 0..* | Performer2 | |||||
author | 0..* | Author | 0..* | Author | |||||
informant | 0..* | Informant | 0..* | Informant | |||||
participant | 0..* | Participant2 | 0..* | Participant2 | |||||
entryRelationship | 0..* | EntryRelationship | 0..* | EntryRelationship | |||||
reference | 0..* | Reference | 0..* | Reference | |||||
precondition | 0..* | Precondition | 0..* | Precondition | |||||
sdtcPrecondition2 | 0..* | Precondition2 | XML: precondition2 (urn:hl7-org:sdtc) | 0..* | Precondition2 | XML: precondition2 (urn:hl7-org:sdtc) | |||
referenceRange | 0..* | InfrastructureRoot | 0..* | InfrastructureRoot | |||||
nullFlavor | 0..1 | ?? | Binding: ?? (required) | 0..1 | ?? | Binding: ?? (required) | |||
realmCode | 0..* | CS | 0..* | CS | |||||
typeId | 0..1 | II | 0..1 | II | |||||
nullFlavor | 0..1 | ?? | Binding: ?? (required) | 0..1 | ?? | Binding: ?? (required) | |||
assigningAuthorityName | 0..1 | ?? | 0..1 | ?? | |||||
displayable | 0..1 | ?? | 0..1 | ?? | |||||
root | 1..1 | ??, ??, ?? | Fixed Value: 2.16.840.1.113883.1.3 | 1..1 | ??, ??, ?? | Fixed Value: 2.16.840.1.113883.1.3 | |||
st-simple | 1..1 | string | Primitive Type string URL: http://hl7.org/cda/stds/core/StructureDefinition/st-simple | 1..1 | string | Primitive Type string URL: http://hl7.org/cda/stds/core/StructureDefinition/st-simple | |||
templateId | 0..* | II | 0..* | II | |||||
typeCode | 0..1 | ?? | Binding: ?? (required) Fixed Value: REFV | 0..1 | ?? | Binding: ?? (required) Fixed Value: REFV | |||
observationRange | 1..1 | ObservationRange | 1..1 | ObservationRange | |||||
sdtcInFulfillmentOf1 | 0..* | InFulfillmentOf1 | XML: inFulfillmentOf1 (urn:hl7-org:sdtc) | 0..* | InFulfillmentOf1 | XML: inFulfillmentOf1 (urn:hl7-org:sdtc) | |||
sdtcCategory | 0..* | CD | XML: category (urn:hl7-org:sdtc) |
| |||||
Documentation for this format |