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

StructureDefinition: stdqty

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/observation-hspc-standardlabobs-quantitative-stdqty

StandardLabObs is the base Model for standard laboratory test results/observations such as hematology, chemistry, coagulation, serology and blood bank. This model will not be used for microbiology, and anatomic pathology data

This profile was published on Wed, Feb 18, 2015 00:00+1100 as a draft by HSPC. Use the Review Spreadsheet to comment on this profile.

This profile specifies that the value of the Observation resource must be a valid Observation as defined in the data dictionary HSPC Quantitative Labs dictionary.

Formal Views of Profile Content

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

This structure is derived from observation-hspc-standardlabobs-std.

Summary

Terminology Bindings

  • Observation.code SHALL come from Standard LOINC codes (Extensible)
  • Observation.interpretation SHALL come from See CEM (todo) (Extensible)

Required/Prohibited Elements

  • The element Observation.valueQuantity.value is required
  • The element Observation.valueQuantity.units is required
  • The element Observation.valueQuantity.system is required
  • The element Observation.valueQuantity.code is required
  • The element Observation.referenceRange is required
  • The element Observation.referenceRange.low is prohibited
  • The element Observation.referenceRange.high is prohibited
  • The element Observation.referenceRange.meaning is prohibited
  • The element Observation.referenceRange.age is prohibited
  • The element Observation.referenceRange.text is required

Fixed Values

  • The element Observation.valueQuantity.system value has been fixed to http://unitsofmeasure.org

This structure is derived from observation-hspc-standardlabobs-std.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I1..1Observationinv-1: Must have either a value or a dataAbsentReason but not both
... code Binding: HSPC-Quantitative-Observations (extensible)
... valueQuantity I0..1Quantity
.... value 1..1
.... units 1..1
.... system 1..1uriFixed Value: http://unitsofmeasure.org
.... code 1..1
... dataAbsentReason I0..1
... interpretation 0..1Binding: CEM_AbnormalInterpretation (extensible)
... referenceRange 1..1
.... low 0..0
.... high 0..0
.... meaning 0..0
.... age 0..0
.... text 1..1
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I1..1ObservationMeasurements and simple assertions
obs-6: Shall only be present if Observation.value[x] is not present
inv-1: Must have either a value or a dataAbsentReason but not both
... meta 0..1MetaMetadata about the resource
... implicitRules ?!0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Language (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... hspc-ReportingPriority 0..1codeExtension
... hspc-DeltaFlag 0..1codeExtension
... hspc-Verified 0..1booleanExtension
... hspc-Updated 0..1dateTimeExtension
... indirectTarget 0..1Patient, Group, LocationExtension
... modifierExtension 0..*ExtensionExtensions that cannot be ignored
... code Σ1..1CodeableConceptType of observation (code / type)
Binding: HSPC-Quantitative-Observations (extensible)
... valueQuantity Σ0..1QuantityActual result
Binding: ObservationValue (example)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... value 1..1decimalNumerical value (with implicit precision)
.... comparator ?!0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required)
.... units 1..1stringUnit representation
.... system I1..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
.... code 1..1codeCoded form of the unit
... dataAbsentReason I0..1CodeableConceptWhy the result is missing
Binding: ObservationValueAbsentReason (extensible)
... interpretation 0..1CodeableConceptHigh, low, normal, etc.
Binding: CEM_AbnormalInterpretation (extensible)
... comments 0..1stringComments about result
... issued Σ0..1instantDate/Time this was made available
... status ?! Σ1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required)
... reliability ?!0..1codeok | ongoing | early | questionable | calibrating | error +
Binding: ObservationReliability (required)
Fixed Value: ok
... subject Σ1..1Patient, Group, Device, LocationWho and/or what this is about
... specimen 0..1hspc-SpecimenSpecimen used for this observation
... performer ΣPractitioner, Organization, Patient, RelatedPersonWho did the observation
Slice: Ordered, Closed, by performer.type
... performer Σ0..*hspc-ResponsibleObserverthe individual with the primary responsibility for the procedure or action being taken
... performer Σ0..1hspc-PerformingLaboratoryname and address of the laboratory that performs the test
... device 0..1Device, DeviceMetric(Measurement) Device
... encounter 0..1EncounterHealthcare event during which this observation is made
... referenceRange I1..1Provides guide for interpretation
obs-3: Must have at least a low or a high or text
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... text 1..1stringText based reference range in an observation

todo

This structure is derived from observation-hspc-standardlabobs-std.

Summary

Terminology Bindings

  • Observation.code SHALL come from Standard LOINC codes (Extensible)
  • Observation.interpretation SHALL come from See CEM (todo) (Extensible)

