DSTU2 Ballot Source

This page is part of the FHIR Specification (v0.5.0: DSTU 2 Ballot 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

4.21.11.3 StructureDefinition: Cholesterol

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/lipid-report-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.21.11.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: 7 elements, Must-Support: 9 elements, Fixed Value: 6 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..0code
.... units 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
... reliability 1..1codeCholesterol values can only be reported when there is no question about their status.
Fixed Value: ok
... referenceRange S1..1
.... low 0..0
.... high 1..1Quantity<4.5 mmol/L.
Fixed Value: {"value":4.5,"units":"mmol/L"}
.... meaning 0..0CodeableConcept
.... age 0..0Range
... related 0..0
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I1..1ObservationMeasurements and simple assertions
obs-6: Shall only be present if Observation.value[x] is not present
... 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: Language (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
... code S Σ1..1CodeableConceptCholesterol
Binding: ObservationType (example)
Fixed Value: {"coding":[{"system":"http://loinc.org","code":"35200-5","display":"Cholesterol"}]}
... valueQuantity S Σ0..1QuantityCholesterol value
Binding: ObservationValue (example)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... value S0..1decimalActual numerical value
.... units S1..1stringUnit representation
Fixed Value: mmol/L
.... system S I1..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
.... code S1..1codeCoded form of the unit
Fixed Value: mmol/L
... dataAbsentReason I0..1CodeableConceptWhy the result is missing
Binding: ObservationValueAbsentReason (extensible)
... interpretation S0..1CodeableConcept+ | ++ | +++ | - | -- | ---
Binding: ObservationInterpretation (extensible)
... comments S0..1stringComments about result
... applies[x] Σ0..1dateTime, PeriodPhysiologically Relevant time/time-period for observation
... issued Σ0..1instantDate/Time this was made available
... status ?! Σ1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required)
... reliability ?!1..1codeCholesterol values can only be reported when there is no question about their status.
Binding: ObservationReliability (required)
Fixed Value: ok
... bodySite[x] 0..1CodeableConcept, BodySiteObserved body part
Binding: BodySite (example)
... method 0..1CodeableConceptHow it was done
Binding: ObservationMethod (example)
... identifier 0..*IdentifierUnique Id for this particular observation
... subject Σ0..1Patient, Group, Device, LocationWho and/or what this is about
... specimen 0..1SpecimenSpecimen used for this observation
... performer Σ0..*Practitioner, Organization, Patient, RelatedPersonWho did the observation
... device 0..1Device, DeviceMetric(Measurement) Device
... encounter 0..1EncounterHealthcare event during which this observation is made
... referenceRange S I1..1Provides 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..1Quantity<4.5 mmol/L.
obs-5: High range comparators can only be '<' or '<=' or empty
Fixed Value: {"value":4.5,"units":"mmol/L"}
.... text 0..1stringText based reference range in an observation

todo

This structure is derived from Observation.

Summary

Mandatory: 7 elements, Must-Support: 9 elements, Fixed Value: 6 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..0code
.... units 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
... reliability 1..1codeCholesterol values can only be reported when there is no question about their status.
Fixed Value: ok
... referenceRange S1..1
.... low 0..0
.... high 1..1Quantity<4.5 mmol/L.
Fixed Value: {"value":4.5,"units":"mmol/L"}
.... meaning 0..0CodeableConcept
.... age 0..0Range
... related 0..0

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I1..1ObservationMeasurements and simple assertions
obs-6: Shall only be present if Observation.value[x] is not present
... 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: Language (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
... code S Σ1..1CodeableConceptCholesterol
Binding: ObservationType (example)
Fixed Value: {"coding":[{"system":"http://loinc.org","code":"35200-5","display":"Cholesterol"}]}
... valueQuantity S Σ0..1QuantityCholesterol value
Binding: ObservationValue (example)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... value S0..1decimalActual numerical value
.... units S1..1stringUnit representation
Fixed Value: mmol/L
.... system S I1..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
.... code S1..1codeCoded form of the unit
Fixed Value: mmol/L
... dataAbsentReason I0..1CodeableConceptWhy the result is missing
Binding: ObservationValueAbsentReason (extensible)
... interpretation S0..1CodeableConcept+ | ++ | +++ | - | -- | ---
Binding: ObservationInterpretation (extensible)
... comments S0..1stringComments about result
... applies[x] Σ0..1dateTime, PeriodPhysiologically Relevant time/time-period for observation
... issued Σ0..1instantDate/Time this was made available
... status ?! Σ1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required)
... reliability ?!1..1codeCholesterol values can only be reported when there is no question about their status.
Binding: ObservationReliability (required)
Fixed Value: ok
... bodySite[x] 0..1CodeableConcept, BodySiteObserved body part
Binding: BodySite (example)
... method 0..1CodeableConceptHow it was done
Binding: ObservationMethod (example)
... identifier 0..*IdentifierUnique Id for this particular observation
... subject Σ0..1Patient, Group, Device, LocationWho and/or what this is about
... specimen 0..1SpecimenSpecimen used for this observation
... performer Σ0..*Practitioner, Organization, Patient, RelatedPersonWho did the observation
... device 0..1Device, DeviceMetric(Measurement) Device
... encounter 0..1EncounterHealthcare event during which this observation is made
... referenceRange S I1..1Provides 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..1Quantity<4.5 mmol/L.
obs-5: High range comparators can only be '<' or '<=' or empty
Fixed Value: {"value":4.5,"units":"mmol/L"}
.... text 0..1stringText based reference range in an observation

XML Template

JSON Template

todo

 

Other representations of profile: (todo)

4.21.11.3.2 Terminology Bindings

PathNameConformanceValueSet
Observation.languageLanguagerequiredhttp://tools.ietf.org/html/bcp47
Observation.codeObservationTypeexampleLOINC Codes
Observation.valueQuantityObservationValueexampleSNOMED CT Codes
Observation.dataAbsentReasonObservationValueAbsentReasonextensibleObservation Value Absent Reason
Observation.interpretationObservationInterpretationextensibleObservation Interpretation Codes
Observation.statusObservationStatusrequiredObservationStatus
Observation.reliabilityObservationReliabilityrequiredObservationReliability
Observation.bodySite[x]BodySiteexampleSNOMED CT Body Structures
Observation.methodObservationMethodexampleObservation Methods
Observation.related.typeObservationRelationshipTyperequiredObservationRelationshipType

4.21.11.3.3 Constraints

IdPathNameDetails
obs-6Observationdata absent reasonShall only be present if Observation.value[x] is not present
XPath: not(exists(f:dataAbsentReason)) or (not(exists(*[starts-with(local-name(.), 'value')])))
obs-3Observation.referenceRangereference rangeMust have at least a low or a high or text
XPath: (exists(f:low) or exists(f:high)or exists(f:text))
obs-5Observation.referenceRange.highhigh range comparatorsHigh range comparators can only be '<' or '<=' or empty
XPath: not(exists(f:comparator)) or boolean(f:comparator/@value = '>') or boolean(f:comparator/@value = '>=')
.