Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - see ballot notes). 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.7 StructureDefinition: Example Lipid Profile

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

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

10.3.13.7.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: 7 elements

This indicates the differences between this profile and the base Observation structure.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 1..1ObservationMeasurements and simple assertions
... code S1..1CodeableConceptCholesterol
Fixed Value: As shown
.... coding1..1CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 35200-5
..... display1..1stringRepresentation defined by the system
Fixed Value: Cholesterol [Moles/​volume] in Serum or Plasma
... valueQuantity S0..1QuantityCholesterol value
.... value S0..1decimalActual numerical value
.... comparator 0..0
.... unit S1..1stringUnit representation
Fixed Value: mmol/L
.... system S1..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
.... code S1..1codeCoded form of the unit
Fixed Value: mmol/L
... interpretation S0..1CodeableConcept+ | ++ | +++ | - | -- | ---
... referenceRange S1..1BackboneElementProvides guide for interpretation
.... low 0..0
.... high 1..1SimpleQuantityA fixed quantity (no comparator)
Fixed Value: As shown
..... value1..1decimalNumerical value (with implicit precision)
Fixed Value: 4.5
.... type 0..0
.... appliesTo 0..0
.... age 0..0
... hasMember 0..0
... derivedFrom 0..0

doco Documentation for this format

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C icon1..1ObservationMeasurements and simple assertions
... 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 (preferred): IETF language tag

Additional BindingsPurpose
All LanguagesMax Binding
... text 0..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
... instantiates[x] Σ0..1canonical(ObservationDefinition), Reference(ObservationDefinition)Instantiates FHIR ObservationDefinition
... basedOn Σ0..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)Fulfills plan, proposal or order
... triggeredBy 0..*BackboneElementTriggering observation(s)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... observation Σ1..1Reference(Observation)Triggering observation
.... type Σ1..1codereflex | repeat | re-run
Binding: triggeredBytype (required): The type of TriggeredBy Observation.

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

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


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


Fixed Value: As shown
.... id0..0idUnique id for inter-element referencing
.... extension0..0ExtensionAdditional content defined by implementations
.... coding1..1CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..0idUnique id for inter-element referencing
..... extension0..0ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
..... version0..0stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 35200-5
..... display1..1stringRepresentation defined by the system
Fixed Value: Cholesterol [Moles/​volume] in Serum or Plasma
..... userSelected0..0booleanIf this coding was chosen directly by the user
.... text0..0stringPlain text representation of the concept
... subject Σ0..1Reference(Patient | Group | Device | Location | Organization | Procedure | Practitioner | Medication | Substance | BiologicallyDerivedProduct | NutritionProduct)Who and/or what the observation is about
... focus Σ0..*Reference(Resource)What the observation is about, when it is not about the subject of record
... encounter Σ0..1Reference(Encounter)Healthcare event during which this observation is made
... effective[x] Σ0..1Clinically relevant time/time-period for observation
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
.... effectiveTimingTiming
.... effectiveInstantinstant
... issued Σ0..1instantDate/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] ΣC icon0..1QuantityActual result
Slice: Unordered, Closed by type:$this
.... value[x]:valueQuantity SΣC icon0..1QuantityCholesterol value
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... value SΣ0..1decimalActual numerical value
..... unit SΣ1..1stringUnit representation
Fixed Value: mmol/L
..... system SΣC icon1..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
..... code SΣ1..1codeCoded form of the unit
Fixed Value: mmol/L
... dataAbsentReason C icon0..1CodeableConceptWhy the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

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


... note S0..*AnnotationComments about result
... bodySite 0..1CodeableConceptObserved body part
Binding: SNOMED CT Body Structures (example): SNOMED CT Body site concepts

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

... specimen C icon0..1Reference(Specimen | Group)Specimen used for this observation
... device 0..1Reference(Device | DeviceMetric)(Measurement) Device
... referenceRange SC icon1..1BackboneElementProvides guide for interpretation
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... high C icon1..1SimpleQuantityA fixed quantity (no comparator)
Fixed Value: As shown
..... id0..0idUnique id for inter-element referencing
..... extension0..0ExtensionAdditional content defined by implementations
..... value1..1decimalNumerical value (with implicit precision)
Fixed Value: 4.5
..... comparator0..0code< | <= | >= | > | ad - how to understand the value
..... unit0..0stringUnit representation
..... system0..0uriSystem that defines coded unit form
..... code0..0codeCoded form of the unit
.... normalValue C icon0..1CodeableConceptNormal value, if relevant
Binding: Observation Reference Range Normal Value Codes (extensible): Codes identifying the normal value of the observation.

.... text 0..1stringText based reference range in an observation
... component Σ0..*BackboneElementComponent results
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINC Codes (example): Codes identifying names of simple observations.

