DSTU2 Ballot Source

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

4.20.16.3 StructureDefinition: USLabObsQuantity

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/obs-uslab-uslabobsquantity

US Realm laboratory result using Quantity Data Type for numeric results

This profile was published on Mon, Nov 17, 2014 00:00+1100 as a draft by HL7 International - Orders and Observations WG.

4.20.16.3.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: 28 elements, Must-Support: 49 elements, Fixed Value: 5 elements, Prohibited: 2 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Observation.performer is sliced based on the value of type@profile (ordered, Open At End)

This structure is derived from Observation.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 1..1ObservationUS Realm laboratory result using Quantity Data Type for numeric results
... code S1..1US Realm Laboratory Test Name
Binding: USLabObservationName (extensible)
.... coding S1..*
..... system S1..1
..... code S1..1
..... display S0..1
.... text S0..1Display text
... valueQuantity S0..1Quantitative test result
.... value S1..1Actual numeric result
.... comparator S0..1
.... units S0..1
.... system S1..1uriUCUM Code System
Fixed Value: http://unitsofmeasure.org
.... code S1..1UCUM code
Binding: USLabUCUM (required)
... dataAbsentReason S0..1
... interpretation S0..1Binding: USLabObsInterpretation (required)
.... coding S1..*
..... system S1..1
..... code S1..1
... applies[x] S I0..1For lab tests this is the specimen collection date. For Ask at Order Entry Questions (AOE)'s this is the date the question was asked.
inv-1: Datetime must be at least to day.
... issued S I0..1inv-3: Datetime must be at least to day.
... status S1..1
... bodySite[x] 0..0
... identifier S1..*
.... use S1..1
.... system S1..1
.... value S1..1
... subject S1..1patient-uslab-uslabpatient, patient-uslab-uslabphpatient
... specimen S0..*spec-uslab-uslabspec
... performer Slice: Ordered, Open At End, by type@profile
... performer S1..1org-uslab-uslabperforminglab
... referenceRange S0..1
.... low S0..1
..... system S1..1uriFixed Value: http://unitsofmeasure.org
..... code S1..1Binding: USLabUCUM (required)
.... high S0..1
..... system S1..1uriFixed Value: http://unitsofmeasure.org
..... code S1..1Binding: USLabUCUM (required)
.... age S0..1
..... low S0..1
...... system S1..1uriFixed Value: http://unitsofmeasure.org
...... code S1..1
..... high S0..1
...... system S1..1uriFixed Value: http://unitsofmeasure.org
...... code S1..1
... related 0..0
... uslabspecimenrejectreason S0..1CodeableConceptSpecimen Rejection Reason
.... valueCodeableConcept S1..1
..... coding S0..1
...... system S1..1
...... code S1..1
...... display S0..1
..... text S0..1
... uslabobservationkind S0..1codeKind of observation
NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I1..1ObservationUS Realm laboratory result using Quantity Data Type for numeric results
obs-6: Shall only be present if Observation.value[x] is not present
... 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
... uslabspecimenrejectreason S0..1CodeableConceptSpecimen Rejection Reason
.... extension 0..*ExtensionAdditional Content defined by implementations
.... url 1..1uriidentifies the meaning of the extension
.... value[x] S1..1*Value of extension
... uslabobservationkind S0..1codeKind of observation
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... code S Σ1..1CodeableConceptUS Realm Laboratory Test Name
Binding: USLabObservationName (extensible)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... coding S1..*CodingCode defined by a terminology system
..... extension 0..*ExtensionAdditional Content defined by implementations
..... system S1..1uriIdentity of the terminology system
..... version 0..1stringVersion of the system - if relevant
..... code S1..1codeSymbol in syntax defined by the system
..... display S0..1stringRepresentation defined by the system
..... primary 0..1booleanIf this code was chosen directly by the user
.... text S0..1stringDisplay text
... value[x] S Σ0..1Quantity, CodeableConcept, string, Range, Ratio, SampledData, Attachment, time, dateTime, PeriodQuantitative test result
Binding: ObservationValue (example)
... dataAbsentReason S I0..1CodeableConceptWhy the result is missing
Binding: ObservationValueAbsentReason (extensible)
... interpretation S0..1CodeableConceptHigh, low, normal, etc.
Binding: USLabObsInterpretation (required)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... coding S1..*CodingCode defined by a terminology system
..... extension 0..*ExtensionAdditional Content defined by implementations
..... system S1..1uriIdentity of the terminology system
..... version 0..1stringVersion of the system - if relevant
..... code S1..1codeSymbol in syntax defined by the system
..... display 0..1stringRepresentation defined by the system
..... primary 0..1booleanIf this code was chosen directly by the user
.... text 0..1stringPlain text representation of the concept
... comments 0..1stringComments about result
... applies[x] S ΣI0..1dateTime, PeriodFor lab tests this is the specimen collection date. For Ask at Order Entry Questions (AOE)'s this is the date the question was asked.
inv-1: Datetime must be at least to day.
... issued S ΣI0..1instantDate/Time this was made available
inv-3: Datetime must be at least to day.
... status ?! SΣ1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required)
... reliability ?!0..1codeok | ongoing | early | questionable | calibrating | error +
Binding: ObservationReliability (required)
... method 0..1CodeableConceptHow it was done
Binding: ObservationMethod (example)
... identifier S1..*IdentifierUnique Id for this particular observation
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?! S1..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type 0..1CodeableConceptDescription of identifier
Binding: IdentifierType (extensible)
.... system S1..1uriThe namespace for the identifier
Example: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the id itself is a full uri
.... value S1..1stringThe value that is unique
Example: 123456
.... period 0..1PeriodTime period when id is/was valid for use
.... assigner 0..1OrganizationOrganization that issued id (may be just text)
... subject S Σ1..1patient-uslab-uslabpatient, patient-uslab-uslabphpatientWho and/or what this is about
... specimen S0..*spec-uslab-uslabspecSpecimen used for this observation
... performer ΣPractitioner, Organization, Patient, RelatedPersonWho did the observation
Slice: Ordered, Open At End, by type@profile
... performer S Σ1..1org-uslab-uslabperforminglabWho did the observation
... device 0..1Device, DeviceMetric(Measurement) Device
... encounter 0..1EncounterHealthcare event during which this observation is made
... referenceRange S I0..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
.... low S I0..1QuantityLow Range, if relevant
obs-4: Low range comparators can only be '>' or '>=' or empty
..... extension 0..*ExtensionAdditional Content defined by implementations
..... value 0..1decimalNumerical value (with implicit precision)
..... comparator ?!0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required)
..... units 0..1stringUnit representation
..... system S I1..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
..... code S1..1codeCoded form of the unit
Binding: USLabUCUM (required)
.... high S I0..1QuantityHigh Range, if relevant
obs-5: High range comparators can only be '<' or '<=' or empty
..... extension 0..*ExtensionAdditional Content defined by implementations
..... value 0..1decimalNumerical value (with implicit precision)
..... comparator ?!0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required)
..... units 0..1stringUnit representation
..... system S I1..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
..... code S1..1codeCoded form of the unit
Binding: USLabUCUM (required)
.... meaning 0..1CodeableConceptIndicates the meaning/use of this range of this range
Binding: ObservationRangeMeaning (example)
.... age S0..1RangeApplicable age range, if relevant
..... extension 0..*ExtensionAdditional Content defined by implementations
..... low S I0..1QuantityLow limit
...... extension 0..*ExtensionAdditional Content defined by implementations
...... value 0..1decimalNumerical value (with implicit precision)
...... comparator ?!0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required)
...... units 0..1stringUnit representation
...... system S I1..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
...... code S1..1codeCoded form of the unit
..... high S I0..1QuantityHigh limit
...... extension 0..*ExtensionAdditional Content defined by implementations
...... value 0..1decimalNumerical value (with implicit precision)
...... comparator ?!0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required)
...... units 0..1stringUnit representation
...... system S I1..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
...... code S1..1codeCoded form of the unit
.... text 0..1stringText based reference range in an observation

