This page is part of the FHIR Specification (v1.2.0: STU 3 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
The official URL for this profile is:
http://hl7.org/fhir/StructureDefinition/hspc-stdreal
StandardLabObsReal is the model for laboratory tests that have integer, decimal, or other numeric values that are not typically reported with a unit of measure.
This profile was published on Tue, Apr 14, 2015 00:00+1000 as a draft by HSPC.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from HSPC Standard Lab Observation.
This structure is derived from HSPC Standard Lab Observation.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | I | 0..* | Observation | inv-1: Must have either a value or a dataAbsentReason but not both |
DeltaFlag | Binding: Abnormal Interpretation Numeric Nom (preferred) | |||
code | 1..1 | CodeableConcept | Binding: HSPC Real Labs (preferred) | |
valueQuantity | I | 0..1 | Quantity, CodeableConcept, string, Range, Ratio, SampledData, Attachment, time, dateTime, Period | |
dataAbsentReason | I | 0..1 | CodeableConcept | Binding: LabNullFlavor (preferred) |
interpretation | 0..1 | CodeableConcept | Binding: Abnormal Interpretation Numeric Nom (preferred) | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | I | 0..* | Observation | Measurements and simple assertions obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: Component code SHALL not be same as observation code inv-1: Must have either a value or a dataAbsentReason but not both |
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: IETF BCP-47 (required) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
hspc-reporting-priority | 0..1 | code | Extension URL: http://hl7.org/fhir/StructureDefinition/hspc-reporting-priority | |
hspc-delta-flag | 0..1 | code | Extension URL: http://hl7.org/fhir/StructureDefinition/hspc-delta-flag | |
hspc-verified | 0..1 | boolean | Extension URL: http://hl7.org/fhir/StructureDefinition/hspc-verified | |
hspc-updated | 0..1 | dateTime | Extension URL: http://hl7.org/fhir/StructureDefinition/hspc-updated | |
observation-focal-subject | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/StructureDefinition/observation-focal-subject | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
status | ?! ∑ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required) |
category | 0..1 | CodeableConcept | Classification of type of observation Binding: Observation Category Codes (example) | |
code | ∑ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: HSPC Real Labs (preferred) |
subject | ∑ | 1..1 | Reference(Patient | Group | Device | Location) | Who and/or what this is about |
encounter | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made | |
effective[x] | ∑ | 0..1 | dateTime, Period | Clinically relevant time/time-period for observation |
issued | ∑ | 0..1 | instant | Date/Time this was made available |
performer | ∑ | Reference(Practitioner | Organization | Patient | RelatedPerson) | Who is responsible for the observation Slice: Ordered, Closed, by performer.type | |
performer | ∑ | 0..* | Reference(hspc-responsibleobserver) | the individual with the primary responsibility for the procedure or action being taken |
performer | ∑ | 0..1 | Reference(hspc-performinglaboratory) | name and address of the laboratory that performs the test |
value[x] | ∑ | 0..1 | Quantity, CodeableConcept, string, Range, Ratio, SampledData, Attachment, time, dateTime, Period | Actual result |
dataAbsentReason | I | 0..1 | CodeableConcept | Why the result is missing Binding: LabNullFlavor (preferred) |
interpretation | 0..1 | CodeableConcept | High, low, normal, etc. Binding: Abnormal Interpretation Numeric Nom (preferred) | |
comments | 0..1 | string | Comments about result | |
specimen | 0..1 | Reference(hspc-specimen) | Specimen used for this observation | |
device | 0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | |
referenceRange | I | 0..* | BackboneElement | Provides guide for interpretation obs-3: Must have at least a low or a high or text |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
low | I | 0..1 | SimpleQuantity | Low Range, if relevant |
high | I | 0..1 | SimpleQuantity | High Range, if relevant |
meaning | 0..1 | CodeableConcept | Indicates the meaning/use of this range of this range Binding: Observation Reference Range Meaning Codes (example) | |
age | 0..1 | Range | Applicable age range, if relevant | |
text | 0..1 | string | Text based reference range in an observation | |
component | ∑ | 0..* | BackboneElement | Component results |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
code | ∑ I | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINC Codes (example) |
value[x] | ∑ | 0..1 | Quantity, CodeableConcept, string, Range, Ratio, SampledData, Attachment, time, dateTime, Period | Actual component result |
dataAbsentReason | I | 0..1 | CodeableConcept | Why the component result is missing Binding: Observation Value Absent Reason (extensible) |
referenceRange | 0..* | See Observation.referenceRange | Provides guide for interpretation of component result | |
Documentation for this format |
todo
This structure is derived from HSPC Standard Lab Observation.
Differential View
This structure is derived from HSPC Standard Lab Observation.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | I | 0..* | Observation | inv-1: Must have either a value or a dataAbsentReason but not both |
DeltaFlag | Binding: Abnormal Interpretation Numeric Nom (preferred) | |||
code | 1..1 | CodeableConcept | Binding: HSPC Real Labs (preferred) | |
valueQuantity | I | 0..1 | Quantity, CodeableConcept, string, Range, Ratio, SampledData, Attachment, time, dateTime, Period | |
dataAbsentReason | I | 0..1 | CodeableConcept | Binding: LabNullFlavor (preferred) |
interpretation | 0..1 | CodeableConcept | Binding: Abnormal Interpretation Numeric Nom (preferred) | |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Observation | I | 0..* | Observation | Measurements and simple assertions obs-6: dataAbsentReason SHALL only be present if Observation.value[x] is not present obs-7: Component code SHALL not be same as observation code inv-1: Must have either a value or a dataAbsentReason but not both |
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: IETF BCP-47 (required) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
hspc-reporting-priority | 0..1 | code | Extension URL: http://hl7.org/fhir/StructureDefinition/hspc-reporting-priority | |
hspc-delta-flag | 0..1 | code | Extension URL: http://hl7.org/fhir/StructureDefinition/hspc-delta-flag | |
hspc-verified | 0..1 | boolean | Extension URL: http://hl7.org/fhir/StructureDefinition/hspc-verified | |
hspc-updated | 0..1 | dateTime | Extension URL: http://hl7.org/fhir/StructureDefinition/hspc-updated | |
observation-focal-subject | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/StructureDefinition/observation-focal-subject | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
status | ?! ∑ | 1..1 | code | registered | preliminary | final | amended + Binding: ObservationStatus (required) |
category | 0..1 | CodeableConcept | Classification of type of observation Binding: Observation Category Codes (example) | |
code | ∑ | 1..1 | CodeableConcept | Type of observation (code / type) Binding: HSPC Real Labs (preferred) |
subject | ∑ | 1..1 | Reference(Patient | Group | Device | Location) | Who and/or what this is about |
encounter | 0..1 | Reference(Encounter) | Healthcare event during which this observation is made | |
effective[x] | ∑ | 0..1 | dateTime, Period | Clinically relevant time/time-period for observation |
issued | ∑ | 0..1 | instant | Date/Time this was made available |
performer | ∑ | Reference(Practitioner | Organization | Patient | RelatedPerson) | Who is responsible for the observation Slice: Ordered, Closed, by performer.type | |
performer | ∑ | 0..* | Reference(hspc-responsibleobserver) | the individual with the primary responsibility for the procedure or action being taken |
performer | ∑ | 0..1 | Reference(hspc-performinglaboratory) | name and address of the laboratory that performs the test |
value[x] | ∑ | 0..1 | Quantity, CodeableConcept, string, Range, Ratio, SampledData, Attachment, time, dateTime, Period | Actual result |
dataAbsentReason | I | 0..1 | CodeableConcept | Why the result is missing Binding: LabNullFlavor (preferred) |
interpretation | 0..1 | CodeableConcept | High, low, normal, etc. Binding: Abnormal Interpretation Numeric Nom (preferred) | |
comments | 0..1 | string | Comments about result | |
specimen | 0..1 | Reference(hspc-specimen) | Specimen used for this observation | |
device | 0..1 | Reference(Device | DeviceMetric) | (Measurement) Device | |
referenceRange | I | 0..* | BackboneElement | Provides guide for interpretation obs-3: Must have at least a low or a high or text |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
low | I | 0..1 | SimpleQuantity | Low Range, if relevant |
high | I | 0..1 | SimpleQuantity | High Range, if relevant |
meaning | 0..1 | CodeableConcept | Indicates the meaning/use of this range of this range Binding: Observation Reference Range Meaning Codes (example) | |
age | 0..1 | Range | Applicable age range, if relevant | |
text | 0..1 | string | Text based reference range in an observation | |
component | ∑ | 0..* | BackboneElement | Component results |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
code | ∑ I | 1..1 | CodeableConcept | Type of component observation (code / type) Binding: LOINC Codes (example) |
value[x] | ∑ | 0..1 | Quantity, CodeableConcept, string, Range, Ratio, SampledData, Attachment, time, dateTime, Period | Actual component result |
dataAbsentReason | I | 0..1 | CodeableConcept | Why the component result is missing Binding: Observation Value Absent Reason (extensible) |
referenceRange | 0..* | See Observation.referenceRange | Provides guide for interpretation of component result | |
Documentation for this format |
XML Template
JSON Template
todo
Other representations of profile: Schematron
Path | Name | Conformance | ValueSet |
Observation.language | ?ext | required | http://tools.ietf.org/html/bcp47 |
Observation.status | ObservationStatus | required | ObservationStatus |
Observation.category | Observation Category Codes | example | Observation Category Codes |
Observation.code | HSPC Real Labs | preferred | HSPC Real Labs |
Observation.dataAbsentReason | LabNullFlavor | preferred | LabNullFlavor |
Observation.interpretation | Abnormal Interpretation Numeric Nom | preferred | Abnormal Interpretation Numeric Nom |
Observation.referenceRange.meaning | Observation Reference Range Meaning Codes | example | Observation Reference Range Meaning Codes |
Observation.related.type | ObservationRelationshipType | required | ObservationRelationshipType |
Observation.component.code | LOINC Codes | example | LOINC Codes |
Observation.component.dataAbsentReason | Observation Value Absent Reason | extensible | Observation Value Absent Reason |
Id | Path | Details | Requirements |
obs-6 | Observation | dataAbsentReason SHALL only be present if Observation.value[x] is not present XPath: not(exists(f:dataAbsentReason)) or (not(exists(*[starts-with(local-name(.), 'value')]))) | |
obs-7 | Observation | Component code SHALL not be same as observation code XPath: not(exists(f:component/f:code)) or count(for $coding in f:code/f:coding return parent::*/f:component/f:code/f:coding[f:code/@value=$coding/f:code/@value and f:system/@value=$coding/f:system/@value])=0 | |
inv-1 | Observation | Must have either a value or a dataAbsentReason but not both XPath: (f:value or f:dataAbsentReason) and (not(f:value and f:dataAbsentReason)) | |
obs-3 | Observation.referenceRange | Must have at least a low or a high or text XPath: (exists(f:low) or exists(f:high)or exists(f:text)) |