.... value[x] Σ0..1Actual component result
..... valueQuantityQuantity
..... valueCodeableConceptCodeableConcept
..... valueStringstring
..... valueBooleanboolean
..... valueIntegerinteger
..... valueRangeRange
..... valueRatioRatio
..... valueSampledDataSampledData
..... valueTimetime
..... valueDateTimedateTime
..... valuePeriodPeriod
..... valueAttachmentAttachment
.... dataAbsentReason C icon0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

.... interpretation 0..*CodeableConceptHigh, 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
<!-- Example Lipid Profile -->doco

<Observation xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
 <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><!-- 0..* Resource Contained, inline Resources --></contained>
 <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <identifier><!-- I 0..* Identifier 
     Business Identifier for observation --></identifier>
 <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 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 sliced by type:$this  in the specified orderClosed-->
 <valueQuantity> I 0..1 Quantity  <!-- I 0..1 Cholesterol value -->
  <value value="[decimal]"/><!-- I 0..1 Actual numerical value -->
  <comparator value="[code]"/><!-- I 0..0 < | <= | >= | > | ad - how to understand the value   -->
  <unit value="[string]"/><!-- I 1..1 Unit representation -->
  <system value="[uri]"/><!-- I 1..1 System that defines coded unit form -->
  <code value="[code]"/><!-- I 1..1 Coded form of the unit -->
 </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 -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <low><!-- I 0..0 Quantity 
      Low Range, if relevant --></low>
  <high><!-- I 1..1 Quantity 
      A fixed quantity (no comparator) --></high>
  <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>
 <derivedFrom><!-- I 0..0 Reference(DocumentReference) 
     Related resource from which the observation is made --></derivedFrom>
 <component> I 0..* BackboneElement  <!-- I 0..* Component results -->
  <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><!-- 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
    "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, Closed 
      { // Cholesterol value // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "value" : <decimal>, // IActual numerical value
        "unit" : "mmol/L", // I R! 
        "system" : "http://unitsofmeasure.org", // I R! 
        "code" : "mmol/L" // I R! 
      }
    ],
    "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 (+3 nested mandatory elements)
Must-Support: 9 elements
Fixed Value: 5 elements
Prohibited: 7 elements

Differential View

This indicates the differences between this profile and the base Observation structure.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 1..1ObservationMeasurements and simple assertions
... code S1..1CodeableConceptCholesterol
Fixed Value: As shown
.... coding1..1CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 35200-5
..... display1..1stringRepresentation defined by the system
Fixed Value: Cholesterol [Moles/​volume] in Serum or Plasma
... valueQuantity S0..1QuantityCholesterol value
.... value S0..1decimalActual numerical value
.... comparator 0..0
.... unit S1..1stringUnit representation
Fixed Value: mmol/L
.... system S1..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
.... code S1..1codeCoded form of the unit
Fixed Value: mmol/L
... interpretation S0..1CodeableConcept+ | ++ | +++ | - | -- | ---
... referenceRange S1..1BackboneElementProvides guide for interpretation
.... low 0..0
.... high 1..1SimpleQuantityA fixed quantity (no comparator)
Fixed Value: As shown
..... value1..1decimalNumerical value (with implicit precision)
Fixed Value: 4.5
.... type 0..0
.... appliesTo 0..0
.... age 0..0
... hasMember 0..0
... derivedFrom 0..0

doco Documentation for this format

Snapshot View

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation C icon1..1ObservationMeasurements and simple assertions
... 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 (preferred): IETF language tag

Additional BindingsPurpose
All LanguagesMax Binding
... text 0..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
... instantiates[x] Σ0..1canonical(ObservationDefinition), Reference(ObservationDefinition)Instantiates FHIR ObservationDefinition
... basedOn Σ0..*Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ServiceRequest)Fulfills plan, proposal or order
... triggeredBy 0..*BackboneElementTriggering observation(s)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... observation Σ1..1Reference(Observation)Triggering observation
.... type Σ1..1codereflex | repeat | re-run
Binding: triggeredBytype (required): The type of TriggeredBy Observation.

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

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


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


Fixed Value: As shown
.... id0..0idUnique id for inter-element referencing
.... extension0..0ExtensionAdditional content defined by implementations
.... coding1..1CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..0idUnique id for inter-element referencing
..... extension0..0ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
..... version0..0stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 35200-5
..... display1..1stringRepresentation defined by the system
Fixed Value: Cholesterol [Moles/​volume] in Serum or Plasma
..... userSelected0..0booleanIf this coding was chosen directly by the user
.... text0..0stringPlain text representation of the concept
... subject Σ0..1Reference(Patient | Group | Device | Location | Organization | Procedure | Practitioner | Medication | Substance | BiologicallyDerivedProduct | NutritionProduct)Who and/or what the observation is about
... focus Σ0..*Reference(Resource)What the observation is about, when it is not about the subject of record
... encounter Σ0..1Reference(Encounter)Healthcare event during which this observation is made
... effective[x] Σ0..1Clinically relevant time/time-period for observation
.... effectiveDateTimedateTime
.... effectivePeriodPeriod
.... effectiveTimingTiming
.... effectiveInstantinstant
... issued Σ0..1instantDate/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] ΣC icon0..1QuantityActual result
Slice: Unordered, Closed by type:$this
.... value[x]:valueQuantity SΣC icon0..1QuantityCholesterol value
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... value SΣ0..1decimalActual numerical value
..... unit SΣ1..1stringUnit representation
Fixed Value: mmol/L
..... system SΣC icon1..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
..... code SΣ1..1codeCoded form of the unit
Fixed Value: mmol/L
... dataAbsentReason C icon0..1CodeableConceptWhy the result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

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


