Common Data Element Katalog
0.2.0 - CI Build International flag

Common Data Element Katalog - Local Development build (v0.2.0). See the Directory of published versions

Resource Profile: CV Biological Sex ( Abstract )

Official URL: http://hl7.org/de/StructureDefinition/cv-biological-sex Version: 0.2.0
Standards status: Informative Maturity Level: 1 Computable Name: CV_BiologicalSex

Das biologische Geschlecht einer Person.

Usage:

  • This Resource Profile 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 C_BiologicalSex

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*C_BiologicalSexThis is an abstract profile.
Measurements and simple assertions
... category 6..*CodeableConceptClassification of type of observation
... category:Persons S1..1CodeableConceptClassification of type of observation
.... coding 1..*CodingCode defined by a terminology system
..... system 1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
..... code 1..1codeSymbol in syntax defined by the system
Fixed Value: 125676002
... category:NominalScale S1..1CodeableConceptClassification of type of observation
.... coding 1..*CodingCode defined by a terminology system
..... system 1..1uriIdentity of the terminology system
Fixed Value: http://www.nlm.nih.gov/research/umls
..... code 1..1codeSymbol in syntax defined by the system
Fixed Value: C1711339
... component
.... valueCodeableConcept S0..1CodeableConceptActual component result
Binding: Biological sex types (required)
.... dataAbsentReason S0..1CodeableConceptWhy the component result is missing
Binding: Reasons for missing data (sentinel) (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Observation.component.valueCodeableConceptrequiredVS_BiologicalGender
Observation.component.dataAbsentReasonrequiredVS_SentinelConceptualDomain
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*C_BiologicalSexThis is an abstract profile.
Measurements and simple assertions
... implicitRules ?!ΣN0..1uriA set of rules under which this content was created
... modifierExtension ?!N0..*ExtensionExtensions that cannot be ignored
Slice: Unordered, Open by value:url
... status ?!ΣN1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.

.... category:Gender_UMLS S1..1CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


..... coding Σ1..*CodingCode defined by a terminology system
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://www.nlm.nih.gov/research/umls
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: C0079399
.... category:Gender_SNOMED S1..1CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


..... coding Σ1..*CodingCode defined by a terminology system
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: 263495000
.... category:BiologicalSex_UMLS S1..1CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


..... coding Σ1..*CodingCode defined by a terminology system
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://www.nlm.nih.gov/research/umls
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: C1522384
.... category:BiologicalSex_SNOMED S1..1CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


..... coding Σ1..*CodingCode defined by a terminology system
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: 734000001
.... category:Persons S1..1CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


..... coding Σ1..*CodingCode defined by a terminology system
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: 125676002
.... category:NominalScale S1..1CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


..... coding Σ1..*CodingCode defined by a terminology system
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://www.nlm.nih.gov/research/umls
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: C1711339
... code ΣN1..1CodeableConceptType of observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

... Slices for value[x] ΣC0..1Actual result
Slice: Unordered, Open by type:$this
.... valueQuantityQuantity
.... valueCodeableConceptCodeableConcept
.... valueStringstring
.... valueBooleanboolean
.... valueIntegerinteger
.... valueRangeRange
.... valueRatioRatio
.... valueSampledDataSampledData
.... valueTimetime
.... valueDateTimedateTime
.... valuePeriodPeriod
... dataAbsentReason CN0..1CodeableConceptWhy the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

... component ΣN0..*BackboneElementComponent results
.... modifierExtension ?!ΣN0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code ΣN1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

.... Slices for value[x] Σ0..1Actual component result
Slice: Unordered, Open by type:$this
..... valueQuantityQuantity
..... valueCodeableConceptCodeableConcept
..... valueStringstring
..... valueBooleanboolean
..... valueIntegerinteger
..... valueRangeRange
..... valueRatioRatio
..... valueSampledDataSampledData
..... valueTimetime
..... valueDateTimedateTime
..... valuePeriodPeriod
..... value[x]:valueCodeableConcept SΣ0..1CodeableConceptActual component result
Binding: Biological sex types (required)
.... dataAbsentReason SC0..1CodeableConceptWhy the component result is missing
Binding: Reasons for missing data (sentinel) (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Observation.statusrequiredObservationStatus
Observation.categorypreferredObservationCategoryCodes
Observation.category:Gender_UMLSpreferredObservationCategoryCodes
Observation.category:Gender_SNOMEDpreferredObservationCategoryCodes
Observation.category:BiologicalSex_UMLSpreferredObservationCategoryCodes
Observation.category:BiologicalSex_SNOMEDpreferredObservationCategoryCodes
Observation.category:PersonspreferredObservationCategoryCodes
Observation.category:NominalScalepreferredObservationCategoryCodes
Observation.codeexampleLOINCCodes (a valid code from LOINC)
Observation.dataAbsentReasonextensibleDataAbsentReason
Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
Observation.component.value[x]:valueCodeableConceptrequiredVS_BiologicalGender
Observation.component.dataAbsentReasonrequiredVS_SentinelConceptualDomain

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorObservationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorObservationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceObservationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** elementsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
obs-6errorObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorObservationIf Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
: value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*C_BiologicalSexThis is an abstract profile.
Measurements and simple assertions
... id Σ0..1idLogical id of this artifact
... meta ΣN0..1MetaMetadata about the resource
... implicitRules ?!ΣN0..1uriA set of rules under which this content was created
... language N0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text N0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... modifierExtension ?!N0..*ExtensionExtensions that cannot be ignored
Slice: Unordered, Open by value:url
... identifier ΣN0..*IdentifierBusiness Identifier for observation
... basedOn ΣCN0..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)Fulfills plan, proposal or order
... partOf ΣCN0..*Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy)Part of referenced event
... status ?!ΣN1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.

