R4 Ballot #1 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (v3.3.0: R4 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 . Page versions: R5 R4B R4 R3 R2

10.3.11.21 StructureDefinition: HDLCholesterol

Orders and Observations Work Group Maturity Level: 1Informative Use Context: Not Intended for Production use

The official URL for this profile is: 

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

HDL Cholesterol Result

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

10.3.11.21.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: 2 elements
Prohibited: 6 elements

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+ | ++ | +++ | - | -- | ---
... comment S0..1stringComments about result
... referenceRange S1..1BackboneElement
.... low 1..1SimpleQuantityFixed Value: {"value":1.5}
.... high 0..0
.... type 0..0
.... appliesTo 0..0
.... age 0..0
... hasMember 0..0
... derivedFrom 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I1..1HDL Cholesterol Result
... 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
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness Identifier for observation
... basedOn Σ0..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)Fulfills plan, proposal or order
... partOf Σ0..*Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy)Part of referenced event
... status ?!Σ1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required)
... category 0..*CodeableConceptClassification of type of observation
Binding: Observation Category Codes (preferred)
... code SΣ1..1CodeableConceptHDL Cholesterol
Binding: LOINC Codes (example)
Fixed Value: {"coding":[{"system":"http://loinc.org","code":"2085-9","display":"HDL Cholesterol"}]}
... subject Σ0..1Reference(Patient | Group | Device | Location)Who and/or what this is about
... focus Σ0..1Reference(Resource)The "focal point" of the observation
... context 0..1Reference(Encounter | EpisodeOfCare)Healthcare event during which this observation is made
... effective[x] Σ0..1dateTime, Period, TimingClinically relevant time/time-period for observation
... issued Σ0..1instantDate/Time this version was made available
... performer Σ0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson)Who is responsible for the observation
... valueQuantity SΣI0..1QuantityHDL Cholesterol value
... dataAbsentReason I0..1CodeableConceptWhy the result is missing
Binding: DataAbsentReason (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 | DeviceComponent | DeviceMetric)(Measurement) Device
... referenceRange SI1..1BackboneElementProvides guide for interpretation
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... low I1..1SimpleQuantityLow Range, if relevant
Fixed Value: {"value":1.5}
.... text 0..1stringText based reference range in an observation
... component ΣI0..*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, boolean, integer, Range, Ratio, SampledData, time, dateTime, PeriodActual component result
.... dataAbsentReason I0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible)
.... interpretation 0..1CodeableConceptHigh, low, normal, etc.
Binding: Observation Interpretation Codes (extensible)
.... referenceRange 0..*Unknown reference to #Observation.referenceRange
Provides guide for interpretation of component result

doco Documentation for this format
<!-- Example Lipid Profile -->doco