... note S0..*AnnotationComments about result
... bodySite 0..1CodeableConceptObserved body part
Binding: SNOMED CT Body Structures (example): SNOMED CT Body site concepts

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

... specimen C icon0..1Reference(Specimen | Group)Specimen used for this observation
... device 0..1Reference(Device | DeviceMetric)(Measurement) Device
... referenceRange SC icon1..1BackboneElementProvides guide for interpretation
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... high C icon1..1SimpleQuantityA fixed quantity (no comparator)
Fixed Value: As shown
..... id0..0idUnique id for inter-element referencing
..... extension0..0ExtensionAdditional content defined by implementations
..... value1..1decimalNumerical value (with implicit precision)
Fixed Value: 4.5
..... comparator0..0code< | <= | >= | > | ad - how to understand the value
..... unit0..0stringUnit representation
..... system0..0uriSystem that defines coded unit form
..... code0..0codeCoded form of the unit
.... normalValue C icon0..1CodeableConceptNormal value, if relevant
Binding: Observation Reference Range Normal Value Codes (extensible): Codes identifying the normal value of the observation.

.... text 0..1stringText based reference range in an observation
... component Σ0..*BackboneElementComponent results
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ1..1CodeableConceptType of component observation (code / type)
Binding: LOINC Codes (example): Codes identifying names of simple observations.

.... value[x] Σ0..1Actual component result
..... valueQuantityQuantity
..... valueCodeableConceptCodeableConcept
..... valueStringstring
..... valueBooleanboolean
..... valueIntegerinteger
..... valueRangeRange
..... valueRatioRatio
..... valueSampledDataSampledData
..... valueTimetime
..... valueDateTimedateTime
..... valuePeriodPeriod
..... valueAttachmentAttachment
.... dataAbsentReason C icon0..1CodeableConceptWhy the component result is missing
Binding: DataAbsentReason (extensible): Codes specifying why the result (Observation.value[x]) is missing.

.... interpretation 0..*CodeableConceptHigh, 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

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><!-- 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><!-- 0..* Resource Contained, inline Resources --></contained>
 <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <identifier><!-- I 0..* Identifier 
     Business Identifier for observation --></identifier>
 <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 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 sliced by type:$this  in the specified orderClosed-->
 <valueQuantity> I 0..1 Quantity  <!-- I 0..1 Cholesterol value -->
  <value value="[decimal]"/><!-- I 0..1 Actual numerical value -->
  <comparator value="[code]"/><!-- I 0..0 < | <= | >= | > | ad - how to understand the value   -->
  <unit value="[string]"/><!-- I 1..1 Unit representation -->
  <system value="[uri]"/><!-- I 1..1 System that defines coded unit form -->
  <code value="[code]"/><!-- I 1..1 Coded form of the unit -->
 </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 -->
  <modifierExtension><!-- I 0..* Extension  Extensions that cannot be ignored even if unrecognized  --></modifierExtension>
  <low><!-- I 0..0 Quantity 
      Low Range, if relevant --></low>
  <high><!-- I 1..1 Quantity 
      A fixed quantity (no comparator) --></high>
  <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>
 <derivedFrom><!-- I 0..0 Reference(DocumentReference) 
     Related resource from which the observation is made --></derivedFrom>
 <component> I 0..* BackboneElement  <!-- I 0..* Component results -->
  <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><!-- 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
    "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, Closed 
      { // Cholesterol value // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "value" : <decimal>, // IActual numerical value
        "unit" : "mmol/L", // I R! 
        "system" : "http://unitsofmeasure.org", // I R! 
        "code" : "mmol/L" // I R! 
      }
    ],
    "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.7.2 Terminology Bindings

PathNameConformanceValueSet
Observation.languageCommon LanguagespreferredCommon Languages
Observation.triggeredBy.typetriggeredBytyperequiredtriggeredBytype
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.referenceRange.normalValueObservation Reference Range Normal Value CodesextensibleObservation Reference Range Normal Value Codes
Observation.component.codeLOINC CodesexampleLOINC Codes
Observation.component.dataAbsentReasonDataAbsentReasonextensibleDataAbsentReason
Observation.component.interpretationObservation Interpretation CodesextensibleObservation Interpretation Codes
.