... Slices for category 6..*CodeableConceptClassification of type of observation
Slice: Unordered, Open At End by value:coding.code
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


.... category:Gender_UMLS S1..1CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


..... id 0..1stringUnique id for inter-element referencing
..... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ1..*CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://www.nlm.nih.gov/research/umls
...... version ΣN0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: C0079399
...... display ΣN0..1stringRepresentation defined by the system
...... userSelected ΣN0..1booleanIf this coding was chosen directly by the user
..... text ΣN0..1stringPlain text representation of the concept
.... category:Gender_SNOMED S1..1CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


..... id 0..1stringUnique id for inter-element referencing
..... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ1..*CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... version ΣN0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: 263495000
...... display ΣN0..1stringRepresentation defined by the system
...... userSelected ΣN0..1booleanIf this coding was chosen directly by the user
..... text ΣN0..1stringPlain text representation of the concept
.... category:BiologicalSex_UMLS S1..1CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


..... id 0..1stringUnique id for inter-element referencing
..... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ1..*CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://www.nlm.nih.gov/research/umls
...... version ΣN0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: C1522384
...... display ΣN0..1stringRepresentation defined by the system
...... userSelected ΣN0..1booleanIf this coding was chosen directly by the user
..... text ΣN0..1stringPlain text representation of the concept
.... category:BiologicalSex_SNOMED S1..1CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


..... id 0..1stringUnique id for inter-element referencing
..... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ1..*CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... version ΣN0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: 734000001
...... display ΣN0..1stringRepresentation defined by the system
...... userSelected ΣN0..1booleanIf this coding was chosen directly by the user
..... text ΣN0..1stringPlain text representation of the concept
.... category:Persons S1..1CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


..... id 0..1stringUnique id for inter-element referencing
..... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ1..*CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... version ΣN0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: 125676002
...... display ΣN0..1stringRepresentation defined by the system
...... userSelected ΣN0..1booleanIf this coding was chosen directly by the user
..... text ΣN0..1stringPlain text representation of the concept
.... category:NominalScale S1..1CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


