STU 3 Ballot

This page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

10.2.12.18 StructureDefinition: LDLCholesterol

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/ldlcholesterol

LDL Cholesterol Result

This profile was published on Sat, May 12, 2012 00:00+1000 as a draft by Grahame Grieve.

10.2.12.18.1 Formal Views of Profile Content

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

This structure is derived from Observation.

Summary

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

Extensions

This structure refers to these extensions:

This structure is derived from Observation.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 1..1LDL Cholesterol Result
... code S1..1CodeableConceptLDL Cholesterol -measured or calculated per code
Binding: LDLCodes (required)
... valueQuantity S0..1QuantityLDL Cholesterol value
... interpretation S0..1CodeableConcept+ | ++ | +++ | - | -- | ---
... comment S0..1stringComments about result
... referenceRange S1..1BackboneElement
.... low 0..0
.... high 1..1SimpleQuantityFixed Value: {"value":3.0}
.... meaning 0..0
.... age 0..0
... related 0..0
... lipid-report-ldl-chol-calculated 0..1booleanWhether LDL value is calculated
URL: http://hl7.org/fhir/StructureDefinition/lipid-report-ldl-chol-calculated

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I1..1LDL Cholesterol Result
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
obs-7: If code is the same as a component code then the value element associated with the code SHALL NOT be present
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
... id ∑0..1idLogical id of this artifact
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?!∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... lipid-report-ldl-chol-calculated I0..1booleanWhether LDL value is calculated
URL: http://hl7.org/fhir/StructureDefinition/lipid-report-ldl-chol-calculated
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierUnique Id for this particular observation
... status ?!∑1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required)
... category 0..*CodeableConceptClassification of type of observation
Binding: Observation Category Codes (example)
... code S∑1..1CodeableConceptLDL Cholesterol -measured or calculated per code
Binding: LDLCodes (required)
... subject ∑0..1Reference(Patient | Group | Device | Location)Who and/or what this is about
... encounter 0..1Reference(Encounter)Healthcare event during which this observation is made
... effective[x] ∑0..1dateTime, PeriodClinically relevant time/time-period for observation
... issued ∑0..1instantDate/Time this was made available
... performer ∑0..*Reference(Practitioner | Organization | Patient | RelatedPerson)Who is responsible for the observation
... valueQuantity S∑I0..1QuantityLDL Cholesterol value
... dataAbsentReason I0..1CodeableConceptWhy the result is missing
Binding: Observation Value Absent Reason (extensible)
... interpretation S0..1CodeableConcept+ | ++ | +++ | - | -- | ---
Binding: Observation Interpretation Codes (extensible)
... comment S0..1stringComments about result
... bodySite 0..1CodeableConceptObserved body part
Binding: SNOMED CT Body Structures (example)
... method 0..1CodeableConceptHow it was done
Binding: Observation Methods (example)
... specimen 0..1Reference(Specimen)Specimen used for this observation
... device 0..1Reference(Device | DeviceMetric)(Measurement) Device
... referenceRange SI1..1BackboneElementProvides guide for interpretation
obs-3: Must have at least a low or a high or text
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... high I1..1SimpleQuantityA fixed quantity (no comparator)
ele-1: All FHIR elements must have a @value or children
qty-3: If a code for the unit is present, the system SHALL also be present
sqty-1: The comparator is not used on a SimpleQuantity
Fixed Value: {"value":3.0}
.... text 0..1stringText based reference range in an observation
... component ∑0..*BackboneElementComponent results
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... code ∑1..1CodeableConceptType of component observation (code / type)
Binding: LOINC Codes (example)
.... value[x] ∑0..1Quantity, CodeableConcept, string, Range, Ratio, SampledData, Attachment, time, dateTime, PeriodActual component result
.... dataAbsentReason I0..1CodeableConceptWhy the component result is missing
Binding: Observation Value Absent Reason (extensible)
.... interpretation 0..1CodeableConceptHigh, low, normal, etc.
Binding: Observation Interpretation Codes (extensible)
.... referenceRange 0..*Unknown reference to #Observation:ldlcholesterol.referenceRange
Provides guide for interpretation of component result

doco Documentation for this format

todo

This structure is derived from Observation.