Required/Prohibited Elements

  • The element Observation.valueQuantity.value is required
  • The element Observation.valueQuantity.units is required
  • The element Observation.valueQuantity.system is required
  • The element Observation.valueQuantity.code is required
  • The element Observation.referenceRange is required
  • The element Observation.referenceRange.low is prohibited
  • The element Observation.referenceRange.high is prohibited
  • The element Observation.referenceRange.meaning is prohibited
  • The element Observation.referenceRange.age is prohibited
  • The element Observation.referenceRange.text is required

Fixed Values

  • The element Observation.valueQuantity.system value has been fixed to http://unitsofmeasure.org

Differential View

This structure is derived from observation-hspc-standardlabobs-std.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I1..1Observationinv-1: Must have either a value or a dataAbsentReason but not both
... code Binding: HSPC-Quantitative-Observations (extensible)
... valueQuantity I0..1Quantity
.... value 1..1
.... units 1..1
.... system 1..1uriFixed Value: http://unitsofmeasure.org
.... code 1..1
... dataAbsentReason I0..1
... interpretation 0..1Binding: CEM_AbnormalInterpretation (extensible)
... referenceRange 1..1
.... low 0..0
.... high 0..0
.... meaning 0..0
.... age 0..0
.... text 1..1

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I1..1ObservationMeasurements and simple assertions
obs-6: Shall only be present if Observation.value[x] is not present
inv-1: Must have either a value or a dataAbsentReason but not both
... meta 0..1MetaMetadata about the resource
... implicitRules ?!0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Language (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... hspc-ReportingPriority 0..1codeExtension
... hspc-DeltaFlag 0..1codeExtension
... hspc-Verified 0..1booleanExtension
... hspc-Updated 0..1dateTimeExtension
... indirectTarget 0..1Patient, Group, LocationExtension
... modifierExtension 0..*ExtensionExtensions that cannot be ignored
... code Σ1..1CodeableConceptType of observation (code / type)
Binding: HSPC-Quantitative-Observations (extensible)
... valueQuantity Σ0..1QuantityActual result
Binding: ObservationValue (example)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... value 1..1decimalNumerical value (with implicit precision)
.... comparator ?!0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required)
.... units 1..1stringUnit representation
.... system I1..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
.... code 1..1codeCoded form of the unit
... dataAbsentReason I0..1CodeableConceptWhy the result is missing
Binding: ObservationValueAbsentReason (extensible)
... interpretation 0..1CodeableConceptHigh, low, normal, etc.
Binding: CEM_AbnormalInterpretation (extensible)
... comments 0..1stringComments about result
... issued Σ0..1instantDate/Time this was made available
... status ?! Σ1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required)
... reliability ?!0..1codeok | ongoing | early | questionable | calibrating | error +
Binding: ObservationReliability (required)
Fixed Value: ok
... subject Σ1..1Patient, Group, Device, LocationWho and/or what this is about
... specimen 0..1hspc-SpecimenSpecimen used for this observation
... performer ΣPractitioner, Organization, Patient, RelatedPersonWho did the observation
Slice: Ordered, Closed, by performer.type
... performer Σ0..*hspc-ResponsibleObserverthe individual with the primary responsibility for the procedure or action being taken
... performer Σ0..1hspc-PerformingLaboratoryname and address of the laboratory that performs the test
... device 0..1Device, DeviceMetric(Measurement) Device
... encounter 0..1EncounterHealthcare event during which this observation is made
... referenceRange I1..1Provides guide for interpretation
obs-3: Must have at least a low or a high or text
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... text 1..1stringText based reference range in an observation

XML Template

JSON Template

todo

 

Other representations of profile: (todo)

Terminology Bindings

PathNameConformanceValueSet
Observation.languageLanguagerequiredhttp://tools.ietf.org/html/bcp47
Observation.codeHSPC-Quantitative-ObservationsextensibleHSPC Quantitative Labs
Observation.valueQuantityObservationValueexampleSNOMED CT Codes
Observation.valueQuantity.comparatorQuantityComparatorrequiredQuantityComparator
Observation.dataAbsentReasonObservationValueAbsentReasonextensibleObservation Value Absent Reason
Observation.interpretationCEM_AbnormalInterpretationextensibleAbnormalInterpretation
Observation.statusObservationStatusrequiredObservationStatus
Observation.reliabilityObservationReliabilityrequiredObservationReliability
Observation.bodySite[x]BodySiteexampleSNOMED CT Body Structures
Observation.methodObservationMethodexampleObservation Methods
Observation.referenceRange.meaningObservationRangeMeaningexampleObservation Reference Range Meaning Codes
Observation.related.typeObservationRelationshipTyperequiredObservationRelationshipType

Constraints

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