Connectathon 11 Snapshot

This page is part of the FHIR Specification (v1.2.0: STU 3 Draft). 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

4.29.12.3 StructureDefinition: Cholesterol

The official URL for this profile is: 

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

Describes how the lab report is used for a standard Lipid Profile - Cholesterol, Triglyceride and Cholesterol fractions. Uses LOINC codes

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

4.29.12.3.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 (+3 nested mandatory elements)
Must-Support: 9 elements
Fixed Value: 5 elements
Prohibited: 5 elements

This structure is derived from Observation.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 1..1Observation
... code S1..1CodeableConceptCholesterol
Fixed Value: {"coding":[{"system":"http://loinc.org","code":"35200-5","display":"Cholesterol"}]}
... valueQuantity S0..1QuantityCholesterol value
.... value S0..1decimalActual numerical value
.... comparator 0..0
.... unit S1..1stringFixed Value: mmol/L
.... system S1..1uriFixed Value: http://unitsofmeasure.org
.... code S1..1codeFixed Value: mmol/L
... interpretation S0..1CodeableConcept+ | ++ | +++ | - | -- | ---
... comments S0..1stringComments about result
... referenceRange S1..1BackboneElement
.... low 0..0
.... high 1..1SimpleQuantityFixed Value: {"value":4.5}
.... meaning 0..0
.... age 0..0
... related 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I1..1ObservationMeasurements and simple assertions
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: Component code SHALL not be same as observation code
... 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: IETF BCP-47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... 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..1CodeableConceptClassification of type of observation
Binding: Observation Category Codes (example)
... code S ∑1..1CodeableConceptCholesterol
Binding: LOINC Codes (example)
Fixed Value: {"coding":[{"system":"http://loinc.org","code":"35200-5","display":"Cholesterol"}]}
... 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 ∑0..1QuantityCholesterol value
.... extension 0..*ExtensionAdditional Content defined by implementations
.... value S ∑0..1decimalActual numerical value
.... unit S ∑1..1stringUnit representation
Fixed Value: mmol/L
.... system S ∑I1..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
.... code S ∑1..1codeCoded form of the unit
Fixed Value: mmol/L
... dataAbsentReason I0..1CodeableConceptWhy the result is missing
Binding: Observation Value Absent Reason (extensible)
... interpretation S0..1CodeableConcept+ | ++ | +++ | - | -- | ---
Binding: Observation Interpretation Codes (extensible)
... comments 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 S I1..1BackboneElementProvides guide for interpretation
obs-3: Must have at least a low or a high or text
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... high ∑ I1..1SimpleQuantityHigh Range, if relevant
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":4.5}
.... text 0..1stringText based reference range in an observation
... component ∑0..*BackboneElementComponent results
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... code ∑ I1..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)
.... referenceRange 0..*See Observation.referenceRangeProvides guide for interpretation of component result

doco Documentation for this format

todo

This structure is derived from Observation.

Summary

Mandatory: 3 elements (+3 nested mandatory elements)
Must-Support: 9 elements
Fixed Value: 5 elements
Prohibited: 5 elements

Differential View

This structure is derived from Observation.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 1..1Observation
... code S1..1CodeableConceptCholesterol
Fixed Value: {"coding":[{"system":"http://loinc.org","code":"35200-5","display":"Cholesterol"}]}
... valueQuantity S0..1QuantityCholesterol value
.... value S0..1decimalActual numerical value
.... comparator 0..0
.... unit S1..1stringFixed Value: mmol/L
.... system S1..1uriFixed Value: http://unitsofmeasure.org
.... code S1..1codeFixed Value: mmol/L
... interpretation S0..1CodeableConcept+ | ++ | +++ | - | -- | ---
... comments S0..1stringComments about result
... referenceRange S1..1BackboneElement
.... low 0..0
.... high 1..1SimpleQuantityFixed Value: {"value":4.5}
.... meaning 0..0
.... age 0..0
... related 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I1..1ObservationMeasurements and simple assertions
obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present
obs-7: Component code SHALL not be same as observation code
... 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: IETF BCP-47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... 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..1CodeableConceptClassification of type of observation
Binding: Observation Category Codes (example)
... code S ∑1..1CodeableConceptCholesterol
Binding: LOINC Codes (example)
Fixed Value: {"coding":[{"system":"http://loinc.org","code":"35200-5","display":"Cholesterol"}]}
... 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 ∑0..1QuantityCholesterol value
.... extension 0..*ExtensionAdditional Content defined by implementations
.... value S ∑0..1decimalActual numerical value
.... unit S ∑1..1stringUnit representation
Fixed Value: mmol/L
.... system S ∑I1..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
.... code S ∑1..1codeCoded form of the unit
Fixed Value: mmol/L
... dataAbsentReason I0..1CodeableConceptWhy the result is missing
Binding: Observation Value Absent Reason (extensible)
... interpretation S0..1CodeableConcept+ | ++ | +++ | - | -- | ---
Binding: Observation Interpretation Codes (extensible)
... comments 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 S I1..1BackboneElementProvides guide for interpretation
obs-3: Must have at least a low or a high or text
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... high ∑ I1..1SimpleQuantityHigh Range, if relevant
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":4.5}
.... text 0..1stringText based reference range in an observation
... component ∑0..*BackboneElementComponent results
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... code ∑ I1..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)
.... referenceRange 0..*See Observation.referenceRangeProvides guide for interpretation of component result

doco Documentation for this format

XML Template

JSON Template

todo

 

Other representations of profile: Schematron

4.29.12.3.2 Terminology Bindings

PathNameConformanceValueSet
Observation.language?extrequiredhttp://tools.ietf.org/html/bcp47
Observation.statusObservationStatusrequiredObservationStatus
Observation.categoryObservation Category CodesexampleObservation Category Codes
Observation.codeLOINC CodesexampleLOINC Codes
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

4.29.12.3.3 Constraints

IdPathDetailsRequirements
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')])))
obs-7ObservationComponent code SHALL not be same as observation code
XPath: not(exists(f:component/f:code)) or 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-3Observation.referenceRangeMust have at least a low or a high or text
XPath: (exists(f:low) or exists(f:high)or exists(f:text))
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))
.