..... id 0..1stringUnique id for inter-element referencing
..... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ1..*CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://www.nlm.nih.gov/research/umls
...... version ΣN0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: C1711339
...... display ΣN0..1stringRepresentation defined by the system
...... userSelected ΣN0..1booleanIf this coding was chosen directly by the user
..... text ΣN0..1stringPlain text representation of the concept
... code ΣN1..1CodeableConceptType of observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

... subject ΣCN0..1Reference(Patient | Group | Device | Location)Who and/or what the observation is about
... focus ΣCTU0..*Reference(Resource)What the observation is about, when it is not about the subject of record
... encounter ΣCN0..1Reference(Encounter)Healthcare event during which this observation is made
... effective[x] ΣN0..1Clinically relevant time/time-period for observation
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
.... effectiveTimingTiming
.... effectiveInstantinstant
... issued ΣN0..1instantDate/Time this version was made available
... performer ΣCN0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson)Who is responsible for the observation
... Slices for value[x] ΣC0..1Actual result
Slice: Unordered, Open by type:$this
.... valueQuantityQuantity
.... valueCodeableConceptCodeableConcept
.... valueStringstring
.... valueBooleanboolean
.... valueIntegerinteger
.... valueRangeRange
.... valueRatioRatio
.... valueSampledDataSampledData
.... valueTimetime
.... valueDateTimedateTime
.... valuePeriodPeriod
... dataAbsentReason CN0..1CodeableConceptWhy the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

... interpretation N0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


... note N0..*AnnotationComments about the observation
... bodySite N0..1CodeableConceptObserved body part
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.

... method N0..1CodeableConceptHow it was done
Binding: ObservationMethods (example): Methods for simple observations.

... specimen CN0..1Reference(Specimen)Specimen used for this observation
... device CN0..1Reference(Device | DeviceMetric)(Measurement) Device
... referenceRange CN0..*BackboneElementProvides guide for interpretation
.... id 0..1stringUnique id for inter-element referencing
.... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!ΣN0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... low CN0..1SimpleQuantityLow Range, if relevant
.... high CN0..1SimpleQuantityHigh Range, if relevant
.... type N0..1CodeableConceptReference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.

.... appliesTo N0..*CodeableConceptReference range population
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.


.... age CN0..1RangeApplicable age range, if relevant
.... text N0..1stringText based reference range in an observation
... hasMember ΣCN0..*Reference(Observation | QuestionnaireResponse | MolecularSequence)Related resource that belongs to the Observation group
... derivedFrom ΣCN0..*Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence)Related measurements the observation is made from
... component ΣN0..*BackboneElementComponent results
.... id 0..1stringUnique id for inter-element referencing
.... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!ΣN0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code ΣN1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

.... Slices for value[x] Σ0..1Actual component result
Slice: Unordered, Open by type:$this
..... valueQuantityQuantity
..... valueCodeableConceptCodeableConcept
..... valueStringstring
..... valueBooleanboolean
..... valueIntegerinteger
..... valueRangeRange
..... valueRatioRatio
..... valueSampledDataSampledData
..... valueTimetime
..... valueDateTimedateTime
..... valuePeriodPeriod
..... value[x]:valueCodeableConcept SΣ0..1CodeableConceptActual component result
Binding: Biological sex types (required)
.... dataAbsentReason SC0..1CodeableConceptWhy the component result is missing
Binding: Reasons for missing data (sentinel) (required)
.... interpretation N0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