<Observation xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
 <meta><!-- 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- 0..1 Language of the resource content   -->
 <text><!-- 0..1 Narrative 
     Text summary of the resource, for human interpretation --></text>
 <contained><!-- 0..* Resource Contained, inline Resources --></contained>
 <modifierExtension><!-- 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <identifier><!-- 0..* Identifier 
     Business Identifier for observation --></identifier>
 <basedOn><!-- 0..* Reference(CarePlan) Fulfills plan, proposal or order --></basedOn>
 <partOf><!-- 0..* Reference(MedicationAdministration) Part of referenced event --></partOf>
 <status value="[code]"/><!-- 1..1 registered | preliminary | final | amended +   -->
 <category><!-- 0..* CodeableConcept Classification of  type of observation   --></category>
 <code><!-- 1..1 CodeableConcept HDL Cholesterol   --></code>
 <subject><!-- 0..1 Reference(Patient) Who and/or what this is about --></subject>
 <focus><!-- 0..1 Reference(Resource) The "focal point" of the observation --></focus>
 <context><!-- 0..1 Reference(Encounter) 
     Healthcare event during which this observation is made --></context>
 <effective[x]><!-- 0..1 dateTime|Period|Timing 
     Clinically relevant time/time-period for observation --></effective[x]>
 <issued value="[instant]"/><!-- 0..1 Date/Time this version was made available -->
 <performer><!-- 0..* Reference(Practitioner) 
     Who is responsible for the observation --></performer>
 <valueQuantity><!-- 0..1 Quantity HDL Cholesterol value --></valueQuantity>
 <dataAbsentReason><!-- 0..1 CodeableConcept Why the result is missing   --></dataAbsentReason>
 <interpretation><!-- 0..1 CodeableConcept + | ++ | +++ | - | -- | ---   --></interpretation>
 <comment value="[string]"/><!-- 0..1 Comments about result -->
 <bodySite><!-- 0..1 CodeableConcept Observed body part   --></bodySite>
 <method><!-- 0..1 CodeableConcept How it was done   --></method>
 <specimen><!-- 0..1 Reference(Specimen) Specimen used for this observation --></specimen>
 <device><!-- 0..1 Reference(Device) (Measurement) Device --></device>
 <referenceRange> ?? 1..1 BackboneElement  <!-- ?? 1..1 Provides guide for interpretation -->
  <modifierExtension><!-- 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
  <low><!-- ?? 1..1 Quantity 
      Low Range, if relevant --></low>
  <high><!-- 0..0 Quantity 
      High Range, if relevant --></high>
  <type><!-- 0..0 CodeableConcept Reference range qualifier   --></type>
  <appliesTo><!-- 0..0 CodeableConcept Reference range population   --></appliesTo>
  <age><!-- 0..0 Range 
      Applicable age range, if relevant --></age>
  <text value="[string]"/><!-- 0..1 Text based reference range in an observation -->
 </referenceRange>
 <hasMember><!-- 0..0 Reference(Observation) 
     Related resource that belongs to the Observation group --></hasMember>
 <derivedFrom><!-- 0..0 Reference(DocumentReference) 
     Related measurements the observation is made from --></derivedFrom>
 <component> ?? 0..* BackboneElement  <!-- ?? 0..* Component results -->
  <modifierExtension><!-- 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
  <code><!-- 1..1 CodeableConcept Type of component observation (code / type)   --></code>
  <value[x]><!-- 0..1 Quantity|CodeableConcept|string|
    boolean|integer|Range|Ratio|SampledData|time|dateTime|Period 
      Actual component result --></value[x]>
  <dataAbsentReason><!-- 0..1 CodeableConcept Why the component result is missing   --></dataAbsentReason>
  <interpretation><!-- 0..1 CodeableConcept High, low, normal, etc.   --></interpretation>
  <referenceRange><!-- See #Observation.referenceRange  Provides guide for interpretation of component result --></referenceRange>
 </component>
</Observation>

{ // Example Lipid Profile
  // from Element: extension
    "meta" : { Meta }, //Metadata about the resource
    "implicitRules" : "<uri>", //A set of rules under which this content was created
    "language" : "<code>", //Language of the resource content
    "text" : { Narrative }, //Text summary of the resource, for human interpretation
    "contained" : [{ Resource }], //Contained, inline Resources
    "modifierExtension" : [{ Extension }], //Extensions that cannot be ignored
    "identifier" : [{ Identifier }], //Business Identifier for observation
    "basedOn" : [{ Reference(CarePlan) }], //Fulfills plan, proposal or order
    "partOf" : [{ Reference(MedicationAdministration) }], //Part of referenced event
    "status" : "<code>", // R! registered | preliminary | final | amended +
    "category" : [{ CodeableConcept }], //Classification of  type of observation
    "code" : { CodeableConcept }, // R! 
    "subject" : { Reference(Patient) }, //Who and/or what this is about
    "focus" : { Reference(Resource) }, //The "focal point" of the observation
    "context" : { Reference(Encounter) }, //Healthcare event during which this observation is made
// value[x]: Clinically relevant time/time-period for observation. One of these 3:
    "effectiveDateTime" : "<dateTime>", //Clinically relevant time/time-period for observation
    "effectivePeriod" : { Period }, //Clinically relevant time/time-period for observation
    "effectiveTiming" : { Timing }, //Clinically relevant time/time-period for observation
    "issued" : "<instant>", //Date/Time this version was made available
    "performer" : [{ Reference(Practitioner) }], //Who is responsible for the observation
    "valueQuantity" : { Quantity }, //HDL Cholesterol value
    "dataAbsentReason" : { CodeableConcept }, //Why the result is missing
    "interpretation" : { CodeableConcept }, //+ | ++ | +++ | - | -- | ---
    "comment" : "<string>", //Comments about result
    "bodySite" : { CodeableConcept }, //Observed body part
    "method" : { CodeableConcept }, //How it was done
    "specimen" : { Reference(Specimen) }, //Specimen used for this observation
    "device" : { Reference(Device) }, //(Measurement) Device
    "referenceRange" : { BackboneElement }, // C? R! Provides guide for interpretation
    "component" : [{ BackboneElement }], // C?Component results
  }

This structure is derived from Observation.

Summary

