Release 4B Snapshot 3: Connectathon 32 Base

This page is part of the FHIR Specification (v4.3.0: R4B - STU (v5.0.0-snapshot3: R5 Snapshot #3, to support Connectathon 32 ). 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.13.32 10.3.13.21 StructureDefinition: Example Lipid Profile

Orders and Observations icon Work Group   Maturity Level : 0 Trial Use Use Context : Any Not yet ready for Production use, Not yet ready for Production use

The official canonical 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 Feb 21, 2015 00:00+1100 as a draft by Health Level Seven, Inc. - FHIR WG.

10.3.13.32.1 10.3.13.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 indicates the differences between this profile and the base Observation . structure.

Name icon Flags icon Card. icon Type icon Description & Constraints icon doco icon
. . Observation 1..1 Observation HDL Cholesterol Result
. . . code S 1..1 CodeableConcept HDL Cholesterol
Fixed Value: As shown
. . . . coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
. . . . . system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
. . . . . code 1..1 code Symbol in syntax defined by the system
Fixed Value: 2085-9
. . . . . display 1..1 string Representation defined by the system
Fixed Value: HDL Cholesterol
. . . valueQuantity S 0..1 Quantity HDL Cholesterol value
. . . interpretation S 0..1 CodeableConcept + | ++ | +++ | - | -- | ---
. . . referenceRange S 1..1 BackboneElement Provides guide for interpretation
. . . . low 1..1 SimpleQuantity A fixed quantity (no comparator)
Fixed Value: As shown
. . . . . value 1..1 decimal Numerical value (with implicit precision)
Fixed 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 icon

This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base Observation structure.

Quantity
Name icon Flags icon Card. icon Type icon Description & Constraints icon doco icon
. . Observation I C icon 1..1 Observation HDL Cholesterol Result
. . . id Σ 0..1 id Logical id of this artifact
. . . meta Σ 0..1 Meta Metadata about the resource
. . . implicitRules ?! Σ 0..1 uri A set of rules under which this content was created
. . . language 0..1 code Language of the resource content
Binding: Common Languages ( preferred ): IETF language tag

Additional Bindings Purpose
All Languages Max Binding
. . . text 0..1 Narrative Text summary of the resource, for human interpretation
. . . contained 0..* Resource Contained, inline Resources
. . . extension 0..* Extension Additional content defined by implementations
. . . modifierExtension ?! Σ 0..* Extension Extensions that cannot be ignored
. . . identifier Σ 0..* Identifier Business Identifier for observation
. . . instantiates[x] Σ 0..1 canonical ( ObservationDefinition ), Reference ( ObservationDefinition ) Instantiates FHIR ObservationDefinition
... basedOn Σ 0..* Reference ( CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest ) Fulfills plan, proposal or order
. . . triggeredBy 0..* BackboneElement Triggering observation(s)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?! Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... observation Σ 1..1 Reference ( Observation ) Triggering observation
.... type Σ 1..1 code reflex | repeat | re-run
Binding: triggeredBytype ( required ): The type of TriggeredBy Observation.

.... reason 0..1 string Reason that the observation was triggered
. . . partOf Σ 0..* Reference ( MedicationAdministration | MedicationDispense | MedicationStatement MedicationUsage | Procedure | Immunization | ImagingStudy | GenomicStudy ) Part of referenced event
. . . status ?! Σ 1..1 code registered | preliminary | final | amended +
Binding: ObservationStatus ( required ): Codes providing the status of an observation.

. . . category 0..* CodeableConcept Classification of type of observation
Binding: Observation Category Codes ( preferred ): Codes for high level observation categories.


. . . code S Σ 1..1 CodeableConcept HDL Cholesterol
Binding: LOINC Codes ( example ): Codes identifying names of simple observations.


Fixed Value: As shown
. . . . id 0..0 string Unique id for inter-element referencing
. . . . extension 0..0 Extension Additional content defined by implementations
. . . . coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
. . . . . id 0..0 string Unique id for inter-element referencing
. . . . . extension 0..0 Extension Additional content defined by implementations
. . . . . system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
. . . . . version 0..0 string Version of the system - if relevant
. . . . . code 1..1 code Symbol in syntax defined by the system
Fixed Value: 2085-9
. . . . . display 1..1 string Representation defined by the system
Fixed Value: HDL Cholesterol
. . . . . userSelected 0..0 boolean If this coding was chosen directly by the user
. . . . text 0..0 string Plain text representation of the concept
. . . subject Σ 0..1 Reference ( Patient | Group | Device | Location | Organization | Procedure | Practitioner | Medication | Substance | BiologicallyDerivedProduct | NutritionProduct ) Who and/or what the observation is about
. . . focus Σ TU 0..* Reference ( Resource ) What the observation is about, when it is not about the subject of record
. . . encounter Σ 0..1 Reference ( Encounter ) Healthcare event during which this observation is made
. . . effective[x] Σ 0..1 Clinically relevant time/time-period for observation
. . . . effectiveDateTime dateTime
. . . . effectivePeriod Period
. . . . effectiveTiming Timing
. . . . effectiveInstant instant
. . . issued Σ 0..1 instant Date/Time this version was made available
. . . performer Σ 0..* Reference ( Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson ) Who is responsible for the observation
. . . Slices for value[x] Σ I C icon 0 .. 1 Actual result
Slice: Unordered, Closed Open by type:$this
. . . . valueQuantity Quantity
.... valueCodeableConcept CodeableConcept
.... valueString string
.... valueBoolean boolean
.... valueInteger integer
.... valueRange Range
.... valueRatio Ratio
.... valueSampledData SampledData
.... valueTime time
.... valueDateTime dateTime
.... valuePeriod Period
.... valueAttachment Attachment
. . . . value[x]:valueQuantity S Σ I C icon 0..1 Quantity HDL Cholesterol value
. . . dataAbsentReason I C icon 0..1 CodeableConcept Why the result is missing
Binding: DataAbsentReason ( extensible ): Codes specifying why the result ( Observation.value[x] ) is missing.

. . . interpretation S 0..1 CodeableConcept + | ++ | +++ | - | -- | ---
Binding: Observation Interpretation Codes ( extensible ): Codes identifying interpretations of observations.


. . . note S 0..* Annotation Comments about result
. . . bodySite 0..1 CodeableConcept Observed body part
Binding: SNOMED CT Body Structures ( example ): SNOMED CT Body site concepts

. . method . bodyStructure C icon 0..1 Reference ( BodyStructure ) Observed body structure
... method 0..1 CodeableConcept How it was done
Binding: Observation Methods ( example ): Methods for simple observations.

. . . specimen C icon 0..1 Reference ( Specimen | Group ) Specimen used for this observation
. . . device 0..1 Reference ( Device | DeviceMetric ) (Measurement) Device
. . . referenceRange S I C icon 1..1 BackboneElement Provides guide for interpretation
. . . . id 0..1 string Unique id for inter-element referencing
. . . . extension 0..* Extension Additional content defined by implementations
. . . . modifierExtension ?! Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . low I C icon 1..1 SimpleQuantity A fixed quantity (no comparator)
Fixed Value: As shown
. . . . . id 0..0 string Unique id for inter-element referencing
. . . . . extension 0..0 Extension Additional content defined by implementations
. . . . . value 1..1 decimal Numerical value (with implicit precision)
Fixed Value: 1.5
. . . . . comparator 0..0 code < | <= | >= | > | ad - how to understand the value
. . . . . unit 0..0 string Unit representation
. . . . . system 0..0 uri System that defines coded unit form
. . . . . code 0..0 code Coded form of the unit
. . . . normalValue C icon 0..1 CodeableConcept Normal value, if relevant
Binding: Observation Reference Range Normal Value Codes ( extensible ): Codes identifying the normal value of the observation.

. . . . text 0..1 string Text based reference range in an observation
. . . component Σ 0..* BackboneElement Component results
. . . . id 0..1 string Unique id for inter-element referencing
. . . . extension 0..* Extension Additional content defined by implementations
. . . . modifierExtension ?! Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINC Codes ( example ): Codes identifying names of simple observations.

. . . . value[x] Σ 0..1 Actual component result
. . . . . valueQuantity Quantity
. . . . . valueCodeableConcept CodeableConcept
. . . . . valueString string
. . . . . valueBoolean boolean
. . . . . valueInteger integer
. . . . . valueRange Range
. . . . . valueRatio Ratio
. . . . . valueSampledData SampledData
. . . . . valueTime time
. . . . . valueDateTime dateTime
. . . . . valuePeriod Period
. . . . . valueAttachment Attachment
. . . . dataAbsentReason I C icon 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason ( extensible ): Codes specifying why the result ( Observation.value[x] ) is missing.

. . . . interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: Observation Interpretation Codes ( extensible ): Codes identifying interpretations of observations.


. . . . referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result

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

<Observation xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
 <</meta>
 <
 <
 <

 <meta><!-- I 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- I 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- I 0..1 Language of the resource content   -->
 <text><!-- I 0..1 Narrative 

     Text summary of the resource, for human interpretation --></text>
 <</contained>

 <contained><!-- 0..* Resource Contained, inline Resources --></contained>

 <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension>
 <

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <identifier><!-- I 0..* Identifier 

     Business Identifier for observation --></identifier>
 <</basedOn>
 <</partOf>
 <
 <</category>
 <</code>
 <

 <instantiates[x]><!-- I 0..1 canonical|Reference(ObservationDefinition) 
     Instantiates FHIR ObservationDefinition --></instantiates[x]>
 <basedOn><!-- I 0..* Reference(CarePlan) Fulfills plan, proposal or order --></basedOn>
 <triggeredBy> I 0..* BackboneElement  <!-- I 0..* Triggering observation(s) -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <observation><!-- I 1..1 Reference(Observation) 
      Triggering observation --></observation>
  <type value="[code]"/><!-- I 1..1 reflex | repeat | re-run   -->
  <reason value="[string]"/><!-- I 0..1 Reason that the observation was triggered -->
 </triggeredBy>
 <partOf><!-- I 0..* Reference(MedicationAdministration) Part of referenced event --></partOf>
 <status value="[code]"/><!-- I 1..1 registered | preliminary | final | amended +   -->
 <category><!-- I 0..* CodeableConcept Classification of  type of observation   --></category>
 <code><!-- I 1..1 CodeableConcept HDL Cholesterol   --></code>
 <subject><!-- I 0..1 Reference(Patient) 

     Who and/or what the observation is about --></subject>
 <

 <focus><!-- I 0..* Reference(Resource) 

     What the observation is about, when it is not about the subject of record --></focus>
 <

 <encounter><!-- I 0..1 Reference(Encounter) 

     Healthcare event during which this observation is made --></encounter>
 <

 <effective[x]><!-- I 0..1 dateTime|Period|Timing|instant 

     Clinically relevant time/time-period for observation --></effective[x]>
 <
 <

 <issued value="[instant]"/><!-- I 0..1 Date/Time this version was made available -->
 <performer><!-- I 0..* Reference(Practitioner) 

     Who is responsible for the observation --></performer>
 
 <</valueQuantity>
 <</dataAbsentReason>
 <</interpretation>
 <</note>
 <</bodySite>
 <</method>
 <</specimen>
 <</device>
 <

 <-- value[x] sliced by type:$this  in the specified orderOpen-->
 <valueQuantity><!-- I 0..1 Quantity HDL Cholesterol value --></valueQuantity>
 <dataAbsentReason><!-- I 0..1 CodeableConcept Why the result is missing   --></dataAbsentReason>
 <interpretation><!-- I 0..1 CodeableConcept + | ++ | +++ | - | -- | ---   --></interpretation>
 <note><!-- I 0..* Annotation Comments about result --></note>
 <bodySite><!-- I 0..1 CodeableConcept Observed body part   --></bodySite>
 <bodyStructure><!-- I 0..1 Reference(BodyStructure) Observed body structure --></bodyStructure>
 <method><!-- I 0..1 CodeableConcept How it was done   --></method>
 <specimen><!-- I 0..1 Reference(Specimen) Specimen used for this observation --></specimen>
 <device><!-- I 0..1 Reference(Device) (Measurement) Device --></device>
 <referenceRange> I 1..1 BackboneElement  <!-- I 1..1 Provides guide for interpretation -->

  <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension>
  <

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <low><!-- I 1..1 Quantity 

      A fixed quantity (no comparator) --></low>
  <

  <high><!-- I 0..0 Quantity 

      High Range, if relevant --></high>
  <</type>
  <</appliesTo>
  <

  <normalValue><!-- I 0..1 CodeableConcept Normal value, if relevant   --></normalValue>
  <type><!-- I 0..0 CodeableConcept Reference range qualifier   --></type>
  <appliesTo><!-- I 0..0 CodeableConcept Reference range population   --></appliesTo>
  <age><!-- I 0..0 Range 

      Applicable age range, if relevant --></age>
  <

  <text value="[string]"/><!-- I 0..1 Text based reference range in an observation -->

 </referenceRange>
 <

 <hasMember><!-- I 0..0 Reference(Observation) 

     Related resource that belongs to the Observation group --></hasMember>
 <
     Related measurements the observation is made from</derivedFrom>
 <

 <derivedFrom><!-- I 0..0 Reference(DocumentReference) 
     Related resource from which the observation is made --></derivedFrom>
 <component> I 0..* BackboneElement  <!-- I 0..* Component results -->

  <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension>
  <</code>
  <|
    

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <code><!-- I 1..1 CodeableConcept Type of component observation (code / type)   --></code>
  <value[x]><!-- I 0..1 Quantity|CodeableConcept|string|
    boolean|integer|Range|Ratio|SampledData|time|dateTime|Period|Attachment 
      Actual component result --></value[x]>
  <</dataAbsentReason>
  <</interpretation>

  <dataAbsentReason><!-- I 0..1 CodeableConcept Why the component result is missing   --></dataAbsentReason>
  <interpretation><!-- I 0..* CodeableConcept High, low, normal, etc.   --></interpretation>

  <referenceRange><!-- See http://hl7.org/fhir/StructureDefinition/Observation#Observation.referenceRange  Provides guide for interpretation of component result --></referenceRange>
 </component>
</Observation>

{ // Example Lipid Profile
  // from Element: extension
    "
    "
    "
    "
    "

    "meta" : { Meta }, // IMetadata about the resource
    "implicitRules" : "<uri>", // IA set of rules under which this content was created
    "language" : "<code>", // ILanguage of the resource content
    "text" : { Narrative }, // IText summary of the resource, for human interpretation
    "contained" : [{ Resource }], //Contained, inline Resources

    "Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">
    "
    "
    "
    "
    "
    " 
    "
    "
    "

    "
    "
    "
    "
    "
    "
    " 
      { // 

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored
    "identifier" : [{ Identifier }], // IBusiness Identifier for observation
  // value[x]: Instantiates FHIR ObservationDefinition. One of these 2:

    "instantiatesCanonical" : "<canonical>", // IInstantiates FHIR ObservationDefinition
    "instantiatesReference" : { Reference(ObservationDefinition) }, // IInstantiates FHIR ObservationDefinition
    "basedOn" : [{ Reference(CarePlan) }], // IFulfills plan, proposal or order
    "triggeredBy" : [{ BackboneElement }], // ITriggering observation(s)
    "partOf" : [{ Reference(MedicationAdministration) }], // IPart of referenced event
    "status" : "<code>", // I R! registered | preliminary | final | amended +
    "category" : [{ CodeableConcept }], // IClassification of  type of observation
    "code" : { CodeableConcept }, // I R! 
    "subject" : { Reference(Patient) }, // IWho and/or what the observation is about
    "focus" : [{ Reference(Resource) }], // IWhat the observation is about, when it is not about the subject of record
    "encounter" : { Reference(Encounter) }, // IHealthcare event during which this observation is made
  // value[x]: Clinically relevant time/time-period for observation. One of these 4:

    "effectiveDateTime" : "<dateTime>", // IClinically relevant time/time-period for observation
    "effectivePeriod" : { Period }, // IClinically relevant time/time-period for observation
    "effectiveTiming" : { Timing }, // IClinically relevant time/time-period for observation
    "effectiveInstant" : "<instant>", // IClinically relevant time/time-period for observation
    "issued" : "<instant>", // IDate/Time this version was made available
    "performer" : [{ Reference(Practitioner) }], // IWho is responsible for the observation
    "valueQuantity" : [ //  sliced by type:$this  in the specified order, Open 
      { // HDL Cholesterol value // I

        // from Element: extension
      }
    ],
    "
    "
    "
    "
    "
    "
    "
    "
    "

    "dataAbsentReason" : { CodeableConcept }, // IWhy the result is missing
    "interpretation" : { CodeableConcept }, // I+ | ++ | +++ | - | -- | ---
    "note" : [{ Annotation }], // IComments about result
    "bodySite" : { CodeableConcept }, // IObserved body part
    "bodyStructure" : { Reference(BodyStructure) }, // IObserved body structure
    "method" : { CodeableConcept }, // IHow it was done
    "specimen" : { Reference(Specimen) }, // ISpecimen used for this observation
    "device" : { Reference(Device) }, // I(Measurement) Device
    "referenceRange" : { BackboneElement }, // I R! Provides guide for interpretation
    "component" : [{ BackboneElement }], // IComponent 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 indicates the differences between this profile and the base Observation . structure.

Name icon Flags icon Card. icon Type icon Description & Constraints icon doco icon
. . Observation 1..1 Observation HDL Cholesterol Result
. . . code S 1..1 CodeableConcept HDL Cholesterol
Fixed Value: As shown
. . . . coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
. . . . . system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
. . . . . code 1..1 code Symbol in syntax defined by the system
Fixed Value: 2085-9
. . . . . display 1..1 string Representation defined by the system
Fixed Value: HDL Cholesterol
. . . valueQuantity S 0..1 Quantity HDL Cholesterol value
. . . interpretation S 0..1 CodeableConcept + | ++ | +++ | - | -- | ---
. . . referenceRange S 1..1 BackboneElement Provides guide for interpretation
. . . . low 1..1 SimpleQuantity A fixed quantity (no comparator)
Fixed Value: As shown
. . . . . value 1..1 decimal Numerical value (with implicit precision)
Fixed 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 icon

Snapshot View

This provides the consolidated view (aka snapshot) of the profile after applying the changes in this profile to the base Observation structure.

Quantity
Name icon Flags icon Card. icon Type icon Description & Constraints icon doco icon
. . Observation I C icon 1..1 Observation HDL Cholesterol Result
. . . id Σ 0..1 id Logical id of this artifact
. . . meta Σ 0..1 Meta Metadata about the resource
. . . implicitRules ?! Σ 0..1 uri A set of rules under which this content was created
. . . language 0..1 code Language of the resource content
Binding: Common Languages ( preferred ): IETF language tag

Additional Bindings Purpose
All Languages Max Binding
. . . text 0..1 Narrative Text summary of the resource, for human interpretation
. . . contained 0..* Resource Contained, inline Resources
. . . extension 0..* Extension Additional content defined by implementations
. . . modifierExtension ?! Σ 0..* Extension Extensions that cannot be ignored
. . . identifier Σ 0..* Identifier Business Identifier for observation
. . . instantiates[x] Σ 0..1 canonical ( ObservationDefinition ), Reference ( ObservationDefinition ) Instantiates FHIR ObservationDefinition
... basedOn Σ 0..* Reference ( CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest ) Fulfills plan, proposal or order
. . . triggeredBy 0..* BackboneElement Triggering observation(s)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?! Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... observation Σ 1..1 Reference ( Observation ) Triggering observation
.... type Σ 1..1 code reflex | repeat | re-run
Binding: triggeredBytype ( required ): The type of TriggeredBy Observation.

.... reason 0..1 string Reason that the observation was triggered
. . . partOf Σ 0..* Reference ( MedicationAdministration | MedicationDispense | MedicationStatement MedicationUsage | Procedure | Immunization | ImagingStudy | GenomicStudy ) Part of referenced event
. . . status ?! Σ 1..1 code registered | preliminary | final | amended +
Binding: ObservationStatus ( required ): Codes providing the status of an observation.

. . . category 0..* CodeableConcept Classification of type of observation
Binding: Observation Category Codes ( preferred ): Codes for high level observation categories.


. . . code S Σ 1..1 CodeableConcept HDL Cholesterol
Binding: LOINC Codes ( example ): Codes identifying names of simple observations.


Fixed Value: As shown
. . . . id 0..0 string Unique id for inter-element referencing
. . . . extension 0..0 Extension Additional content defined by implementations
. . . . coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
. . . . . id 0..0 string Unique id for inter-element referencing
. . . . . extension 0..0 Extension Additional content defined by implementations
. . . . . system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
. . . . . version 0..0 string Version of the system - if relevant
. . . . . code 1..1 code Symbol in syntax defined by the system
Fixed Value: 2085-9
. . . . . display 1..1 string Representation defined by the system
Fixed Value: HDL Cholesterol
. . . . . userSelected 0..0 boolean If this coding was chosen directly by the user
. . . . text 0..0 string Plain text representation of the concept
. . . subject Σ 0..1 Reference ( Patient | Group | Device | Location | Organization | Procedure | Practitioner | Medication | Substance | BiologicallyDerivedProduct | NutritionProduct ) Who and/or what the observation is about
. . . focus Σ TU 0..* Reference ( Resource ) What the observation is about, when it is not about the subject of record
. . . encounter Σ 0..1 Reference ( Encounter ) Healthcare event during which this observation is made
. . . effective[x] Σ 0..1 Clinically relevant time/time-period for observation
. . . . effectiveDateTime dateTime
. . . . effectivePeriod Period
. . . . effectiveTiming Timing
. . . . effectiveInstant instant
. . . issued Σ 0..1 instant Date/Time this version was made available
. . . performer Σ 0..* Reference ( Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson ) Who is responsible for the observation
. . . Slices for value[x] Σ I C icon 0 .. 1 Actual result
Slice: Unordered, Closed Open by type:$this
. . . . valueQuantity Quantity
.... valueCodeableConcept CodeableConcept
.... valueString string
.... valueBoolean boolean
.... valueInteger integer
.... valueRange Range
.... valueRatio Ratio
.... valueSampledData SampledData
.... valueTime time
.... valueDateTime dateTime
.... valuePeriod Period
.... valueAttachment Attachment
. . . . value[x]:valueQuantity S Σ I C icon 0..1 Quantity HDL Cholesterol value
. . . dataAbsentReason I C icon 0..1 CodeableConcept Why the result is missing
Binding: DataAbsentReason ( extensible ): Codes specifying why the result ( Observation.value[x] ) is missing.

. . . interpretation S 0..1 CodeableConcept + | ++ | +++ | - | -- | ---
Binding: Observation Interpretation Codes ( extensible ): Codes identifying interpretations of observations.


. . . note S 0..* Annotation Comments about result
. . . bodySite 0..1 CodeableConcept Observed body part
Binding: SNOMED CT Body Structures ( example ): SNOMED CT Body site concepts

. . method . bodyStructure C icon 0..1 Reference ( BodyStructure ) Observed body structure
... method 0..1 CodeableConcept How it was done
Binding: Observation Methods ( example ): Methods for simple observations.

. . . specimen C icon 0..1 Reference ( Specimen | Group ) Specimen used for this observation
. . . device 0..1 Reference ( Device | DeviceMetric ) (Measurement) Device
. . . referenceRange S I C icon 1..1 BackboneElement Provides guide for interpretation
. . . . id 0..1 string Unique id for inter-element referencing
. . . . extension 0..* Extension Additional content defined by implementations
. . . . modifierExtension ?! Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . low I C icon 1..1 SimpleQuantity A fixed quantity (no comparator)
Fixed Value: As shown
. . . . . id 0..0 string Unique id for inter-element referencing
. . . . . extension 0..0 Extension Additional content defined by implementations
. . . . . value 1..1 decimal Numerical value (with implicit precision)
Fixed Value: 1.5
. . . . . comparator 0..0 code < | <= | >= | > | ad - how to understand the value
. . . . . unit 0..0 string Unit representation
. . . . . system 0..0 uri System that defines coded unit form
. . . . . code 0..0 code Coded form of the unit
. . . . normalValue C icon 0..1 CodeableConcept Normal value, if relevant
Binding: Observation Reference Range Normal Value Codes ( extensible ): Codes identifying the normal value of the observation.

. . . . text 0..1 string Text based reference range in an observation
. . . component Σ 0..* BackboneElement Component results
. . . . id 0..1 string Unique id for inter-element referencing
. . . . extension 0..* Extension Additional content defined by implementations
. . . . modifierExtension ?! Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
. . . . code Σ 1..1 CodeableConcept Type of component observation (code / type)
Binding: LOINC Codes ( example ): Codes identifying names of simple observations.

. . . . value[x] Σ 0..1 Actual component result
. . . . . valueQuantity Quantity
. . . . . valueCodeableConcept CodeableConcept
. . . . . valueString string
. . . . . valueBoolean boolean
. . . . . valueInteger integer
. . . . . valueRange Range
. . . . . valueRatio Ratio
. . . . . valueSampledData SampledData
. . . . . valueTime time
. . . . . valueDateTime dateTime
. . . . . valuePeriod Period
. . . . . valueAttachment Attachment
. . . . dataAbsentReason I C icon 0..1 CodeableConcept Why the component result is missing
Binding: DataAbsentReason ( extensible ): Codes specifying why the result ( Observation.value[x] ) is missing.

. . . . interpretation 0..* CodeableConcept High, low, normal, etc.
Binding: Observation Interpretation Codes ( extensible ): Codes identifying interpretations of observations.


. . . . referenceRange 0..* See referenceRange (Observation) Provides guide for interpretation of component result

doco Documentation for this format icon

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>
 <
 <
 <

 <meta><!-- I 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- I 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- I 0..1 Language of the resource content   -->
 <text><!-- I 0..1 Narrative 

     Text summary of the resource, for human interpretation --></text>
 <</contained>

 <contained><!-- 0..* Resource Contained, inline Resources --></contained>

 <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension>
 <

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <identifier><!-- I 0..* Identifier 

     Business Identifier for observation --></identifier>
 <</basedOn>
 <</partOf>
 <
 <</category>
 <</code>
 <

 <instantiates[x]><!-- I 0..1 canonical|Reference(ObservationDefinition) 
     Instantiates FHIR ObservationDefinition --></instantiates[x]>
 <basedOn><!-- I 0..* Reference(CarePlan) Fulfills plan, proposal or order --></basedOn>
 <triggeredBy> I 0..* BackboneElement  <!-- I 0..* Triggering observation(s) -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <observation><!-- I 1..1 Reference(Observation) 
      Triggering observation --></observation>
  <type value="[code]"/><!-- I 1..1 reflex | repeat | re-run   -->
  <reason value="[string]"/><!-- I 0..1 Reason that the observation was triggered -->
 </triggeredBy>
 <partOf><!-- I 0..* Reference(MedicationAdministration) Part of referenced event --></partOf>
 <status value="[code]"/><!-- I 1..1 registered | preliminary | final | amended +   -->
 <category><!-- I 0..* CodeableConcept Classification of  type of observation   --></category>
 <code><!-- I 1..1 CodeableConcept HDL Cholesterol   --></code>
 <subject><!-- I 0..1 Reference(Patient) 

     Who and/or what the observation is about --></subject>
 <

 <focus><!-- I 0..* Reference(Resource) 

     What the observation is about, when it is not about the subject of record --></focus>
 <

 <encounter><!-- I 0..1 Reference(Encounter) 

     Healthcare event during which this observation is made --></encounter>
 <

 <effective[x]><!-- I 0..1 dateTime|Period|Timing|instant 

     Clinically relevant time/time-period for observation --></effective[x]>
 <
 <

 <issued value="[instant]"/><!-- I 0..1 Date/Time this version was made available -->
 <performer><!-- I 0..* Reference(Practitioner) 

     Who is responsible for the observation --></performer>
 
 <</valueQuantity>
 <</dataAbsentReason>
 <</interpretation>
 <</note>
 <</bodySite>
 <</method>
 <</specimen>
 <</device>
 <

 <-- value[x] sliced by type:$this  in the specified orderOpen-->
 <valueQuantity><!-- I 0..1 Quantity HDL Cholesterol value --></valueQuantity>
 <dataAbsentReason><!-- I 0..1 CodeableConcept Why the result is missing   --></dataAbsentReason>
 <interpretation><!-- I 0..1 CodeableConcept + | ++ | +++ | - | -- | ---   --></interpretation>
 <note><!-- I 0..* Annotation Comments about result --></note>
 <bodySite><!-- I 0..1 CodeableConcept Observed body part   --></bodySite>
 <bodyStructure><!-- I 0..1 Reference(BodyStructure) Observed body structure --></bodyStructure>
 <method><!-- I 0..1 CodeableConcept How it was done   --></method>
 <specimen><!-- I 0..1 Reference(Specimen) Specimen used for this observation --></specimen>
 <device><!-- I 0..1 Reference(Device) (Measurement) Device --></device>
 <referenceRange> I 1..1 BackboneElement  <!-- I 1..1 Provides guide for interpretation -->

  <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension>
  <

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <low><!-- I 1..1 Quantity 

      A fixed quantity (no comparator) --></low>
  <

  <high><!-- I 0..0 Quantity 

      High Range, if relevant --></high>
  <</type>
  <</appliesTo>
  <

  <normalValue><!-- I 0..1 CodeableConcept Normal value, if relevant   --></normalValue>
  <type><!-- I 0..0 CodeableConcept Reference range qualifier   --></type>
  <appliesTo><!-- I 0..0 CodeableConcept Reference range population   --></appliesTo>
  <age><!-- I 0..0 Range 

      Applicable age range, if relevant --></age>
  <

  <text value="[string]"/><!-- I 0..1 Text based reference range in an observation -->

 </referenceRange>
 <

 <hasMember><!-- I 0..0 Reference(Observation) 

     Related resource that belongs to the Observation group --></hasMember>
 <
     Related measurements the observation is made from</derivedFrom>
 <

 <derivedFrom><!-- I 0..0 Reference(DocumentReference) 
     Related resource from which the observation is made --></derivedFrom>
 <component> I 0..* BackboneElement  <!-- I 0..* Component results -->

  <Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict"></modifierExtension>
  <</code>
  <|
    

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <code><!-- I 1..1 CodeableConcept Type of component observation (code / type)   --></code>
  <value[x]><!-- I 0..1 Quantity|CodeableConcept|string|
    boolean|integer|Range|Ratio|SampledData|time|dateTime|Period|Attachment 
      Actual component result --></value[x]>
  <</dataAbsentReason>
  <</interpretation>

  <dataAbsentReason><!-- I 0..1 CodeableConcept Why the component result is missing   --></dataAbsentReason>
  <interpretation><!-- I 0..* CodeableConcept High, low, normal, etc.   --></interpretation>

  <referenceRange><!-- See http://hl7.org/fhir/StructureDefinition/Observation#Observation.referenceRange  Provides guide for interpretation of component result --></referenceRange>
 </component>
</Observation>

JSON Template 

{ // Example Lipid Profile
  // from Element: extension
    "
    "
    "
    "
    "

    "meta" : { Meta }, // IMetadata about the resource
    "implicitRules" : "<uri>", // IA set of rules under which this content was created
    "language" : "<code>", // ILanguage of the resource content
    "text" : { Narrative }, // IText summary of the resource, for human interpretation
    "contained" : [{ Resource }], //Contained, inline Resources

    "Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">
    "
    "
    "
    "
    "
    " 
    "
    "
    "

    "
    "
    "
    "
    "
    "
    " 
      { // 

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself) (this element modifies the meaning of other elements)" class="dict">modifierExtension" : [{ Extension }], // IExtensions that cannot be ignored
    "identifier" : [{ Identifier }], // IBusiness Identifier for observation
  // value[x]: Instantiates FHIR ObservationDefinition. One of these 2:

    "instantiatesCanonical" : "<canonical>", // IInstantiates FHIR ObservationDefinition
    "instantiatesReference" : { Reference(ObservationDefinition) }, // IInstantiates FHIR ObservationDefinition
    "basedOn" : [{ Reference(CarePlan) }], // IFulfills plan, proposal or order
    "triggeredBy" : [{ BackboneElement }], // ITriggering observation(s)
    "partOf" : [{ Reference(MedicationAdministration) }], // IPart of referenced event
    "status" : "<code>", // I R! registered | preliminary | final | amended +
    "category" : [{ CodeableConcept }], // IClassification of  type of observation
    "code" : { CodeableConcept }, // I R! 
    "subject" : { Reference(Patient) }, // IWho and/or what the observation is about
    "focus" : [{ Reference(Resource) }], // IWhat the observation is about, when it is not about the subject of record
    "encounter" : { Reference(Encounter) }, // IHealthcare event during which this observation is made
  // value[x]: Clinically relevant time/time-period for observation. One of these 4:

    "effectiveDateTime" : "<dateTime>", // IClinically relevant time/time-period for observation
    "effectivePeriod" : { Period }, // IClinically relevant time/time-period for observation
    "effectiveTiming" : { Timing }, // IClinically relevant time/time-period for observation
    "effectiveInstant" : "<instant>", // IClinically relevant time/time-period for observation
    "issued" : "<instant>", // IDate/Time this version was made available
    "performer" : [{ Reference(Practitioner) }], // IWho is responsible for the observation
    "valueQuantity" : [ //  sliced by type:$this  in the specified order, Open 
      { // HDL Cholesterol value // I

        // from Element: extension
      }
    ],
    "
    "
    "
    "
    "
    "
    "
    "
    "

    "dataAbsentReason" : { CodeableConcept }, // IWhy the result is missing
    "interpretation" : { CodeableConcept }, // I+ | ++ | +++ | - | -- | ---
    "note" : [{ Annotation }], // IComments about result
    "bodySite" : { CodeableConcept }, // IObserved body part
    "bodyStructure" : { Reference(BodyStructure) }, // IObserved body structure
    "method" : { CodeableConcept }, // IHow it was done
    "specimen" : { Reference(Specimen) }, // ISpecimen used for this observation
    "device" : { Reference(Device) }, // I(Measurement) Device
    "referenceRange" : { BackboneElement }, // I R! Provides guide for interpretation
    "component" : [{ BackboneElement }], // IComponent results

  }

 

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

10.3.13.32.2 10.3.13.21.2 Terminology Bindings

Path Name Conformance ValueSet
Observation.language Common Languages preferred Common Languages
Observation.triggeredBy.type triggeredBytype required triggeredBytype
Observation.status ObservationStatus required ObservationStatus
Observation.category Observation Category Codes preferred Observation Category Codes
Observation.code LOINC Codes example LOINC Codes
Observation.dataAbsentReason DataAbsentReason extensible DataAbsentReason
Observation.interpretation Observation Interpretation Codes extensible Observation Interpretation Codes
Observation.bodySite SNOMED CT Body Structures example SNOMED CT Body Structures
Observation.method Observation Methods example Observation Methods
Observation.referenceRange.normalValue Observation Reference Range Normal Value Codes extensible Observation Reference Range Normal Value Codes
Observation.component.code LOINC Codes example LOINC Codes
Observation.component.dataAbsentReason DataAbsentReason extensible DataAbsentReason
Observation.component.interpretation Observation Interpretation Codes extensible Observation Interpretation Codes
.