Left: | Gender Identity Observation (http://hl7.org/cda/us/ccda/StructureDefinition/GenderIdentityObservation) |
Right: | Gender Identity Observation (http://hl7.org/cda/us/ccda/StructureDefinition/GenderIdentityObservation) |
Error | StructureDefinition.version | Values for version differ: '3.0.0-ballot' vs '3.0.0' |
Information | StructureDefinition.date | Values for date differ: '2023-12-21T01:13:10+10:00' vs '2024-05-18T00:16:25-05:00' |
Information | StructureDefinition.short | Values for short differ: 'NOTE for PQ values: The base CDA R2.0 standard requires @unit to be drawn from UCUM, and best practice is to use case sensitive UCUM units' vs '(USCDI) Alcohol Use, Substance Use, SDOH Problems/Health Concerns' |
Information | StructureDefinition.comment | Values for comment differ: 'SHALL contain exactly one [1..1] value with @xsi:type='CD', where the code SHALL be selected from ValueSet Gender Identity USCDI core urn:oid:2.16.840.1.113762.1.4.1021.101 DYNAMIC (CONF:4537-1223).' vs 'SHOULD contain zero or one [0..1] value (CONF:4515-8559).' |
Name | Value | Comments | |
---|---|---|---|
abstract | false | ||
baseDefinition | http://hl7.org/cda/us/ccda/StructureDefinition/SocialHistoryObservation | ||
copyright | |||
date | 2023-12-21T01:13:10+10:00 | 2024-05-18T00:16:25-05:00 |
|
description | This observation represents the gender identity of the patient, defined as: > "Ones basic sense of being male, female, or other gender (for example, transgender or gender queer). Gender identity can be congruent or incongruent with ones sex assigned at birth based on the appearance of external genitalia. (Advancing Effective Communication, Cultural Competence, and Patient- and Family-Centered Care for the Lesbian, Gay, Bisexual, and Transgender (LGBT) CommunityA Field Guide, The Joint Commission (2011).) This template follows the guidelines from the HL7 Gender Harmony project. This template is based on C-CDA Social History Observation template. This observation is not appropriate for recording patient gender (administrativeGender) or birth sex. | This observation represents the gender identity of the patient. Defined as: > "Ones basic sense of being male, female, or other gender (for example, transgender or gender queer). Gender identity can be congruent or incongruent with ones sex assigned at birth based on the appearance of external genitalia. (Advancing Effective Communication, Cultural Competence, and Patient- and Family-Centered Care for the Lesbian, Gay, Bisexual, and Transgender (LGBT) CommunityA Field Guide, The Joint Commission (2011).) This template follows the guidelines from the HL7 Gender Harmony project. This template is based on C-CDA Social History Observation template. This observation is not appropriate for recording patient gender (administrativeGender) or birth sex. |
|
experimental | |||
fhirVersion | 5.0.0 | ||
jurisdiction | |||
jurisdiction[0] | urn:iso:std:iso:3166#US | ||
kind | logical | ||
name | GenderIdentityObservation | ||
publisher | Health Level Seven | ||
purpose | |||
status | draft | ||
title | Gender Identity Observation | ||
type | http://hl7.org/cda/stds/core/StructureDefinition/Observation | ||
url | http://hl7.org/cda/us/ccda/StructureDefinition/GenderIdentityObservation | ||
version | 3.0.0-ballot | 3.0.0 |
|
Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | R Type | R Description & Constraints | Comments | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Observation | C | 1..1 | SocialHistoryObservation | 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 should-value: SHOULD contain value 4515-8555: If Observation/value is a physical quantity (xsi:type="PQ"): This value SHALL contain exactly one [1..1] @unit, which SHOULD be selected from ValueSet UnitsOfMeasureCaseSensitive urn:oid:2.16.840.1.113883.1.11.12839 DYNAMIC. Note: Base CDA requires that all @unit values SHALL be drawn from UCUM. should-sh-author: SHOULD contain author | C | 1..1 | SocialHistoryObservation | 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 should-value: SHOULD contain value 4515-8555: If Observation/value is a physical quantity (xsi:type="PQ"): This value SHALL contain exactly one [1..1] @unit, which SHOULD be selected from ValueSet UnitsOfMeasureCaseSensitive urn:oid:2.16.840.1.113883.1.11.12839 DYNAMIC. Note: Base CDA requires that all @unit values SHALL be drawn from UCUM. should-sh-author: SHOULD contain author | |||||||
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 | 2..* | II | Slice: Unordered, Open by value:root, value:extension | 2..* | 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 | 1..* | II | 1..* | II | |||||||||||
code | C | 1..1 | CD | Binding: ?? (preferred) 4515-32956: If @codeSystem is not LOINC, then this code **SHALL** contain at least one [1..*] translation, which **SHOULD** be selected from CodeSystem LOINC (urn:oid:2.16.840.1.113883.6.1) (CONF:4515-32956). | C | 1..1 | CD | Gender Identity Binding: ?? (preferred) 4515-32956: If @codeSystem is not LOINC, then this code **SHALL** contain at least one [1..*] translation, which **SHOULD** be selected from CodeSystem LOINC (urn:oid:2.16.840.1.113883.6.1) (CONF:4515-32956). | |||||||
nullFlavor | 0..1 | ?? | Binding: ?? (required) | 0..1 | ?? | Binding: ?? (required) | |||||||||
code | 1..1 | ?? | Required Pattern: 76691-5 | 1..1 | ?? | Required Pattern: 76691-5 | |||||||||
codeSystem | 1..1 | ??, ??, ?? | Required Pattern: 2.16.840.1.113883.6.1 | 1..1 | ??, ??, ?? | 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 | 1..1 | IVL_TS | The effectiveTime represents the relevant time of the observation. A patient's "gender identity" may change and using effectiveTime/low and effectiveTime/high defines the time during which the patient had identified as specified. | 1..1 | IVL_TS | The effectiveTime represents the relevant time of the observation. A patient's "gender identity" may change and using effectiveTime/low and effectiveTime/high defines the time during which the patient had identified as specified. | |||||||||
nullFlavor | 0..1 | ?? | Binding: ?? (required) | 0..1 | ?? | Binding: ?? (required) | |||||||||
value | 0..1 | ?? | Date Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz] | 0..1 | ?? | Date Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz] | |||||||||
operator | 0..1 | ?? | Binding: ?? (required) | 0..1 | ?? | Binding: ?? (required) | |||||||||
low | 1..1 | IVXB_TS | 1..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 | NOTE for PQ values: The base CDA R2.0 standard requires @unit to be drawn from UCUM, and best practice is to use case sensitive UCUM units Binding: ?? (required)
| 1..1 | ANY, BL, ED, ST, CD, CV, CE, CO, SC, II, TEL, AD, EN, INT, REAL, PQ, MO, TS, IVL_PQ, IVL_TS, PIVL_TS, EIVL_TS, SXPR_TS, RTO_PQ_PQ | (USCDI) Alcohol Use, Substance Use, SDOH Problems/Health Concerns Slice: Unordered, Open by type:$this | |||||||||
nullFlavor | 0..1 | ?? | To represent additional Gender Identities, set nullFlavor="OTH". To represent "choose not to disclose", set nullFlavor="ASKU". Binding: ?? (required)
|
| |||||||||||
code | 0..1 | ?? |
| ||||||||||||
codeSystem | 0..1 | ??, ??, ?? |
| ||||||||||||
codeSystemName | 0..1 | ?? |
| ||||||||||||
codeSystemVersion | 0..1 | ?? |
| ||||||||||||
displayName | 0..1 | ?? |
| ||||||||||||
sdtcValueSet | 0..1 | ?? | XML: valueSet (urn:hl7-org:sdtc) |
| |||||||||||
sdtcValueSetVersion | 0..1 | ?? | XML: valueSetVersion (urn:hl7-org:sdtc) |
| |||||||||||
originalText | 0..1 | ED |
| ||||||||||||
qualifier | 0..* | CR |
| ||||||||||||
translation | 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..* | ?? | Base for all types and resources | 0..* | ?? | Base for all types and resources | |||||||||
informant | 0..* | Informant | 0..* | Informant | |||||||||||
participant | 0..* | Participant2 | 0..* | Participant2 | |||||||||||
Slices for entryRelationship | 0..* | EntryRelationship | Slice: Unordered, Open by profile:act, profile:observation | 0..* | EntryRelationship | Slice: Unordered, Open by profile:act, profile:observation | |||||||||
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) | |||||||||
Documentation for this format |