Mandatory: 3 elements
Must-Support: 5 elements
Fixed Value: 2 elements
Prohibited: 6 elements

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+ | ++ | +++ | - | -- | ---
... comment S0..1stringComments about result
... referenceRange S1..1BackboneElement
.... low 1..1SimpleQuantityFixed Value: {"value":1.5}
.... high 0..0
.... type 0..0
.... appliesTo 0..0
.... age 0..0
... hasMember 0..0
... derivedFrom 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I1..1HDL Cholesterol Result
... 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
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness Identifier for observation
... basedOn Σ0..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)Fulfills plan, proposal or order
... partOf Σ0..*Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Immunization | ImagingStudy)Part of referenced event
... status ?!Σ1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required)
... category 0..*CodeableConceptClassification of type of observation
Binding: Observation Category Codes (preferred)
... code SΣ1..1CodeableConceptHDL Cholesterol
Binding: LOINC Codes (example)
Fixed Value: {"coding":[{"system":"http://loinc.org","code":"2085-9","display":"HDL Cholesterol"}]}
... subject Σ0..1Reference(Patient | Group | Device | Location)Who and/or what this is about
... focus Σ0..1Reference(Resource)The "focal point" of the observation
... context 0..1Reference(Encounter | EpisodeOfCare)Healthcare event during which this observation is made
... effective[x] Σ0..1dateTime, Period, TimingClinically relevant time/time-period for observation
... issued Σ0..1instantDate/Time this version was made available
... performer Σ0..*Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson)Who is responsible for the observation
... valueQuantity SΣI0..1QuantityHDL Cholesterol value
... dataAbsentReason I0..1CodeableConceptWhy the result is missing
Binding: DataAbsentReason (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 | DeviceComponent | DeviceMetric)(Measurement) Device
... referenceRange SI1..1BackboneElementProvides guide for interpretation
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... low I1..1SimpleQuantityLow Range, if relevant
Fixed Value: {"value":1.5}
.... text 0..1stringText based reference range in an observation
... component ΣI0..*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, boolean, integer, Range, Ratio, SampledData, time, dateTime, PeriodActual component result
.... dataAbsentReason I0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible)
.... interpretation 0..1CodeableConceptHigh, low, normal, etc.
Binding: Observation Interpretation Codes (extensible)
.... referenceRange 0..*Unknown reference to #Observation.referenceRange
Provides guide for interpretation of component result

doco Documentation for this format

XML Template

<!-- Example Lipid Profile -->doco

<Observation xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
 <meta><!-- 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- 0..1 Language of the resource content   -->
 <text><!-- 0..1 Narrative 
     Text summary of the resource, for human interpretation --></text>
 <contained><!-- 0..* Resource Contained, inline Resources --></contained>
 <modifierExtension><!-- 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <identifier><!-- 0..* Identifier 
     Business Identifier for observation --></identifier>
 <basedOn><!-- 0..* Reference(CarePlan) Fulfills plan, proposal or order --></basedOn>
 <partOf><!-- 0..* Reference(MedicationAdministration) Part of referenced event --></partOf>
 <status value="[code]"/><!-- 1..1 registered | preliminary | final | amended +   -->
 <category><!-- 0..* CodeableConcept Classification of  type of observation   --></category>
 <code><!-- 1..1 CodeableConcept HDL Cholesterol   --></code>
 <subject><!-- 0..1 Reference(Patient) Who and/or what this is about --></subject>
 <focus><!-- 0..1 Reference(Resource) The "focal point" of the observation --></focus>
 <context><!-- 0..1 Reference(Encounter) 
     Healthcare event during which this observation is made --></context>
 <effective[x]><!-- 0..1 dateTime|Period|Timing 
     Clinically relevant time/time-period for observation --></effective[x]>
 <issued value="[instant]"/><!-- 0..1 Date/Time this version was made available -->
 <performer><!-- 0..* Reference(Practitioner) 
     Who is responsible for the observation --></performer>
 <valueQuantity><!-- 0..1 Quantity HDL Cholesterol value --></valueQuantity>
 <dataAbsentReason><!-- 0..1 CodeableConcept Why the result is missing   --></dataAbsentReason>
 <interpretation><!-- 0..1 CodeableConcept + | ++ | +++ | - | -- | ---   --></interpretation>
 <comment value="[string]"/><!-- 0..1 Comments about result -->
 <bodySite><!-- 0..1 CodeableConcept Observed body part   --></bodySite>
 <method><!-- 0..1 CodeableConcept How it was done   --></method>
 <specimen><!-- 0..1 Reference(Specimen) Specimen used for this observation --></specimen>
 <device><!-- 0..1 Reference(Device) (Measurement) Device --></device>
 <referenceRange> ?? 1..1 BackboneElement  <!-- ?? 1..1 Provides guide for interpretation -->
  <modifierExtension><!-- 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
  <low><!-- ?? 1..1 Quantity 
      Low Range, if relevant --></low>
  <high><!-- 0..0 Quantity 
      High Range, if relevant --></high>
  <type><!-- 0..0 CodeableConcept Reference range qualifier   --></type>
  <appliesTo><!-- 0..0 CodeableConcept Reference range population   --></appliesTo>
  <age><!-- 0..0 Range 
      Applicable age range, if relevant --></age>
  <text value="[string]"/><!-- 0..1 Text based reference range in an observation -->
 </referenceRange>
 <hasMember><!-- 0..0 Reference(Observation) 
     Related resource that belongs to the Observation group --></hasMember>
 <derivedFrom><!-- 0..0 Reference(DocumentReference) 
     Related measurements the observation is made from --></derivedFrom>
 <component> ?? 0..* BackboneElement  <!-- ?? 0..* Component results -->
  <modifierExtension><!-- 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
  <code><!-- 1..1 CodeableConcept Type of component observation (code / type)   --></code>
  <value[x]><!-- 0..1 Quantity|CodeableConcept|string|
    boolean|integer|Range|Ratio|SampledData|time|dateTime|Period 
      Actual component result --></value[x]>
  <dataAbsentReason><!-- 0..1 CodeableConcept Why the component result is missing   --></dataAbsentReason>
  <interpretation><!-- 0..1 CodeableConcept High, low, normal, etc.   --></interpretation>
  <referenceRange><!-- See #Observation.referenceRange  Provides guide for interpretation of component result --></referenceRange>
 </component>