.... referenceRange 0..*See referenceRange (Observation)Provides guide for interpretation of component result

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Observation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Observation.statusrequiredObservationStatus
Observation.categorypreferredObservationCategoryCodes
Observation.category:Gender_UMLSpreferredObservationCategoryCodes
Observation.category:Gender_SNOMEDpreferredObservationCategoryCodes
Observation.category:BiologicalSex_UMLSpreferredObservationCategoryCodes
Observation.category:BiologicalSex_SNOMEDpreferredObservationCategoryCodes
Observation.category:PersonspreferredObservationCategoryCodes
Observation.category:NominalScalepreferredObservationCategoryCodes
Observation.codeexampleLOINCCodes (a valid code from LOINC)
Observation.dataAbsentReasonextensibleDataAbsentReason
Observation.interpretationextensibleObservationInterpretationCodes
Observation.bodySiteexampleSNOMEDCTBodyStructures
Observation.methodexampleObservationMethods
Observation.referenceRange.typepreferredObservationReferenceRangeMeaningCodes
Observation.referenceRange.appliesToexampleObservationReferenceRangeAppliesToCodes
Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
Observation.component.value[x]:valueCodeableConceptrequiredVS_BiologicalGender
Observation.component.dataAbsentReasonrequiredVS_SentinelConceptualDomain
Observation.component.interpretationextensibleObservationInterpretationCodes

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** elementsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
obs-3errorObservation.referenceRangeMust have at least a low or a high or text
: low.exists() or high.exists() or text.exists()
qty-3errorObservation.referenceRange.low, Observation.referenceRange.highIf a code for the unit is present, the system SHALL also be present
: code.empty() or system.exists()
ref-1errorObservation.basedOn, Observation.partOf, Observation.subject, Observation.focus, Observation.encounter, Observation.performer, Observation.specimen, Observation.device, Observation.hasMember, Observation.derivedFromSHALL have a contained resource if a local reference is provided
: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
rng-2errorObservation.referenceRange.ageIf present, low SHALL have a lower value than high
: low.empty() or high.empty() or (low <= high)
sqty-1errorObservation.referenceRange.low, Observation.referenceRange.highThe comparator is not used on a SimpleQuantity
: comparator.empty()

This structure is derived from C_BiologicalSex

Summary

Mandatory: 8 elements
Must-Support: 4 elements
Fixed Value: 4 elements
Prohibited: 1 element

Maturity: 1

Differential View

