2nd DSTU Draft For Comment

This page is part of the FHIR Specification (v0.4.0: DSTU 2 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

Profile: HDLCholesterol

The official URL for this profile is: 

http://hl7.org/fhir/Profile/15046b9c-2da0-4b80-82ef-c6af6fcfd2bf-hdlcholesterol

. HDL Cholesterol Result

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

Summary

Required/Prohibited Elements

  • The element Observation is required
  • The element Observation.code is required
  • The element Observation.reliability is required
  • The element Observation.referenceRange is required
  • The element Observation.referenceRange.low is required
  • The element Observation.referenceRange.high is prohibited
  • The element Observation.referenceRange.meaning is prohibited
  • The element Observation.referenceRange.age is prohibited
  • The element Observation.related is prohibited

Fixed Values

  • The element Observation.code value has been fixed to LOINC code 2085-9("HDL Cholesterol")
  • The element Observation.reliability value has been fixed to ok
  • The element Observation.referenceRange.low value has been fixed to 1.5mmol/L

Formal Views of Profile Content

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

Differential View

This structure is derived from Observation.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 1..1HDL Cholesterol Result
... code S1..1CodeableConceptHDL Cholesterol
Fixed Value: {"coding":[{"system":"http://loinc.org","code":"2085-9","display":"HDL Cholesterol"}]}
... valueQuantity S0..1QuantityHDL Cholesterol value
... interpretation S0..1CodeableConcept+ | ++ | +++ | - | -- | ---
... comments S0..1stringComments about result
... reliability 1..1codeFixed Value: ok
... referenceRange S1..1
.... low 1..1Quantity>1.5 mmol/L.
Fixed Value: {"value":1.5,"units":"mmol/L"}
.... high 0..0
.... meaning 0..0CodeableConcept
.... age 0..0Range
... related 0..0

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I1..1HDL Cholesterol Result
obs-6: Shall only be present if Observation.value[x] is not present
... id 0..1idLogical id of this artefact
... meta 0..1MetaMetadata about the resource
... implicitRules M0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Language (required, not extensible)
... 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 S1..1CodeableConceptHDL Cholesterol
Binding: ObservationType (example, extensible)
Fixed Value: {"coding":[{"system":"http://loinc.org","code":"2085-9","display":"HDL Cholesterol"}]}
... valueQuantity S0..1QuantityHDL Cholesterol value
... dataAbsentReason I0..1codeunknown | asked | temp | notasked +
Binding: DataAbsentReason (required, not extensible)
Example: unknown
... interpretation S0..1CodeableConcept+ | ++ | +++ | - | -- | ---
Binding: ObservationInterpretation (preferred, 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 M1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required, not extensible)
... reliability M1..1codeok | ongoing | early | questionable | calibrating | error +
Binding: ObservationReliability (required, not extensible)
Fixed Value: ok
... bodySite[x] 0..1CodeableConcept, BodySiteObserved body part
Binding: BodySite (example, extensible)
... method 0..1CodeableConceptHow it was done
Binding: ObservationMethod (example, extensible)
... identifier 0..1IdentifierUnique 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
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... low I1..1Quantity>1.5 mmol/L.
obs-4: Low range comparators can only be '>' or '>=' or empty
Fixed Value: {"value":1.5,"units":"mmol/L"}
.... text 0..1stringText based reference range in an observation

XML Template

JSON Template

todo

Differential View

This structure is derived from Observation.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 1..1HDL Cholesterol Result
... code S1..1CodeableConceptHDL Cholesterol
Fixed Value: {"coding":[{"system":"http://loinc.org","code":"2085-9","display":"HDL Cholesterol"}]}
... valueQuantity S0..1QuantityHDL Cholesterol value
... interpretation S0..1CodeableConcept+ | ++ | +++ | - | -- | ---
... comments S0..1stringComments about result
... reliability 1..1codeFixed Value: ok
... referenceRange S1..1
.... low 1..1Quantity>1.5 mmol/L.
Fixed Value: {"value":1.5,"units":"mmol/L"}
.... high 0..0
.... meaning 0..0CodeableConcept
.... age 0..0Range
... related 0..0

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I1..1HDL Cholesterol Result
obs-6: Shall only be present if Observation.value[x] is not present
... id 0..1idLogical id of this artefact
... meta 0..1MetaMetadata about the resource
... implicitRules M0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Language (required, not extensible)
... 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 S1..1CodeableConceptHDL Cholesterol
Binding: ObservationType (example, extensible)
Fixed Value: {"coding":[{"system":"http://loinc.org","code":"2085-9","display":"HDL Cholesterol"}]}
... valueQuantity S0..1QuantityHDL Cholesterol value
... dataAbsentReason I0..1codeunknown | asked | temp | notasked +
Binding: DataAbsentReason (required, not extensible)
Example: unknown
... interpretation S0..1CodeableConcept+ | ++ | +++ | - | -- | ---
Binding: ObservationInterpretation (preferred, 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 M1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required, not extensible)
... reliability M1..1codeok | ongoing | early | questionable | calibrating | error +
Binding: ObservationReliability (required, not extensible)
Fixed Value: ok
... bodySite[x] 0..1CodeableConcept, BodySiteObserved body part
Binding: BodySite (example, extensible)
... method 0..1CodeableConceptHow it was done
Binding: ObservationMethod (example, extensible)
... identifier 0..1IdentifierUnique 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
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... low I1..1Quantity>1.5 mmol/L.
obs-4: Low range comparators can only be '>' or '>=' or empty
Fixed Value: {"value":1.5,"units":"mmol/L"}
.... text 0..1stringText based reference range in an observation

XML Template

JSON Template

todo

 

Other definitions: (todo)

Terminology Bindings

PathNameConformanceValueSet
Observation.languageLanguagerequiredhttp://tools.ietf.org/html/bcp47
Observation.codeObservationTypeexample (extensible)LOINC Codes
Observation.dataAbsentReasonDataAbsentReasonrequiredDataAbsentReason
Observation.interpretationObservationInterpretationpreferred (extensible)Observation Interpretation Codes
Observation.statusObservationStatusrequiredObservationStatus
Observation.reliabilityObservationReliabilityrequiredObservationReliability
Observation.bodySite[x]BodySiteexample (extensible)SNOMED CT Body Structures
Observation.methodObservationMethodexample (extensible)Observation Methods
Observation.referenceRange.meaningObservationRangeMeaningexample (extensible)Observation Reference Range Meaning Codes
Observation.related.typeObservationRelationshipTyperequiredObservationRelationshipType

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-4Observation.referenceRange.lowlow range comparatorsLow range comparators can only be '>' or '>=' or empty
XPath: not(exists(f:comparator)) or boolean(f:comparator/@value = '<') or boolean(f:comparator/@value = '<=')
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 = '>=')
.