</Observation>

JSON Template

{ // Example Lipid Profile
  // from Element: extension
    "meta" : { Meta }, //Metadata about the resource
    "implicitRules" : "<uri>", //A set of rules under which this content was created
    "language" : "<code>", //Language of the resource content
    "text" : { Narrative }, //Text summary of the resource, for human interpretation
    "contained" : [{ Resource }], //Contained, inline Resources
    "modifierExtension" : [{ Extension }], //Extensions that cannot be ignored
    "identifier" : [{ Identifier }], //Business Identifier for observation
    "basedOn" : [{ Reference(CarePlan) }], //Fulfills plan, proposal or order
    "partOf" : [{ Reference(MedicationAdministration) }], //Part of referenced event
    "status" : "<code>", // R! registered | preliminary | final | amended +
    "category" : [{ CodeableConcept }], //Classification of  type of observation
    "code" : { CodeableConcept }, // R! 
    "subject" : { Reference(Patient) }, //Who and/or what this is about
    "focus" : { Reference(Resource) }, //The "focal point" of the observation
    "context" : { Reference(Encounter) }, //Healthcare event during which this observation is made
// value[x]: Clinically relevant time/time-period for observation. One of these 3:
    "effectiveDateTime" : "<dateTime>", //Clinically relevant time/time-period for observation
    "effectivePeriod" : { Period }, //Clinically relevant time/time-period for observation
    "effectiveTiming" : { Timing }, //Clinically relevant time/time-period for observation
    "issued" : "<instant>", //Date/Time this version was made available
    "performer" : [{ Reference(Practitioner) }], //Who is responsible for the observation
    "valueQuantity" : { Quantity }, //HDL Cholesterol value
    "dataAbsentReason" : { CodeableConcept }, //Why the result is missing
    "interpretation" : { CodeableConcept }, //+ | ++ | +++ | - | -- | ---
    "comment" : "<string>", //Comments about result
    "bodySite" : { CodeableConcept }, //Observed body part
    "method" : { CodeableConcept }, //How it was done
    "specimen" : { Reference(Specimen) }, //Specimen used for this observation
    "device" : { Reference(Device) }, //(Measurement) Device
    "referenceRange" : { BackboneElement }, // C? R! Provides guide for interpretation
    "component" : [{ BackboneElement }], // C?Component results
  }

 

Alternate definitions: Master Definition (XML, JSON), Schematron

10.3.11.21.2 Terminology Bindings

PathNameConformanceValueSet
Observation.languageCommon LanguagesextensibleCommon Languages
Observation.statusObservationStatusrequiredObservationStatus
Observation.categoryObservation Category CodespreferredObservation Category Codes
Observation.codeLOINC CodesexampleLOINC Codes
Observation.dataAbsentReasonDataAbsentReasonextensibleDataAbsentReason
Observation.interpretationObservation Interpretation CodesextensibleObservation Interpretation Codes
Observation.bodySiteSNOMED CT Body StructuresexampleSNOMED CT Body Structures
Observation.methodObservation MethodsexampleObservation Methods
Observation.component.codeLOINC CodesexampleLOINC Codes
Observation.component.dataAbsentReasonDataAbsentReasonextensibleDataAbsentReason
Observation.component.interpretationObservation Interpretation CodesextensibleObservation Interpretation Codes
.