This structure is derived from C_BiologicalSex

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 0..*C_BiologicalSexThis is an abstract profile.
Measurements and simple assertions
... category 6..*CodeableConceptClassification of type of observation
... category:Persons S1..1CodeableConceptClassification of type of observation
.... coding 1..*CodingCode defined by a terminology system
..... system 1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
..... code 1..1codeSymbol in syntax defined by the system
Fixed Value: 125676002
... category:NominalScale S1..1CodeableConceptClassification of type of observation
.... coding 1..*CodingCode defined by a terminology system
..... system 1..1uriIdentity of the terminology system
Fixed Value: http://www.nlm.nih.gov/research/umls
..... code 1..1codeSymbol in syntax defined by the system
Fixed Value: C1711339
... component
.... valueCodeableConcept S0..1CodeableConceptActual component result
Binding: Biological sex types (required)
.... dataAbsentReason S0..1CodeableConceptWhy the component result is missing
Binding: Reasons for missing data (sentinel) (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Observation.component.valueCodeableConceptrequiredVS_BiologicalGender
Observation.component.dataAbsentReasonrequiredVS_SentinelConceptualDomain

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*C_BiologicalSexThis is an abstract profile.
Measurements and simple assertions
... implicitRules ?!ΣN0..1uriA set of rules under which this content was created
... modifierExtension ?!N0..*ExtensionExtensions that cannot be ignored
Slice: Unordered, Open by value:url
... status ?!ΣN1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.

.... category:Gender_UMLS S1..1CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


..... coding Σ1..*CodingCode defined by a terminology system
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://www.nlm.nih.gov/research/umls
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: C0079399
.... category:Gender_SNOMED S1..1CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


..... coding Σ1..*CodingCode defined by a terminology system
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: 263495000
.... category:BiologicalSex_UMLS S1..1CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


..... coding Σ1..*CodingCode defined by a terminology system
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://www.nlm.nih.gov/research/umls
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: C1522384
.... category:BiologicalSex_SNOMED S1..1CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


..... coding Σ1..*CodingCode defined by a terminology system
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: 734000001
.... category:Persons S1..1CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


..... coding Σ1..*CodingCode defined by a terminology system
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: 125676002
.... category:NominalScale S1..1CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


..... coding Σ1..*CodingCode defined by a terminology system
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://www.nlm.nih.gov/research/umls
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: C1711339
... code ΣN1..1CodeableConceptType of observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

... Slices for value[x] ΣC0..1Actual result
Slice: Unordered, Open by type:$this
.... valueQuantityQuantity
.... valueCodeableConceptCodeableConcept
.... valueStringstring
.... valueBooleanboolean
.... valueIntegerinteger
.... valueRangeRange
.... valueRatioRatio
.... valueSampledDataSampledData
.... valueTimetime
.... valueDateTimedateTime
.... valuePeriodPeriod
... dataAbsentReason CN0..1CodeableConceptWhy the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

... component ΣN0..*BackboneElementComponent results
.... modifierExtension ?!ΣN0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code ΣN1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

.... Slices for value[x] Σ0..1Actual component result
Slice: Unordered, Open by type:$this
..... valueQuantityQuantity
..... valueCodeableConceptCodeableConcept
..... valueStringstring
..... valueBooleanboolean
..... valueIntegerinteger
..... valueRangeRange
..... valueRatioRatio
..... valueSampledDataSampledData
..... valueTimetime
..... valueDateTimedateTime
..... valuePeriodPeriod
..... value[x]:valueCodeableConcept SΣ0..1CodeableConceptActual component result
Binding: Biological sex types (required)
.... dataAbsentReason SC0..1CodeableConceptWhy the component result is missing
Binding: Reasons for missing data (sentinel) (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Observation.statusrequiredObservationStatus
Observation.categorypreferredObservationCategoryCodes
Observation.category:Gender_UMLSpreferredObservationCategoryCodes
Observation.category:Gender_SNOMEDpreferredObservationCategoryCodes
Observation.category:BiologicalSex_UMLSpreferredObservationCategoryCodes
Observation.category:BiologicalSex_SNOMEDpreferredObservationCategoryCodes
Observation.category:PersonspreferredObservationCategoryCodes
Observation.category:NominalScalepreferredObservationCategoryCodes
Observation.codeexampleLOINCCodes (a valid code from LOINC)
Observation.dataAbsentReasonextensibleDataAbsentReason
Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
Observation.component.value[x]:valueCodeableConceptrequiredVS_BiologicalGender
Observation.component.dataAbsentReasonrequiredVS_SentinelConceptualDomain

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorObservationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorObservationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorObservationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceObservationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** elementsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
obs-6errorObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7errorObservationIf Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
: value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C0..*C_BiologicalSexThis is an abstract profile.
Measurements and simple assertions
... id Σ0..1idLogical id of this artifact
... meta ΣN0..1MetaMetadata about the resource
... implicitRules ?!ΣN0..1uriA set of rules under which this content was created
... language N0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text N0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... modifierExtension ?!N0..*ExtensionExtensions that cannot be ignored
Slice: Unordered, Open by value:url
... identifier ΣN0..*IdentifierBusiness Identifier for observation
... basedOn ΣCN0..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)Fulfills plan, proposal or order
... partOf ΣCN0..*Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy)Part of referenced event
... status ?!ΣN1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required): Codes providing the status of an observation.

... Slices for category 6..*CodeableConceptClassification of type of observation
Slice: Unordered, Open At End by value:coding.code
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


.... category:Gender_UMLS S1..1CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


..... id 0..1stringUnique id for inter-element referencing
..... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ1..*CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://www.nlm.nih.gov/research/umls
...... version ΣN0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: C0079399
...... display ΣN0..1stringRepresentation defined by the system
...... userSelected ΣN0..1booleanIf this coding was chosen directly by the user
..... text ΣN0..1stringPlain text representation of the concept
.... category:Gender_SNOMED S1..1CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


..... id 0..1stringUnique id for inter-element referencing
..... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ1..*CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... version ΣN0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: 263495000
...... display ΣN0..1stringRepresentation defined by the system
...... userSelected ΣN0..1booleanIf this coding was chosen directly by the user
..... text ΣN0..1stringPlain text representation of the concept
.... category:BiologicalSex_UMLS S1..1CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