Summary

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

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from Observation.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 1..1LDL Cholesterol Result
... code S1..1CodeableConceptLDL Cholesterol -measured or calculated per code
Binding: LDLCodes (required)
... valueQuantity S0..1QuantityLDL Cholesterol value
... interpretation S0..1CodeableConcept+ | ++ | +++ | - | -- | ---
... comment S0..1stringComments about result
... referenceRange S1..1BackboneElement
.... low 0..0
.... high 1..1SimpleQuantityFixed Value: {"value":3.0}
.... meaning 0..0
.... age 0..0
... related 0..0
... lipid-report-ldl-chol-calculated 0..1booleanWhether LDL value is calculated
URL: http://hl7.org/fhir/StructureDefinition/lipid-report-ldl-chol-calculated

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I1..1LDL Cholesterol Result
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
obs-7: If code is the same as a component code then the value element associated with the code SHALL NOT be present
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
... id ∑0..1idLogical id of this artifact
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?!∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... lipid-report-ldl-chol-calculated I0..1booleanWhether LDL value is calculated
URL: http://hl7.org/fhir/StructureDefinition/lipid-report-ldl-chol-calculated
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierUnique Id for this particular observation
... status ?!∑1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required)
... category 0..*CodeableConceptClassification of type of observation
Binding: Observation Category Codes (example)
... code S∑1..1CodeableConceptLDL Cholesterol -measured or calculated per code
Binding: LDLCodes (required)
... subject ∑0..1Reference(Patient | Group | Device | Location)Who and/or what this is about
... encounter 0..1Reference(Encounter)Healthcare event during which this observation is made
... effective[x] ∑0..1dateTime, PeriodClinically relevant time/time-period for observation
... issued ∑0..1instantDate/Time this was made available
... performer ∑0..*Reference(Practitioner | Organization | Patient | RelatedPerson)Who is responsible for the observation
... valueQuantity S∑I0..1QuantityLDL Cholesterol value
... dataAbsentReason I0..1CodeableConceptWhy the result is missing
Binding: Observation Value Absent Reason (extensible)
... interpretation S0..1CodeableConcept+ | ++ | +++ | - | -- | ---
Binding: Observation Interpretation Codes (extensible)
... comment S0..1stringComments about result
... bodySite 0..1CodeableConceptObserved body part
Binding: SNOMED CT Body Structures (example)
... method 0..1CodeableConceptHow it was done
Binding: Observation Methods (example)
... specimen 0..1Reference(Specimen)Specimen used for this observation
... device 0..1Reference(Device | DeviceMetric)(Measurement) Device
... referenceRange SI1..1BackboneElementProvides guide for interpretation
obs-3: Must have at least a low or a high or text
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... high I1..1SimpleQuantityA fixed quantity (no comparator)
ele-1: All FHIR elements must have a @value or children
qty-3: If a code for the unit is present, the system SHALL also be present
sqty-1: The comparator is not used on a SimpleQuantity
Fixed Value: {"value":3.0}
.... text 0..1stringText based reference range in an observation
... component ∑0..*BackboneElementComponent results
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... code ∑1..1CodeableConceptType of component observation (code / type)
Binding: LOINC Codes (example)
.... value[x] ∑0..1Quantity, CodeableConcept, string, Range, Ratio, SampledData, Attachment, time, dateTime, PeriodActual component result
.... dataAbsentReason I0..1CodeableConceptWhy the component result is missing
Binding: Observation Value Absent Reason (extensible)
.... interpretation 0..1CodeableConceptHigh, low, normal, etc.
Binding: Observation Interpretation Codes (extensible)
.... referenceRange 0..*Unknown reference to #Observation:ldlcholesterol.referenceRange
Provides guide for interpretation of component result

doco Documentation for this format

XML Template

JSON Template

todo

 

Other representations of profile: Schematron

10.2.12.18.2 Terminology Bindings

PathNameConformanceValueSet
Observation.languageCommon LanguagesextensibleCommon Languages
Observation.statusObservationStatusrequiredObservationStatus
Observation.categoryObservation Category CodesexampleObservation Category Codes
Observation.codeLDLCodesrequiredLDLCodes
Observation.dataAbsentReasonObservation Value Absent ReasonextensibleObservation Value Absent Reason
Observation.interpretationObservation Interpretation CodesextensibleObservation Interpretation Codes
Observation.bodySiteSNOMED CT Body StructuresexampleSNOMED CT Body Structures
Observation.methodObservation MethodsexampleObservation Methods
Observation.related.typeObservationRelationshipTyperequiredObservationRelationshipType
Observation.component.codeLOINC CodesexampleLOINC Codes
Observation.component.dataAbsentReasonObservation Value Absent ReasonextensibleObservation Value Absent Reason
Observation.component.interpretationObservation Interpretation CodesextensibleObservation Interpretation Codes

10.2.12.18.3 Constraints

IdPathDetailsRequirements
dom-2ObservationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
XPath: not(parent::f:contained and f:contained)
dom-1ObservationIf the resource is contained in another resource, it SHALL NOT contain any narrative
XPath: not(parent::f:contained and f:text)
dom-4ObservationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
XPath: not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
dom-3ObservationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
XPath: not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))
obs-7ObservationIf code is the same as a component code then the value element associated with the code SHALL NOT be present
XPath: not(exists(f:value)) or not(count(for $coding in f:code/f:coding return parent::*/f:component/f:code/f:coding[f:code/@value=$coding/f:code/@value and f:system/@value=$coding/f:system/@value])=0)
obs-6ObservationdataAbsentReason SHALL only be present if Observation.value[x] is not present
XPath: not(exists(f:dataAbsentReason)) or (not(exists(*[starts-with(local-name(.), 'value')])))
ele-1Observation.extensionAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
ext-1Observation.extensionMust have either extensions or value[x], not both
XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
obs-3Observation.referenceRangeMust have at least a low or a high or text
XPath: (exists(f:low) or exists(f:high)or exists(f:text))
ele-1Observation.referenceRange.highAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
qty-3Observation.referenceRange.highIf a code for the unit is present, the system SHALL also be present
XPath: not(exists(f:code)) or exists(f:system)
sqty-1Observation.referenceRange.highThe comparator is not used on a SimpleQuantity
XPath: not(exists(f:comparator))
.