todo

This structure is derived from Observation.

Summary

Mandatory: 28 elements, Must-Support: 49 elements, Fixed Value: 5 elements, Prohibited: 2 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Observation.performer is sliced based on the value of type@profile (ordered, Open At End)

Differential View

This structure is derived from Observation.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation 1..1ObservationUS Realm laboratory result using Quantity Data Type for numeric results
... code S1..1US Realm Laboratory Test Name
Binding: USLabObservationName (extensible)
.... coding S1..*
..... system S1..1
..... code S1..1
..... display S0..1
.... text S0..1Display text
... valueQuantity S0..1Quantitative test result
.... value S1..1Actual numeric result
.... comparator S0..1
.... units S0..1
.... system S1..1uriUCUM Code System
Fixed Value: http://unitsofmeasure.org
.... code S1..1UCUM code
Binding: USLabUCUM (required)
... dataAbsentReason S0..1
... interpretation S0..1Binding: USLabObsInterpretation (required)
.... coding S1..*
..... system S1..1
..... code S1..1
... applies[x] S I0..1For lab tests this is the specimen collection date. For Ask at Order Entry Questions (AOE)'s this is the date the question was asked.
inv-1: Datetime must be at least to day.
... issued S I0..1inv-3: Datetime must be at least to day.
... status S1..1
... bodySite[x] 0..0
... identifier S1..*
.... use S1..1
.... system S1..1
.... value S1..1
... subject S1..1patient-uslab-uslabpatient, patient-uslab-uslabphpatient
... specimen S0..*spec-uslab-uslabspec
... performer Slice: Ordered, Open At End, by type@profile
... performer S1..1org-uslab-uslabperforminglab
... referenceRange S0..1
.... low S0..1
..... system S1..1uriFixed Value: http://unitsofmeasure.org
..... code S1..1Binding: USLabUCUM (required)
.... high S0..1
..... system S1..1uriFixed Value: http://unitsofmeasure.org
..... code S1..1Binding: USLabUCUM (required)
.... age S0..1
..... low S0..1
...... system S1..1uriFixed Value: http://unitsofmeasure.org
...... code S1..1
..... high S0..1
...... system S1..1uriFixed Value: http://unitsofmeasure.org
...... code S1..1
... related 0..0
... uslabspecimenrejectreason S0..1CodeableConceptSpecimen Rejection Reason
.... valueCodeableConcept S1..1
..... coding S0..1
...... system S1..1
...... code S1..1
...... display S0..1
..... text S0..1
... uslabobservationkind S0..1codeKind of observation

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Observation I1..1ObservationUS Realm laboratory result using Quantity Data Type for numeric results
obs-6: Shall only be present if Observation.value[x] is not present
... 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
... uslabspecimenrejectreason S0..1CodeableConceptSpecimen Rejection Reason
.... extension 0..*ExtensionAdditional Content defined by implementations
.... url 1..1uriidentifies the meaning of the extension
.... value[x] S1..1*Value of extension
... uslabobservationkind S0..1codeKind of observation
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... code S Σ1..1CodeableConceptUS Realm Laboratory Test Name
Binding: USLabObservationName (extensible)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... coding S1..*CodingCode defined by a terminology system
..... extension 0..*ExtensionAdditional Content defined by implementations
..... system S1..1uriIdentity of the terminology system
..... version 0..1stringVersion of the system - if relevant
..... code S1..1codeSymbol in syntax defined by the system
..... display S0..1stringRepresentation defined by the system
..... primary 0..1booleanIf this code was chosen directly by the user
.... text S0..1stringDisplay text
... value[x] S Σ0..1Quantity, CodeableConcept, string, Range, Ratio, SampledData, Attachment, time, dateTime, PeriodQuantitative test result
Binding: ObservationValue (example)
... dataAbsentReason S I0..1CodeableConceptWhy the result is missing
Binding: ObservationValueAbsentReason (extensible)
... interpretation S0..1CodeableConceptHigh, low, normal, etc.
Binding: USLabObsInterpretation (required)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... coding S1..*CodingCode defined by a terminology system
..... extension 0..*ExtensionAdditional Content defined by implementations
..... system S1..1uriIdentity of the terminology system
..... version 0..1stringVersion of the system - if relevant
..... code S1..1codeSymbol in syntax defined by the system
..... display 0..1stringRepresentation defined by the system
..... primary 0..1booleanIf this code was chosen directly by the user
.... text 0..1stringPlain text representation of the concept
... comments 0..1stringComments about result
... applies[x] S ΣI0..1dateTime, PeriodFor lab tests this is the specimen collection date. For Ask at Order Entry Questions (AOE)'s this is the date the question was asked.
inv-1: Datetime must be at least to day.
... issued S ΣI0..1instantDate/Time this was made available
inv-3: Datetime must be at least to day.
... status ?! SΣ1..1coderegistered | preliminary | final | amended +
Binding: ObservationStatus (required)
... reliability ?!0..1codeok | ongoing | early | questionable | calibrating | error +
Binding: ObservationReliability (required)
... method 0..1CodeableConceptHow it was done
Binding: ObservationMethod (example)
... identifier S1..*IdentifierUnique Id for this particular observation
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?! S1..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type 0..1CodeableConceptDescription of identifier
Binding: IdentifierType (extensible)
.... system S1..1uriThe namespace for the identifier
Example: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the id itself is a full uri
.... value S1..1stringThe value that is unique
Example: 123456
.... period 0..1PeriodTime period when id is/was valid for use
.... assigner 0..1OrganizationOrganization that issued id (may be just text)
... subject S Σ1..1patient-uslab-uslabpatient, patient-uslab-uslabphpatientWho and/or what this is about
... specimen S0..*spec-uslab-uslabspecSpecimen used for this observation
... performer ΣPractitioner, Organization, Patient, RelatedPersonWho did the observation
Slice: Ordered, Open At End, by type@profile
... performer S Σ1..1org-uslab-uslabperforminglabWho did the observation
... device 0..1Device, DeviceMetric(Measurement) Device
... encounter 0..1EncounterHealthcare event during which this observation is made
... referenceRange S I0..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
.... low S I0..1QuantityLow Range, if relevant
obs-4: Low range comparators can only be '>' or '>=' or empty
..... extension 0..*ExtensionAdditional Content defined by implementations
..... value 0..1decimalNumerical value (with implicit precision)
..... comparator ?!0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required)
..... units 0..1stringUnit representation
..... system S I1..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
..... code S1..1codeCoded form of the unit
Binding: USLabUCUM (required)
.... high S I0..1QuantityHigh Range, if relevant
obs-5: High range comparators can only be '<' or '<=' or empty
..... extension 0..*ExtensionAdditional Content defined by implementations
..... value 0..1decimalNumerical value (with implicit precision)
..... comparator ?!0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required)
..... units 0..1stringUnit representation
..... system S I1..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
..... code S1..1codeCoded form of the unit
Binding: USLabUCUM (required)
.... meaning 0..1CodeableConceptIndicates the meaning/use of this range of this range
Binding: ObservationRangeMeaning (example)
.... age S0..1RangeApplicable age range, if relevant
..... extension 0..*ExtensionAdditional Content defined by implementations
..... low S I0..1QuantityLow limit
...... extension 0..*ExtensionAdditional Content defined by implementations
...... value 0..1decimalNumerical value (with implicit precision)
...... comparator ?!0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required)
...... units 0..1stringUnit representation
...... system S I1..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
...... code S1..1codeCoded form of the unit
..... high S I0..1QuantityHigh limit
...... extension 0..*ExtensionAdditional Content defined by implementations
...... value 0..1decimalNumerical value (with implicit precision)
...... comparator ?!0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required)
...... units 0..1stringUnit representation
...... system S I1..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
...... code S1..1codeCoded form of the unit
.... text 0..1stringText based reference range in an observation