..... id 0..1stringUnique id for inter-element referencing
..... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ1..*CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://www.nlm.nih.gov/research/umls
...... version ΣN0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: C1522384
...... display ΣN0..1stringRepresentation defined by the system
...... userSelected ΣN0..1booleanIf this coding was chosen directly by the user
..... text ΣN0..1stringPlain text representation of the concept
.... category:BiologicalSex_SNOMED S1..1CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


..... id 0..1stringUnique id for inter-element referencing
..... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ1..*CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... version ΣN0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: 734000001
...... display ΣN0..1stringRepresentation defined by the system
...... userSelected ΣN0..1booleanIf this coding was chosen directly by the user
..... text ΣN0..1stringPlain text representation of the concept
.... category:Persons S1..1CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


..... id 0..1stringUnique id for inter-element referencing
..... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ1..*CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... version ΣN0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: 125676002
...... display ΣN0..1stringRepresentation defined by the system
...... userSelected ΣN0..1booleanIf this coding was chosen directly by the user
..... text ΣN0..1stringPlain text representation of the concept
.... category:NominalScale S1..1CodeableConceptClassification of type of observation
Binding: ObservationCategoryCodes (preferred): Codes for high level observation categories.


..... id 0..1stringUnique id for inter-element referencing
..... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ1..*CodingCode defined by a terminology system
...... id 0..1stringUnique id for inter-element referencing
...... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ1..1uriIdentity of the terminology system
Fixed Value: http://www.nlm.nih.gov/research/umls
...... version ΣN0..1stringVersion of the system - if relevant
...... code Σ1..1codeSymbol in syntax defined by the system
Fixed Value: C1711339
...... display ΣN0..1stringRepresentation defined by the system
...... userSelected ΣN0..1booleanIf this coding was chosen directly by the user
..... text ΣN0..1stringPlain text representation of the concept
... code ΣN1..1CodeableConceptType of observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

... subject ΣCN0..1Reference(Patient | Group | Device | Location)Who and/or what the observation is about
... focus ΣCTU0..*Reference(Resource)What the observation is about, when it is not about the subject of record
... encounter ΣCN0..1Reference(Encounter)Healthcare event during which this observation is made
... effective[x] ΣN0..1Clinically relevant time/time-period for observation
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
.... effectiveTimingTiming
.... effectiveInstantinstant
... issued ΣN0..1instantDate/Time this version was made available
... performer ΣCN0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson)Who is responsible for the observation
... Slices for value[x] ΣC0..1Actual result
Slice: Unordered, Open by type:$this
.... valueQuantityQuantity
.... valueCodeableConceptCodeableConcept
.... valueStringstring
.... valueBooleanboolean
.... valueIntegerinteger
.... valueRangeRange
.... valueRatioRatio
.... valueSampledDataSampledData
.... valueTimetime
.... valueDateTimedateTime
.... valuePeriodPeriod
... dataAbsentReason CN0..1CodeableConceptWhy the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

... interpretation N0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


... note N0..*AnnotationComments about the observation
... bodySite N0..1CodeableConceptObserved body part
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.

... method N0..1CodeableConceptHow it was done
Binding: ObservationMethods (example): Methods for simple observations.

... specimen CN0..1Reference(Specimen)Specimen used for this observation
... device CN0..1Reference(Device | DeviceMetric)(Measurement) Device
... referenceRange CN0..*BackboneElementProvides guide for interpretation
.... id 0..1stringUnique id for inter-element referencing
.... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!ΣN0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... low CN0..1SimpleQuantityLow Range, if relevant
.... high CN0..1SimpleQuantityHigh Range, if relevant
.... type N0..1CodeableConceptReference range qualifier
Binding: ObservationReferenceRangeMeaningCodes (preferred): Code for the meaning of a reference range.

.... appliesTo N0..*CodeableConceptReference range population
Binding: ObservationReferenceRangeAppliesToCodes (example): Codes identifying the population the reference range applies to.