XML Template

JSON Template

todo

 

Other representations of profile: (todo)

4.20.16.3.2 Terminology Bindings

PathNameConformanceValueSet
Observation.languageLanguagerequiredhttp://tools.ietf.org/html/bcp47
Observation.codeUSLabObservationNameextensibleUS Laboratory Observation Profile Observation Name Codes
Observation.value[x]ObservationValueexampleSNOMED CT Codes
Observation.dataAbsentReasonObservationValueAbsentReasonextensibleObservation Value Absent Reason
Observation.interpretationUSLabObsInterpretationrequiredUS Laboratory Observation Profile Interpretation Codes
Observation.statusObservationStatusrequiredObservationStatus
Observation.reliabilityObservationReliabilityrequiredObservationReliability
Observation.methodObservationMethodexampleObservation Methods
Observation.identifier.useIdentifierUserequiredIdentifierUse
Observation.identifier.typeIdentifierTypeextensibleIdentifier Type Codes
Observation.referenceRange.low.comparatorQuantityComparatorrequiredQuantityComparator
Observation.referenceRange.low.codeUSLabUCUMrequiredUCUM Codes
Observation.referenceRange.high.comparatorQuantityComparatorrequiredQuantityComparator
Observation.referenceRange.high.codeUSLabUCUMrequiredUCUM Codes
Observation.referenceRange.meaningObservationRangeMeaningexampleObservation Reference Range Meaning Codes
Observation.referenceRange.age.low.comparatorQuantityComparatorrequiredQuantityComparator
Observation.referenceRange.age.high.comparatorQuantityComparatorrequiredQuantityComparator
Observation.related.typeObservationRelationshipTyperequiredObservationRelationshipType

4.20.16.3.3 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-1Observation.applies[x]datetime to DayDatetime must be at least to day.
XPath: f:matches(./\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d([+-][0-2]\d:[0-5]\d|Z)/)
inv-3Observation.issueddatetime to DayDatetime must be at least to day.
XPath: f:matches(./\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d([+-][0-2]\d:[0-5]\d|Z)/)
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 = '>=')
.