.... age CN0..1RangeApplicable age range, if relevant
.... text N0..1stringText based reference range in an observation
... hasMember ΣCN0..*Reference(Observation | QuestionnaireResponse | MolecularSequence)Related resource that belongs to the Observation group
... derivedFrom ΣCN0..*Reference(DocumentReference | ImagingStudy | Media | QuestionnaireResponse | Observation | MolecularSequence)Related measurements the observation is made from
... component ΣN0..*BackboneElementComponent results
.... id 0..1stringUnique id for inter-element referencing
.... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!ΣN0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code ΣN1..1CodeableConceptType of component observation (code / type)
Binding: LOINCCodes (example): Codes identifying names of simple observations.

.... Slices for value[x] Σ0..1Actual component result
Slice: Unordered, Open by type:$this
..... valueQuantityQuantity
..... valueCodeableConceptCodeableConcept
..... valueStringstring
..... valueBooleanboolean
..... valueIntegerinteger
..... valueRangeRange
..... valueRatioRatio
..... valueSampledDataSampledData
..... valueTimetime
..... valueDateTimedateTime
..... valuePeriodPeriod
..... value[x]:valueCodeableConcept SΣ0..1CodeableConceptActual component result
Binding: Biological sex types (required)
.... dataAbsentReason SC0..1CodeableConceptWhy the component result is missing
Binding: Reasons for missing data (sentinel) (required)
.... interpretation N0..*CodeableConceptHigh, low, normal, etc.
Binding: ObservationInterpretationCodes (extensible): Codes identifying interpretations of observations.


.... referenceRange 0..*See referenceRange (Observation)Provides guide for interpretation of component result

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Observation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Observation.statusrequiredObservationStatus
Observation.categorypreferredObservationCategoryCodes
Observation.category:Gender_UMLSpreferredObservationCategoryCodes
Observation.category:Gender_SNOMEDpreferredObservationCategoryCodes
Observation.category:BiologicalSex_UMLSpreferredObservationCategoryCodes
Observation.category:BiologicalSex_SNOMEDpreferredObservationCategoryCodes
Observation.category:PersonspreferredObservationCategoryCodes
Observation.category:NominalScalepreferredObservationCategoryCodes
Observation.codeexampleLOINCCodes (a valid code from LOINC)
Observation.dataAbsentReasonextensibleDataAbsentReason
Observation.interpretationextensibleObservationInterpretationCodes
Observation.bodySiteexampleSNOMEDCTBodyStructures
Observation.methodexampleObservationMethods
Observation.referenceRange.typepreferredObservationReferenceRangeMeaningCodes
Observation.referenceRange.appliesToexampleObservationReferenceRangeAppliesToCodes
Observation.component.codeexampleLOINCCodes (a valid code from LOINC)
Observation.component.value[x]:valueCodeableConceptrequiredVS_BiologicalGender
Observation.component.dataAbsentReasonrequiredVS_SentinelConceptualDomain
Observation.component.interpretationextensibleObservationInterpretationCodes

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** elementsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
obs-3errorObservation.referenceRangeMust have at least a low or a high or text
: low.exists() or high.exists() or text.exists()
qty-3errorObservation.referenceRange.low, Observation.referenceRange.highIf a code for the unit is present, the system SHALL also be present
: code.empty() or system.exists()
ref-1errorObservation.basedOn, Observation.partOf, Observation.subject, Observation.focus, Observation.encounter, Observation.performer, Observation.specimen, Observation.device, Observation.hasMember, Observation.derivedFromSHALL have a contained resource if a local reference is provided
: reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
rng-2errorObservation.referenceRange.ageIf present, low SHALL have a lower value than high
: low.empty() or high.empty() or (low <= high)
sqty-1errorObservation.referenceRange.low, Observation.referenceRange.highThe comparator is not used on a SimpleQuantity
: comparator.empty()

This structure is derived from C_BiologicalSex

Summary

Mandatory: 8 elements
Must-Support: 4 elements
Fixed Value: 4 elements
Prohibited: 1 element

Maturity: 1

 

Other representations of profile: CSV, Excel, Schematron